From: Phillip Susi <psusi@ubuntu.com>
To: util-linux@vger.kernel.org
Subject: mount man page cleanups
Date: Mon, 25 Nov 2013 10:35:40 -0500 [thread overview]
Message-ID: <52936E4C.7020605@ubuntu.com> (raw)
[-- Attachment #1.1: Type: text/plain, Size: 100 bytes --]
Fowarding this patch submitted by Bjarni Ingi Gislason
<bjarniig@rhi.hi.is> to deb bug #674595.
[-- Attachment #1.2: mount.8.diff --]
[-- Type: text/plain, Size: 9209 bytes --]
--- mount.8 2012-05-24 22:28:03.000000000 +0000
+++ mount.8.new 2012-05-25 01:19:35.000000000 +0000
@@ -1,3 +1,4 @@
+'\" t
.\" Copyright (c) 1996-2004 Andries Brouwer
.\"
.\" This page is somewhat derived from a page that was
@@ -323,7 +324,7 @@
.br
.I /olddir
.I /newdir
-.B none bind
+.B none bind
.RE
After this call the same contents is accessible in two places.
@@ -499,7 +500,7 @@
.BR "\-o ro" .
Note that, depending on the filesystem type, state and kernel behavior, the
-system may still write to the device. For example, Ext3 or ext4 will replay its
+system may still write to the device. For example, ext3 or ext4 will replay its
journal if the filesystem is dirty. To prevent this kind of write access, you
may want to mount ext3 or ext4 filesystem with "ro,noload" mount options or
set the block device to read-only mode, see command
@@ -854,7 +855,7 @@
.TP
.B keybits
Specifies the key size to use for an encryption algorithm. Used in conjunction
-with the
+with the
.BR loop " and " encryption " options."
.B nofail
Do not report errors for this device if it does not exist.
@@ -1173,16 +1174,25 @@
.B bsddf
behaviour (which is the default) is to subtract the overhead blocks
used by the ext2 filesystem and not available for file storage. Thus
-.nf
-
+.sp 1
% mount /k -o minixdf; df /k; umount /k
-Filesystem 1024-blocks Used Available Capacity Mounted on
-/dev/sda6 2630655 86954 2412169 3% /k
+.TS
+tab(#);
+l2 l2 r2 l2 l2 l
+l c r c c l.
+Filesystem#1024-blocks#Used#Available#Capacity#Mounted on
+/dev/sda6#2630655#86954#2412169#3%#/k
+.TE
+.sp 1
% mount /k -o bsddf; df /k; umount /k
-Filesystem 1024-blocks Used Available Capacity Mounted on
-/dev/sda6 2543714 13 2412169 0% /k
-
-.fi
+.TS
+tab(#);
+l2 l2 r2 l2 l2 l
+l c r c c l.
+Filesystem#1024-blocks#Used#Available#Capacity#Mounted on
+/dev/sda6#2543714#13#2412169#0%#/k
+.TE
+.sp 1
(Note that this example shows that one can add command line options
to the options given in
.IR /etc/fstab .)
@@ -1250,8 +1260,8 @@
that this may mean that ext2 filesystems created by a recent
.B mke2fs
cannot be mounted r/w under Linux 2.0.*.)
-The block number here uses 1k units. Thus, if you want to use logical
-block 32768 on a filesystem with 4k blocks, use "sb=131072".
+The block number here uses 1\ k units. Thus, if you want to use logical
+block 32768 on a filesystem with 4\ k blocks, use "sb=131072".
.TP
.BR user_xattr | nouser_xattr
Support "user." extended attributes (or not).
@@ -1272,7 +1282,7 @@
.BR journal=inum
When a journal already exists, this option is ignored. Otherwise, it
specifies the number of the inode which will represent the ext3 filesystem's
-journal file; ext3 will create a new journal, overwriting the old contents
+journal file; ext3 will create a new journal, overwriting the old contents
of the file whose inode number is
.IR inum .
.TP
@@ -1283,7 +1293,7 @@
Specifies the journalling mode for file data. Metadata is always journaled.
To use modes other than
.B ordered
-on the root filesystem, pass the mode to the kernel as boot parameter, e.g.
+on the root filesystem, pass the mode to the kernel as boot parameter, e.g.\&
.IR rootflags=data=journal .
.RS
.TP
@@ -1303,7 +1313,7 @@
in files after a crash and journal recovery.
.RE
.TP
-.BR barrier=0 " / " barrier=1 "
+.BR barrier=0 " / " barrier=1 "
This enables/disables barriers. barrier=0 disables it, barrier=1 enables it.
Write barriers enforce proper on-disk ordering of journal commits, making
volatile disk write caches safe to use, at some performance penalty. The ext3
@@ -1352,7 +1362,7 @@
.BR journal=update
Update the ext4 filesystem's journal to the current format.
.TP
-.BR barrier=0 " / " barrier=1 " / " barrier " / " nobarrier
+.BR barrier=0 " / " barrier=1 " / " barrier " / " nobarrier
This enables/disables the use of write barriers in the jbd code. barrier=0
disables, barrier=1 enables. This also requires an IO stack which can support
barriers, and if jbd gets an error on a barrier write, it will disable again
@@ -1394,7 +1404,7 @@
If the time that the transactoin has been running is less than the commit time,
ext4 will try sleeping for the commit time to see if other operations will join
the transaction. The commit time is capped by the max_batch_time, which
-defaults to 15000us (15ms). This optimization can be turned off entirely by
+defaults to 15000\ \[mc]s (15\ ms). This optimization can be turned off entirely by
setting max_batch_time to 0.
.TP
.BI min_batch_time= usec
@@ -1489,7 +1499,7 @@
.TP
.BR r [ elaxed ]
Upper and lower case are accepted and equivalent, long name parts are
-truncated (e.g.
+truncated (e.g.\&
.I verylongname.foobar
becomes
.IR verylong.foo ),
@@ -1747,7 +1757,7 @@
.B cruft
If the high byte of the file length contains other garbage,
set this mount option to ignore the high order bits of the file length.
-This implies that a file cannot be larger than 16MB.
+This implies that a file cannot be larger than 16\ MB.
.TP
.BI session= x
Select number of session on multisession CD. (Since 2.3.4.)
@@ -1916,7 +1926,7 @@
Instructs
.IR mount
to detect which hash function is in use by examining
-the filesystem being mounted, and to write this information into
+the filesystem being mounted, and to write this information into
the reiserfs superblock. This is only useful on the first mount of
an old format filesystem.
.RE
@@ -1975,7 +1985,7 @@
.BR acl (5)
manual page.
.TP
-.BR barrier=none " / " barrier=flush "
+.BR barrier=none " / " barrier=flush "
This enables/disables the use of write barriers in the journaling code.
barrier=none disables it, barrier=flush enables it. Write barriers enforce
proper on-disk ordering of journal commits, making volatile disk write caches
@@ -2077,8 +2087,6 @@
online, then it is advisable to omit the mpol option from automatic
mount options. It can be added later, when the tmpfs is already mounted
on MountPoint, by 'mount -o remount,mpol=Policy:NodeList MountPoint'.
-.PE
-
.SH "Mount options for ubifs"
UBIFS is a flash file system which works on top of UBI volumes. Note that
.B
@@ -2340,9 +2348,9 @@
.TP
.BI allocsize= size
Sets the buffered I/O end-of-file preallocation size when
-doing delayed allocation writeout (default size is 64KiB).
-Valid values for this option are page size (typically 4KiB)
-through to 1GiB, inclusive, in power-of-2 increments.
+doing delayed allocation writeout (default size is 64\ KiB).
+Valid values for this option are page size (typically 4\ KiB)
+through to 1\ GiB, inclusive, in power-of-2 increments.
.TP
.BR attr2 | noattr2
The options enable/disable (default is enabled) an "opportunistic"
@@ -2426,8 +2434,8 @@
Set the number of in-memory log buffers. Valid numbers range
from 2-8 inclusive.
The default value is 8 buffers for filesystems with a
-blocksize of 64KiB, 4 buffers for filesystems with a blocksize
-of 32KiB, 3 buffers for filesystems with a blocksize of 16KiB
+blocksize of 64\ KiB, 4 buffers for filesystems with a blocksize
+of 32\ KiB, 3 buffers for filesystems with a blocksize of 16\ KiB
and 2 buffers for all other configurations. Increasing the
number of buffers may increase performance on some workloads
at the cost of the memory used for the additional log buffers
@@ -2436,10 +2444,10 @@
.BI logbsize= value
Set the size of each in-memory log buffer.
Size may be specified in bytes, or in kilobytes with a "k" suffix.
-Valid sizes for version 1 and version 2 logs are 16384 (16k) and
-32768 (32k). Valid sizes for version 2 logs also include
-65536 (64k), 131072 (128k) and 262144 (256k).
-The default value for machines with more than 32MiB of memory
+Valid sizes for version 1 and version 2 logs are 16384 (16\ k) and
+32768 (32\ k). Valid sizes for version 2 logs also include
+65536 (64\ k), 131072 (128\ k) and 262144 (256\ k).
+The default value for machines with more than 32\ MiB of memory
is 32768, machines with less memory use 16384 by default.
.TP
\fBlogdev=\fP\fIdevice\fP and \fBrtdev=\fP\fIdevice\fP
@@ -2451,7 +2459,7 @@
Refer to
.BR xfs (5).
.TP
-.BI mtpt= mountpoint
+.BI mtpt= mountpoint
Use with the
.B dmapi
option. The value specified here will be
@@ -2676,7 +2684,7 @@
may not be able to change mount parameters (all
.IR ext2fs -specific
parameters, except
-.BR sb ,
+.BR sb ,
are changeable with a remount, for example, but you can't change
.B gid
or
@@ -2694,7 +2702,7 @@
and
.IR /proc/mounts
don't match. The first file is based only on the mount command options, but the
-content of the second file also depends on the kernel and others settings (e.g.
+content of the second file also depends on the kernel and others settings (e.g.\&
remote NFS server. In particular case the mount command may reports unreliable
information about a NFS mount point and the /proc/mounts file usually contains
more reliable information.)
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 553 bytes --]
next reply other threads:[~2013-11-25 15:37 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-11-25 15:35 Phillip Susi [this message]
2013-12-02 10:17 ` mount man page cleanups Karel Zak
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=52936E4C.7020605@ubuntu.com \
--to=psusi@ubuntu.com \
--cc=util-linux@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox