util-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 1/4] docs: fix some things that were overlooked during the first pass
@ 2014-07-25 12:55 Benno Schulenberg
  2014-07-25 12:55 ` [PATCH 2/4] docs: improve some wordings in the man page of mount Benno Schulenberg
                   ` (3 more replies)
  0 siblings, 4 replies; 6+ messages in thread
From: Benno Schulenberg @ 2014-07-25 12:55 UTC (permalink / raw)
  To: util-linux

Mainly more option sorting, some formatting adjustments, and the adding
of a missing --version here and there.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 sys-utils/dmesg.1     |   29 ++++++++------
 sys-utils/eject.1     |   94 +++++++++++++++++++++++++++-----------------
 sys-utils/fallocate.1 |  104 ++++++++++++++++++++++++++----------------------
 sys-utils/flock.1     |   61 ++++++++++++++--------------
 sys-utils/ipcmk.1     |   10 ++--
 sys-utils/ipcrm.1     |   48 +++++++++++++----------
 sys-utils/renice.1    |    6 +-
 sys-utils/setpriv.1   |  102 ++++++++++++++++++++++++------------------------
 sys-utils/setsid.1    |    9 ++++-
 sys-utils/unshare.1   |    9 +++-
 10 files changed, 260 insertions(+), 212 deletions(-)

diff --git a/sys-utils/dmesg.1 b/sys-utils/dmesg.1
index 86d35df..8a267f8 100644
--- a/sys-utils/dmesg.1
+++ b/sys-utils/dmesg.1
@@ -20,7 +20,7 @@ dmesg \- print or control the kernel ring buffer
 .B dmesg
 is used to examine or control the kernel ring buffer.
 .PP
-The default action is to read all messages from the kernel ring buffer.
+The default action is to display all messages from the kernel ring buffer.
 .SH OPTIONS
 The
 .BR \-\-clear ,
@@ -65,8 +65,6 @@ output.
 .IP "\fB\-H\fR, \fB\-\-human\fR"
 Enable human-readable output.  See also \fB\-\-color\fR, \fB\-\-reltime\fR
 and \fB\-\-nopager\fR.
-.IP "\fB\-h\fR, \fB\-\-help\fR"
-Display help text and exit.
 .IP "\fB\-k\fR, \fB\-\-kernel\fR"
 Print kernel messages.
 .IP "\fB\-L\fR, \fB\-\-color\fR[=\fIwhen\fR]"
@@ -152,15 +150,6 @@ system
 .BR SUSPEND / RESUME .
 .IP "\fB\-t\fR, \fB\-\-notime\fR"
 Do not print kernel's timestamps.
-.IP "\fB\-u\fR, \fB\-\-userspace\fR"
-Print userspace messages.
-.IP "\fB\-V\fR, \fB\-\-version\fR"
-Display version information and exit.
-.IP "\fB\-w\fR, \fB\-\-follow\fR"
-Wait for new messages.  This feature is supported only on systems with
-a readable /dev/kmsg (since kernel 3.5.0).
-.IP "\fB\-x\fR, \fB\-\-decode\fR"
-Decode facility and level (priority) numbers to human-readable prefixes.
 .IP "\fB\-\-time\-format\fR \fIformat\fR"
 Print timestamps using the given \fIformat\fR, which can be
 .BR ctime ,
@@ -183,6 +172,22 @@ The
 format has the same issue as
 .BR ctime :
 the time may be inaccurate when a system is suspended and resumed.
+.TP
+.BR \-u , " \-\-userspace"
+Print userspace messages.
+.TP
+.BR \-w , " \-\-follow"
+Wait for new messages.  This feature is supported only on systems with
+a readable /dev/kmsg (since kernel 3.5.0).
+.TP
+.BR \-x , " \-\-decode"
+Decode facility and level (priority) numbers to human-readable prefixes.
+.TP
+.BR \-V , " \-\-version"
+Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
 .SH COLORS
 Implicit coloring can be disabled by an empty file \fI/etc/terminal-colors.d/dmesg.disable\fR.
 See
diff --git a/sys-utils/eject.1 b/sys-utils/eject.1
index c307c25..8e0d92c 100644
--- a/sys-utils/eject.1
+++ b/sys-utils/eject.1
@@ -30,61 +30,87 @@ all four methods in order until it succeeds.
 If a device partition is specified, the whole-disk device is used.  If the device
 or a device partition is currently mounted, it is unmounted before ejecting.
 .SH OPTIONS
-.IP "\fB\-a\fR, \fB\-\-auto on\fR|\fBoff\fR"
+.TP
+.BR \-a , " \-\-auto on" | off
 This option controls the auto-eject mode, supported by some devices.  When
 enabled, the drive automatically ejects when the device is closed.
-.IP "\fB\-c, \-\-changerslot \fIslot\fP"
+.TP
+.BR \-c , " \-\-changerslot " \fIslot
 With this option a CD slot can be selected from an ATAPI/IDE CD-ROM changer.
 Linux 2.0 or higher is required to use this feature.  The CD-ROM drive cannot
 be in use (mounted data CD or playing a music CD) for a change request to work.
 Please also note that the first slot of the changer is referred to as 0, not 1.
-.IP "\fB\-d, \-\-default\fP"
+.TP
+.BR \-d , " \-\-default"
 List the default device name.
-.IP "\fB\-f, \-\-floppy\fP"
+.TP
+.BR \-F , " \-\-force"
+Force eject, don't check device type.
+.TP
+.BR \-f , " \-\-floppy"
 This option specifies that the drive should be ejected using a removable floppy
 disk eject command.
-.IP "\fB\-F, \-\-force\fP"
-Force eject, don't check device type.
-.IP "\fB\-h, \-\-help\fP"
+.TP
+.BR \-h , " \-\-help"
 Display help text and exit.
-.IP "\fB\-i\fR, \fB\-\-manualeject on\fR|\fBoff\fR"
+.TP
+.BR \-i , " \-\-manualeject on" | off
 This option controls locking of the hardware eject button.  When enabled, the
 drive will not be ejected when the button is pressed.  This is useful when you
 are carrying a laptop in a bag or case and don't want it to eject if the button
 is inadvertently pressed.
-.IP "\fB\-p, \-\-proc\fP"
-This option allows you to use /proc/mounts instead /etc/mtab.  It also passes the
-\fB\-n\fR option to \fBumount\fR(1).
-.IP "\fB\-q, \-\-tape\fP"
-This option specifies that the drive should be ejected using a tape drive
-offline command.
-.IP "\fB\-m, \-\-no-unmount\fP"
-The option tells eject to not try to unmount at all.
-.IP "\fB\-M, \-\-no-partitions-unmount\fP"
+.TP
+.BR \-M , " \-\-no-partitions-unmount"
 The option tells eject to not try to unmount other partitions on partitioned
 devices.  If another partition is still mounted, the program will not attempt
 to eject the media.  It will attempt to unmount only the device or mountpoint
 given on the command line.
-.IP "\fB\-n, \-\-noop\fP"
+.TP
+.BR \-m , " \-\-no-unmount"
+The option tells eject to not try to unmount at all.
+.TP
+.BR \-n , " \-\-noop"
 With this option the selected device is displayed but no action is performed.
-.IP "\fB\-t, \-\-trayclose\fP"
-With this option the drive is given a CD-ROM tray close command.  Not all
-devices support this command.
-.IP "\fB\-T, \-\-traytoggle\fP"
-With this option the drive is given a CD-ROM tray close command if it's opened,
-and a CD-ROM tray eject command if it's closed.  Not all devices support this
-command, because it uses the above CD-ROM tray close command.
-.IP "\fB\-r, \-\-cdrom\fP"
+.TP
+.BR \-p , " \-\-proc"
+This option allows you to use /proc/mounts instead /etc/mtab.  It also passes the
+\fB\-n\fR option to \fBumount\fR(8).
+.TP
+.BR \-q , " \-\-tape"
+This option specifies that the drive should be ejected using a tape drive
+offline command.
+.TP
+.BR \-r , " \-\-cdrom"
 This option specifies that the drive should be ejected using a CDROM eject
 command.
-.IP "\fB\-s, \-\-scsi\fP"
+.TP
+.BR \-s , " \-\-scsi"
 This option specifies that the drive should be ejected using SCSI commands.
-.IP "\fB\-v, \-\-verbose\fP"
+.TP
+.BR \-T , " \-\-traytoggle"
+With this option the drive is given a CD-ROM tray close command if it's opened,
+and a CD-ROM tray eject command if it's closed.  Not all devices support this
+command, because it uses the above CD-ROM tray close command.
+.TP
+.BR \-t , " \-\-trayclose"
+With this option the drive is given a CD-ROM tray close command.  Not all
+devices support this command.
+.TP
+.BR \-V , " \-\-version"
+Display version information and exit.
+.TP
+.BR \-v , " \-\-verbose"
 Run in verbose mode; more information is displayed about what the command is
 doing.
-.IP "\fB\-V, \-\-version\fP"
-Display version information and exit.
-.IP "\fB\-x, \-\-cdspeed \fIspeed\fP"
+.TP
+.BR \-X , " \-\-listspeed"
+With this option the CD-ROM drive will be probed to detect the available
+speeds.  The output is a list of speeds which can be used as an argument of the
+\fB\-x\fR option.  This only works with Linux 2.6.13 or higher, on previous versions
+solely the maximum speed will be reported.  Also note that some drives may not
+correctly report the speed and therefore this option does not work with them.
+.TP
+.BR \-x , " \-\-cdspeed " \fIspeed
 With this option the drive is given a CD-ROM select speed command.  The
 .I speed
 argument is a number indicating the desired speed (e.g. 8 for 8X speed), or 0
@@ -92,12 +118,6 @@ for maximum data rate.  Not all devices support this command and you can only
 specify speeds that the drive is capable of.  Every time the media is changed
 this option is cleared.  This option can be used alone, or with the
 \fB\-t\fR and \fB\-c\fR options.
-.IP "\fB\-X, \-\-listspeed\fP" 
-With this option the CD-ROM drive will be probed to detect the available
-speeds.  The output is a list of speeds which can be used as an argument of the
-\fB\-x\fR option.  This only works with Linux 2.6.13 or higher, on previous versions
-solely the maximum speed will be reported.  Also note that some drives may not
-correctly report the speed and therefore this option does not work with them.
 .SH EXIT STATUS
 Returns 0 if operation was successful, 1 if operation failed or command syntax
 was not valid.
diff --git a/sys-utils/fallocate.1 b/sys-utils/fallocate.1
index b03f19b..0762321 100644
--- a/sys-utils/fallocate.1
+++ b/sys-utils/fallocate.1
@@ -4,9 +4,9 @@
 fallocate \- preallocate or deallocate space to a file
 .SH SYNOPSIS
 .B fallocate
+.RB [ \-c ]
 .RB [ \-n ]
 .RB [ \-p ]
-.RB [ \-c ]
 .RB [ \-z ]
 .RB [ \-o
 .IR offset ]
@@ -14,8 +14,7 @@ fallocate \- preallocate or deallocate space to a file
 .IR length
 .I filename
 .PP
-.B fallocate
-.RB \-d
+.B fallocate \-d
 .RB [ \-o
 .IR offset ]
 .RB [ \-l
@@ -24,28 +23,57 @@ fallocate \- preallocate or deallocate space to a file
 .SH DESCRIPTION
 .B fallocate
 is used to manipulate the allocated disk space for a file, either to deallocate
-or preallocate it. For filesystems which support the fallocate system call,
+or preallocate it.  For filesystems which support the fallocate system call,
 preallocation is done quickly by allocating blocks and marking them as
-uninitialized, requiring no IO to the data blocks. This is much faster than
+uninitialized, requiring no IO to the data blocks.  This is much faster than
 creating a file by filling it with zeros.
 .PP
 The exit code returned by
 .B fallocate
 is 0 on success and 1 on failure.
-.PP
 .SH OPTIONS
-The \fIlength\fR and \fIoffset\fR arguments may be followed by the multiplicative
-suffixes KiB=1024, MiB=1024*1024, and so on for GiB, TiB, PiB, EiB, ZiB and YiB
-(the "iB" is optional, e.g. "K" has the same meaning as "KiB") or the suffixes
-KB=1000, MB=1000*1000, and so on for GB, TB, PB, EB, ZB and YB.
-
+The \fIlength\fR and \fIoffset\fR
+arguments may be followed by the multiplicative suffixes KiB (=1024),
+MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is
+optional, e.g., "K" has the same meaning as "KiB") or the suffixes
+KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB.
+.PP
 The options \fB\-\-collapse-range\fP, \fB\-\-dig-holes\fP, \fB\-\-punch-hole\fP and
 \fB\-\-zero-range\fP are mutually exclusive.
-
-.IP "\fB\-n, \-\-keep-size\fP"
+.TP
+.BR \-c , " \-\-collapse-range"
+Removes a byte range from a file, without leaving a hole.  The byte range
+to be collapsed starts at \fIoffset\fP and continues
+for \fIlength\fR bytes.  At the completion of the operation, the contents of
+the file starting at the location \fIoffset\fR+\fIlength\fR will be appended at the
+location \fIoffset\fR, and the file will be \fIlength\fR bytes smaller.  The option
+\fB\-\-keep\-size\fR may not be specified for colapse range operation.
+.sp
+Available since Linux 3.15 for ext4 (only for extent-based files) and XFS.
+.TP
+.BR \-d , " \-\-dig-holes"
+Detect and dig holes.  This makes the file sparse in-place, without using extra
+disk space.  The minimum size of the hole depends on filesystem I/O block size
+(usually 4096 bytes).  Also, when using this option, \fB\-\-keep-size\fP is
+implied.  If no range is specified by \fB\-\-offset\fP and \fB\-\-length\fP,
+then the entire file is analyzed for holes.
+.sp
+You can think of this option as doing a "\fBcp --sparse\fP" and then renaming
+the destination file to the original, without the need for extra disk space.
+.sp
+See \fB\-\-punch-hole\fP for a list of supported filesystems.
+.TP
+.BR \-l , " \-\-length " \fIlength
+Specifies the length of the range, in bytes.
+.TP
+.BR \-n , " \-\-keep-size"
 Do not modify the apparent length of the file.  This may effectively allocate
 blocks past EOF, which can be removed with a truncate.
-.IP "\fB\-p, \-\-punch-hole\fP"
+.TP
+.BR \-o , " \-\-offset " \fIoffset
+Specifies the beginning offset of the range, in bytes.
+.TP
+.BR \-p , " \-\-punch-hole"
 Deallocates space (i.e., creates a hole) in the byte range starting at
 \fIoffset\fP and continuing for \fIlength\fR bytes.  Within the
 specified range, partial filesystem blocks are zeroed, and whole
@@ -53,55 +81,35 @@ filesystem blocks are removed from the file.  After a successful
 call, subsequent reads from this range will return zeroes.  This option
 may not be specified at the same time as  the \fB\-\-zero-range\fP option.
 Also, when using this option, \fB\-\-keep-size\fP is implied.
-
+.sp
 Supported for XFS (since Linux 2.6.38), ext4 (since Linux 3.0),
 Btrfs (since Linux 3.7) and tmpfs (since Linux 3.5).
-.IP "\fB\-d, \-\-dig-holes\fP"
-Detect and dig holes. Makes the file sparse in-place, without using extra disk
-space. The minimal size of the hole depends on filesystem I/O block size
-(usually 4096 bytes). Also, when using this option, \fB\-\-keep-size\fP is
-implied. If no range is specified by \fB\-\-offset\fP and \fB\-\-length\fP,
-then all file is analyzed for holes.
-
-You can think of this as doing a "\fBcp --sparse\fP" and
-renaming the dest file as the original, without the need for extra disk space.
-
-See \fB\-\-punch-hole\fP for list of the supported filesystems.
-.IP "\fB\-c, \-\-collapse-range\fP"
-Removes a byte range from a file, without leaving a hole.  The byte range
-to be collapsed starts at \fIoffset\fP and continues
-for \fIlength\fR bytes.  At the completion of the operation, the contents of
-the file starting at the location offset+length will be appended at the
-location offset, and the file will be \fIlength\fR bytes smaller. The option
-\fB\-\-keep\-size\fR may not be specified for colapse range operation.
-
-Available since Linux 3.15 for ext4 (only for extent-based files) and XFS.
-.IP "\fB\-z, \-\-zero-range\fP"
+.TP
+.BR \-v , " \-\-verbose"
+Enable verbose mode.
+.TP
+.BR \-z , " \-\-zero-range"
 Zeroes space in the byte range starting at \fIoffset\fP and
 continuing for \fIlength\fR bytes.  Within the specified range, blocks are
 preallocated for the regions that span the holes in the file.  After
 a successful call, subsequent reads from this range will return zeroes.
-
+.sp
 Zeroing is done within the filesystem preferably by converting the
 range into unwritten extents.  This approach means that the specified
 range will not be physically zeroed out on the device (except for
 partial blocks at the either end of the range), and I/O is
 (otherwise) required only to update metadata.
-
+.sp
 Option \fB\-\-keep\-size\fP can be specified to prevent file length
 modification.
-
+.sp
 Available since Linux 3.14 for ext4 (only for extent-based files) and XFS.
-.IP "\fB\-o, \-\-offset\fP \fIoffset\fP
-Specifies the beginning offset of the range, in bytes.
-.IP "\fB\-l, \-\-length\fP \fIlength\fP
-Specifies the length of the range, in bytes.
-.IP "\fB\-h, \-\-help\fP"
-Display help text and exit.
-.IP "\fB-v, \-\-verbose"
-Enable verbose mode.
-.IP "\fB-V, \-\-version"
+.TP
+.BR \-V , " \-\-version"
 Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
 .SH AUTHORS
 .UR sandeen@redhat.com
 Eric Sandeen
diff --git a/sys-utils/flock.1 b/sys-utils/flock.1
index 6c28a35..276d726 100644
--- a/sys-utils/flock.1
+++ b/sys-utils/flock.1
@@ -61,56 +61,55 @@ The third form uses an open file by its file descriptor \fInumber\fR.
 See the examples below for how that can be used.
 .SH OPTIONS
 .TP
-\fB\-s\fP, \fB\-\-shared\fP
-Obtain a shared lock, sometimes called a read lock.
+.BR \-c , " \-\-command " \fIcommand
+Pass a single \fIcommand\fR, without arguments, to the shell with
+.BR \-c .
 .TP
-\fB\-x\fP, \fB\-e\fP, \fB\-\-exclusive\fP
+.BR \-E , " \-\-conflict-exit-code " \fInumber
+The exit code used when the \fB\-n\fP option is in use, and the
+conflicting lock exists, or the \fB\-w\fP option is in use,
+and the timeout is reached.  The default value is \fB1\fR.
+.TP
+.BR \-e , " \-x" , " \-\-exclusive"
 Obtain an exclusive lock, sometimes called a write lock.  This is the
 default.
 .TP
-\fB\-u\fP, \fB\-\-unlock\fP
-Drop a lock.  This is usually not required, since a lock is automatically
-dropped when the file is closed.  However, it may be required in special
-cases, for example if the enclosed command group may have forked a background
-process which should not be holding the lock.
-.TP
-\fB\-n\fP, \fB\-\-nb\fP, \fB\-\-nonblock\fP
+.BR \-n , " \-\-nb" , " \-\-nonblock"
 Fail rather than wait if the lock cannot be
 immediately acquired.
 See the
 .B \-E
 option for the exit code used.
 .TP
-\fB\-w\fP, \fB\-\-wait\fP, \fB\-\-timeout\fP \fIseconds\fP
-Fail if the lock cannot be acquired within
-.IR seconds .
-Decimal fractional values are allowed.
-See the
-.B \-E
-option for the exit code used.
-.TP
-\fB\-o\fP, \fB\-\-close\fP
+.BR \-o , " \-\-close"
 Close the file descriptor on which the lock is held before executing
 .IR command .
 This is useful if
 .I command
 spawns a child process which should not be holding the lock.
 .TP
-\fB\-E\fP, \fB\-\-conflict\-exit\-code\fP \fInumber\fP
-The exit code used when the \fB\-n\fP option is in use, and the
-conflicting lock exists, or the \fB\-w\fP option is in use,
-and the timeout is reached.  The default value is 1.
+.BR \-s , " \-\-shared"
+Obtain a shared lock, sometimes called a read lock.
 .TP
-\fB\-c\fP, \fB\-\-command\fP \fIcommand\fP
-Pass a single
-.IR command ,
-without arguments, to the shell with
-.BR -c .
+.BR \-u , " \-\-unlock"
+Drop a lock.  This is usually not required, since a lock is automatically
+dropped when the file is closed.  However, it may be required in special
+cases, for example if the enclosed command group may have forked a background
+process which should not be holding the lock.
 .TP
-\fB\-h\fP, \fB\-\-help\fP
-Display help text and exit.
-.IP "\fB\-V, \-\-version\fP"
+.BR \-w , " \-\-wait" , " \-\-timeout " \fIseconds
+Fail if the lock cannot be acquired within
+.IR seconds .
+Decimal fractional values are allowed.
+See the
+.B \-E
+option for the exit code used.
+.TP
+.BR \-V , " \-\-version"
 Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
 .SH EXAMPLES
 .TP
 shell1> flock /tmp -c cat
diff --git a/sys-utils/ipcmk.1 b/sys-utils/ipcmk.1
index f79a717..48e34bf 100644
--- a/sys-utils/ipcmk.1
+++ b/sys-utils/ipcmk.1
@@ -14,7 +14,7 @@ and semaphore arrays.
 .TP
 Resources can be specified with these options:
 .TP
-.BR \-M , " \-\-shmem \fIsize\fR"
+.BR \-M , " \-\-shmem " \fIsize
 Create a shared memory segment of
 .I size
 bytes.
@@ -22,20 +22,20 @@ bytes.
 .BR \-Q , " \-\-queue"
 Create a message queue.
 .TP
-.BR \-S , " \-\-semaphore \fInumber\fR"
+.BR \-S , " \-\-semaphore " \fInumber
 Create a semaphore array with
 .I number
 of elements.
 .PP
 Other options are:
 .TP
-.BR \-p , " \-\-mode \fImode\fR"
+.BR \-p , " \-\-mode " \fImode
 Access permissions for the resource.  Default is 0644.
 .TP
-\fB\-V\fR, \fB\-\-version\fR
+.BR \-V , " \-\-version"
 Display version information and exit.
 .TP
-\fB\-h\fR, \fB\-\-help\fR
+.BR \-h , " \-\-help"
 Display help text and exit.
 .PP
 .SH "SEE ALSO"
diff --git a/sys-utils/ipcrm.1 b/sys-utils/ipcrm.1
index bdec3b8..6f58d0f 100644
--- a/sys-utils/ipcrm.1
+++ b/sys-utils/ipcrm.1
@@ -37,49 +37,55 @@ with objects specified either by key or by identifier (see below).
 Both keys and identifiers may be specified in decimal, hexadecimal
 (specified with an initial '0x' or '0X'), or octal (specified with
 an initial '0').
+.PP
+The details of the removes are described in
+.BR shmctl (2),
+.BR msgctl (2),
+and
+.BR semctl (2).
+The identifiers and keys can be found by using
+.BR ipcs (1).
 .SH OPTIONS
 .TP
-\fB\-M\fR, \fB\-\-shmem\-key\fR \fIshmkey\fR
+\fB-a\fR, \fB\-\-all\fR [\fBshm\fR] [\fBmsg\fR] [\fBsem\fR]
+Remove all resources.  When an option argument is provided, the removal is
+performed only for the specified resource types.  \fIWarning!\fR  Do not use
+.B \-a
+if you are unsure how the software using the resources might react to missing
+objects.  Some programs create these resources at startup and may not have
+any code to deal with an unexpected disappearance.
+.TP
+.BR \-M , " \-\-shmem-key " \fIshmkey
 Remove the shared memory segment created with
 .I shmkey
 after the last detach is performed.
 .TP
-\fB\-m\fR, \fB\-\-shmem\-id\fR \fIshmid\fR
+.BR \-m , " \-\-shmem-id " \fIshmid
 Remove the shared memory segment identified by
 .I shmid
 after the last detach is performed.
 .TP
-\fB\-Q\fR, \fB\-\-queue\-key\fR \fImsgkey\fR
+.BR \-Q , " \-\-queue-key " \fImsgkey
 Remove the message queue created with
 .IR msgkey .
 .TP
-\fB\-q\fR, \fB\-\-queue\-id\fR \fImsgid\fR
+.BR \-q , " \-\-queue-id " \fImsgid
 Remove the message queue identified by
 .IR msgid .
 .TP
-\fB\-S\fR, \fB\-\-semaphore\-key\fR \fIsemkey\fR
+.BR \-S , " \-\-semaphore-key " \fIsemkey
 Remove the semaphore created with
 .IR semkey .
 .TP
-\fB\-s\fR, \fB\-\-semaphore\-id\fR \fIsemid\fR
+.BR \-s , " \-\-semaphore-id " \fIsemid
 Remove the semaphore identified by
 .IR semid .
 .TP
-\fB-a\fR, \fB\-\-all\fR [\fBshm\fR] [\fBmsg\fR] [\fBsem\fR]
-Remove all resources.  When an option argument is provided, the removal is
-performed only for the specified resource types.  \fIWarning!\fR  Do not use
-.B \-a
-if you are unsure how the software using the resources might react to missing
-objects.  Some programs create these resources at startup and may not have
-any code to deal with an unexpected disappearance.
-.LP
-The details of the removes are described in
-.BR shmctl (2),
-.BR msgctl (2),
-and
-.BR semctl (2).
-The identifiers and keys can be found by using
-.BR ipcs (1).
+.BR \-V , " \-\-version"
+Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
 .SH NOTES
 In its first Linux implementation, \fBipcrm\fR used the deprecated syntax
 shown in the second line of the
diff --git a/sys-utils/renice.1 b/sys-utils/renice.1
index 5a4fcab..ec505bf 100644
--- a/sys-utils/renice.1
+++ b/sys-utils/renice.1
@@ -72,11 +72,11 @@ Interpret the succeeding arguments as process IDs
 .BR \-u , " \-\-user
 Interpret the succeeding arguments as usernames or UIDs.
 .TP
-.BR \-h , " \-\-help"
-Display help text and exit.
-.TP
 .BR \-V , " \-\-version"
 Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
 .SH EXAMPLES
 The following command would change the priority of the processes with
 PIDs 987 and 32, plus all processes owned by the users daemon and root:
diff --git a/sys-utils/setpriv.1 b/sys-utils/setpriv.1
index f627aeb..2a10424 100644
--- a/sys-utils/setpriv.1
+++ b/sys-utils/setpriv.1
@@ -11,28 +11,17 @@ Sets or queries various Linux privilege settings that are inherited across
 .BR execve (2).
 .SH OPTION
 .TP
-\fB\-d\fR, \fB\-\-dump\fR
+.B \-\-clear\-groups
+Clear supplementary groups.
+.TP
+.BR \-d , " \-\-dump"
 Dump current privilege state.  Can be specified more than once to show extra,
 mostly useless, information.  Incompatible with all other options.
 .TP
-\fB\-\-no\-new\-privs\fR
-Set the
-.I no_new_privs
-bit.  With this bit set,
-.BR execve (2)
-will not grant new privileges.  For example, the setuid and setgid bits as well
-as file capabilities will be disabled.  (Executing binaries with these bits set
-will still work, but they will not gain privileges.  Certain LSMs, especially
-AppArmor, may result in failures to execute certain programs.)  This bit is
-inherited by child processes and cannot be unset.  See
-.BR prctl (2)
-and
-.IR Documentation/\:prctl/\:no_\:new_\:privs.txt
-in the Linux kernel source.
-.IP
-The no_new_privs bit is supported since Linux 3.5.
+.B \-\-groups \fIgroup\fR...
+Set supplementary groups.  The argument is a comma-separated list.
 .TP
-.B \-\-inh\-caps \fR(\fB+\fR|\fB\-\fR)\fIcap\fR... or \fB\-\-bounding\-set \fR(\fB+\fR|\fB\-\fR)\fIcap\fR...
+.BR \-\-inh-caps " (" + | \- ) \fIcap "...  or  " \-\-bounding\-set " (" + | \- ) \fIcap ...
 Set the inheritable capabilities or the capability bounding set.  See
 .BR capabilities (7).
 The argument is a comma-separated list of
@@ -51,47 +40,58 @@ and the current bounding set for
 If you drop something from the bounding set without also dropping it from the
 inheritable set, you are likely to become confused.  Do not do that.
 .TP
+.B \-\-keep\-groups
+Preserve supplementary groups.  Only useful in conjunction with
+.BR \-\-rgid ,
+.BR \-\-egid ", or"
+.BR \-\-regid .
+.TP
 .BR \-\-list\-caps
 List all known capabilities.  This option must be specified alone.
 .TP
-\fB\-\-ruid\fR \fIuid\fR, \fB\-\-euid\fR \fIuid\fR, \fB\-\-reuid\fR \fIuid\fR
+.B \-\-no-new-privs
+Set the
+.I no_new_privs
+bit.  With this bit set,
+.BR execve (2)
+will not grant new privileges.  For example, the setuid and setgid bits as well
+as file capabilities will be disabled.  (Executing binaries with these bits set
+will still work, but they will not gain privileges.  Certain LSMs, especially
+AppArmor, may result in failures to execute certain programs.)  This bit is
+inherited by child processes and cannot be unset.  See
+.BR prctl (2)
+and
+.IR Documentation/\:prctl/\:no_\:new_\:privs.txt
+in the Linux kernel source.
+.sp
+The no_new_privs bit is supported since Linux 3.5.
+.TP
+.BI \-\-rgid " gid\fR, " \-\-egid " gid\fR, " \-\-regid " gid"
+Set the real, effective, or both gids.  The \fIgid\fR argument can be
+given as textual group name.
+.sp
+For safety, you must specify one of
+.BR \-\-clear-groups ,
+.BR \-\-groups ", or"
+.BR \-\-keep-groups
+if you set any primary
+.IR gid .
+.TP
+.BI \-\-ruid " uid\fR, " \-\-euid " uid\fR, " \-\-reuid " uid"
 Set the real, effective, or both uids.  The \fIuid\fR argument can be
 given as textual login name.
-.IP
-Setting
+.sp
+Setting a
 .I uid
 or
 .I gid
 does not change capabilities, although the exec call at the end might change
 capabilities.  This means that, if you are root, you probably want to do
 something like:
-.IP
-\-\-reuid=1000 \-\-regid=1000 \-\-caps=\-all
-.TP
-\fB\-\-rgid\fR \fIgid\fR, \fB\-\-egid\fR \fIgid\fR, \fB\-\-regid\fR \fIgid\fR
-Set the real, effective, or both gids.  The \fIgid\fR argument can be
-given as textual group name.
-.IP
-For safety, you must specify one of
-.BR \-\-keep\-groups ,
-.BR \-\-clear\-groups ", or"
-.B \-\-groups
-if you set any primary
-.IR gid .
-.TP
-.B \-\-clear\-groups
-Clear supplementary groups.
-.TP
-.B \-\-keep\-groups
-Preserve supplementary groups.  Only useful in conjunction with
-.BR \-\-rgid ,
-.BR \-\-egid ", or"
-.BR \-\-regid .
-.TP
-.B \-\-groups \fIgroup\fR...
-Set supplementary groups.  The argument is a comma-separated list.
+.sp
+.B "        setpriv \-\-reuid=1000 \-\-regid=1000 \-\-caps=\-all"
 .TP
-.B \-\-securebits \fR(\fB+\fR|\fB\-\fR)\fIsecurebit\fR...
+.BR \-\-securebits " (" + | \- ) \fIsecurebit ...
 Set or clear securebits.  The argument is a comma-separated list.
 The valid securebits are
 .IR noroot ,
@@ -105,7 +105,7 @@ is cleared by
 .BR execve (2)
 and is therefore not allowed.
 .TP
-\fB\-\-selinux\-label\fR \fIlabel\fR
+.BI \-\-selinux-label " label"
 Request a particular SELinux transition (using a transition on exec, not
 dyntrans).  This will fail and cause
 .BR setpriv (1)
@@ -117,7 +117,7 @@ conjunction with
 This is similar to
 .BR runcon (1).
 .TP
-\fB\-\-apparmor\-profile\fR \fIprofile\fR
+.BI \-\-apparmor-profile " profile"
 Request a particular AppArmor profile (using a transition on exec).  This will
 fail and cause
 .BR setpriv (1)
@@ -125,10 +125,10 @@ to abort if AppArmor is not in use, and the transition may be ignored or cause
 .BR execve (2)
 to fail at AppArmor's whim.
 .TP
-\fB\-V\fR, \fB\-\-version\fR
+.BR \-V , " \-\-version"
 Display version information and exit.
 .TP
-\fB\-h\fR, \fB\-\-help\fR
+.BR \-h , " \-\-help"
 Display help text and exit.
 .SH NOTES
 If applying any specified option fails,
diff --git a/sys-utils/setsid.1 b/sys-utils/setsid.1
index 70e5079..7a30587 100644
--- a/sys-utils/setsid.1
+++ b/sys-utils/setsid.1
@@ -6,8 +6,9 @@
 setsid \- run a program in a new session
 .SH SYNOPSIS
 .B setsid
+[options]
 .I program
-.RI [ argument ...]
+.RI [ arguments ]
 .SH DESCRIPTION
 .B setsid
 runs a program in a new session.
@@ -20,6 +21,12 @@ Set the controlling terminal to the current one.
 Wait for the execution of the program to end, and return the exit value of
 this program as the return value of
 .BR setsid .
+.TP
+.BR \-V , " \-\-version"
+Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
 .SH "SEE ALSO"
 .BR setsid (2)
 .SH AUTHOR
diff --git a/sys-utils/unshare.1 b/sys-utils/unshare.1
index 9342262..1aa9bcb 100644
--- a/sys-utils/unshare.1
+++ b/sys-utils/unshare.1
@@ -48,9 +48,6 @@ The process will have a distinct set of UIDs, GIDs and capabilities.
 See \fBclone\fR(2) for the exact semantics of the flags.
 .SH OPTIONS
 .TP
-.BR \-h , " \-\-help"
-Display help text and exit.
-.TP
 .BR \-i , " \-\-ipc"
 Unshare the IPC namespace.
 .TP
@@ -88,6 +85,12 @@ conveniently gain capabilities needed to manage various aspects of the newly cre
 namespaces (such as configuring interfaces in the network namespace or mounting filesystems in
 the mount namespace) even when run unprivileged.  As a mere convenience feature, it does not support
 more sophisticated use cases, such as mapping multiple ranges of UIDs and GIDs.
+.TP
+.BR \-V , " \-\-version"
+Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
 .SH SEE ALSO
 .BR unshare (2),
 .BR clone (2),
-- 
1.7.0.4


^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [PATCH 2/4] docs: improve some wordings in the man page of mount
  2014-07-25 12:55 [PATCH 1/4] docs: fix some things that were overlooked during the first pass Benno Schulenberg
@ 2014-07-25 12:55 ` Benno Schulenberg
  2014-07-25 12:55 ` [PATCH 3/4] various: erase all traces of the long-obsolete xiafs Benno Schulenberg
                   ` (2 subsequent siblings)
  3 siblings, 0 replies; 6+ messages in thread
From: Benno Schulenberg @ 2014-07-25 12:55 UTC (permalink / raw)
  To: util-linux

Also sort the command-line options alphabetically
(with the customary exception of -V and -h).

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 sys-utils/mount.8 |  336 ++++++++++++++++++++++++++++-------------------------
 1 files changed, 177 insertions(+), 159 deletions(-)

diff --git a/sys-utils/mount.8 b/sys-utils/mount.8
index 43ef005..b73e854 100644
--- a/sys-utils/mount.8
+++ b/sys-utils/mount.8
@@ -34,26 +34,25 @@
 mount \- mount a filesystem
 .SH SYNOPSIS
 .B mount
-.RB [ \-lhV ]
+.RB [ \-l | \-h | \-V ]
 .LP
-.\" Quote used to include space between arguments
-.B "mount \-a
+.B mount \-a
 .RB [ \-fFnrsvw ]
 .RB [ \-t
-.IR vfstype ]
+.IR fstype ]
 .RB [ \-O
 .IR optlist ]
 .LP
 .B mount
 .RB [ \-fnrsvw ]
 .RB [ \-o
-.IR option [ \fB,\fIoption ]...]
+.IR options ]
 .IR device | dir
 .LP
 .B mount
 .RB [ \-fnrsvw ]
 .RB [ \-t
-.IB vfstype ]
+.IB fstype ]
 .RB [ \-o
 .IR options ]
 .I device dir
@@ -215,7 +214,7 @@ to be mounted as indicated, except for those whose line contains the
 .B noauto
 keyword.  Adding the
 .B \-F
-option will make mount fork, so that the
+option will make \fBmount\fR fork, so that the
 filesystems are mounted simultaneously.
 .LP
 When mounting a filesystem mentioned in
@@ -223,25 +222,23 @@ When mounting a filesystem mentioned in
 or
 .IR mtab ,
 it suffices to specify on the command line only the device, or only the mount point.
-
-
+.sp
 The programs
 .B mount
 and
 .B umount
-traditionally maintained list of currently mounted filesystems in the file
+traditionally maintained a list of currently mounted filesystems in the file
 .IR /etc/mtab .
-The mtab file is still supported, but it's recommended to use a symlink to 
-the file
+This real mtab file is still supported, but on current Linux systems it is
+better to make it a symlink to
 .I /proc/mounts
-rather than the regular mtab file on the current Linux systems.
-The mtab file maintained in userspace cannot reliably work with namespaces, containers
-and another advanced Linux features.
-
+instead, because a regular mtab file maintained in userspace cannot reliably
+work with namespaces, containers and other advanced Linux features.
+.sp
 If no arguments are given to
 .BR mount ,
-this list is printed.
-
+the list of mounted filesystems is printed.
+.sp
 If you want to override mount options from
 .I /etc/fstab
 you have to use the \fB\-o\fR option:
@@ -255,7 +252,7 @@ the list of options from
 .IR /etc/fstab .
 The usual behavior is that the last option wins if there are conflicting
 ones.
-
+.sp
 The
 .B mount
 program does not read the
@@ -532,24 +529,36 @@ option, when present.
 The command \fBmount\fR does not pass all command-line options to the
 \fB/sbin/mount.\fIsuffix\fR mount helpers.  The interface between \fBmount\fR
 and the mount helpers is described below in the section EXTERNAL HELPERS.
-
+.sp
 Command-line options available for the
 .B mount
 command are:
-.IP "\fB\-V, \-\-version\fP"
-Display version information and exit.
-.IP "\fB\-h, \-\-help\fP"
-Display help text and exit.
-.IP "\fB\-v, \-\-verbose\fP"
-Verbose mode.
-.IP "\fB\-a, \-\-all\fP"
+.TP
+.BR \-a , " \-\-all"
 Mount all filesystems (of the given types) mentioned in
 .I fstab
 (except for those whose line contains the
 .B noauto
 keyword).  The filesystems are mounted following their order in
 .IR fstab .
-.IP "\fB\-F, \-\-fork\fP"
+.TP
+.BR \-B , " \-\-bind"
+Remount a subtree somewhere else (so that its contents are available
+in both places).  See above.
+.TP
+.BR \-c , " \-\-no-canonicalize"
+Don't canonicalize paths.  The mount command canonicalizes all paths
+(from command line or fstab) by default.  This option can be used
+together with the
+.B \-f
+flag for already canonicalized absolute paths.  The option is designed for mount
+helpers which call \fBmount -i\fR.  It is strongly recommended to not use this
+command-line option for normal mount operations.
+.sp
+Note that \fBmount\fR(8) does not pass this option to the
+\fB/sbin/mount.\fItype\fR helpers.
+.TP
+.BR \-F , " \-\-fork"
 (Used in conjunction with
 .BR \-a .)
 Fork off a new incarnation of \fBmount\fR for each device.
@@ -574,7 +583,12 @@ checks for an existing record in /etc/mtab and fails when the record already
 exists (with a regular non-fake mount, this check is done by the kernel).
 .IP "\fB\-i, \-\-internal-only\fP"
 Don't call the \fB/sbin/mount.\fIfilesystem\fR helper even if it exists.
-.IP "\fB\-l, \-\-show-labels\fP"
+.TP
+.BR \-L , " \-\-label " \fIlabel
+Mount the partition that has the specified
+.IR label .
+.TP
+.BR \-l , " \-\-show-labels"
 Add the labels in the mount output.  \fBmount\fR must have
 permission to read the disk device (e.g.\& be suid root) for this to work.
 One can set such a label for ext2, ext3 or ext4 using the
@@ -583,39 +597,85 @@ utility, or for XFS using
 .BR xfs_admin (8),
 or for reiserfs using
 .BR reiserfstune (8).
-.IP "\fB\-n, \-\-no-mtab\fP"
+.TP
+.BR \-M , " \-\-move"
+Move a subtree to some other place.  See above.
+.TP
+.BR \-n , " \-\-no-mtab"
 Mount without writing in
 .IR /etc/mtab .
 This is necessary for example when
 .I /etc
 is on a read-only filesystem.
-.IP "\fB\-c, \-\-no-canonicalize\fP"
-Don't canonicalize paths.  The mount command canonicalizes all paths
-(from command line or fstab) by default.  This option can be used
-together with the
-.B \-f
-flag for already canonicalized absolute paths.  The option is designed for mount
-helpers which call \fBmount -i\fR.  It is strongly recommended to not use this
-command-line option for normal mount operations.
+.TP
+.BR \-O , " \-\-test-opts " \fIopts
+Limit the set of filesystems to which the
+.B \-a
+option applies.  In this regard it is like the
+.B \-t
+option except that
+.B \-O
+is useless without
+.BR \-a .
+For example, the command:
+.RS
+.RS
+.sp
+.B "mount \-a \-O no_netdev"
+.sp
+.RE
+mounts all filesystems except those which have the option
+.I _netdev
+specified in the options field in the
+.I /etc/fstab
+file.
 
-Note that \fBmount\fR(8) does not pass this option to the
-\fB/sbin/mount.\fItype\fR helpers.
-.IP "\fB\-s\fP"
-Tolerate sloppy mount options rather than failing.  This will ignore mount
-options not supported by a filesystem type.  Not all filesystems support this
-option.  Currently it's supported by the \fBmount.nfs\fR mount helper only.
-.IP "\fB\-\-source \fIdev\fP"
-If only one argument for the mount command is given then the argument might be
-interpreted as target (mountpoint) or source (device).  This option allows to
-explicitly define that the argument is the mount source.
-.IP "\fB\-\-target \fIdir\fP"
-If only one argument for the mount command is given then the argument might be
-interpreted as target (mountpoint) or source (device).  This option allows to
-explicitly define that the argument is the mount target.
-.IP "\fB\-r, \-\-read-only\fP"
+It is different from
+.B \-t
+in that each option is matched exactly; a leading
+.B no
+at the beginning of one option does not negate the rest.
+
+The
+.B \-t
+and
+.B \-O
+options are cumulative in effect; that is, the command
+.RS
+.sp
+.B "mount \-a \-t ext2 \-O _netdev"
+.sp
+.RE
+mounts all ext2 filesystems with the _netdev option, not all filesystems
+that are either ext2 or have the _netdev option specified.
+.RE
+.TP
+.BR \-o , " \-\-options " \fIopts
+Use the specified mount options.  The \fIopts\fR argument is
+a comma-separated list.  For example:
+.RS
+.RS
+.sp
+.B "mount LABEL=mydisk \-o noatime,nodev,nosuid"
+.sp
+.RE
+
+For more details, see the
+.B FILESYSTEM-INDEPENDENT MOUNT OPTIONS
+and
+.B FILESYSTEM-SPECIFIC MOUNT OPTIONS
+sections.
+.RE
+
+.TP
+.BR \-R , " \-\-rbind"
+Remount a subtree and all possible submounts somewhere else (so that its
+contents are available in both places).  See above.
+.TP
+.BR \-r , " \-\-read-only"
 Mount the filesystem read-only.  A synonym is
 .BR "\-o ro" .
-
+.sp
 Note that, depending on the filesystem type, state and kernel behavior, the
 system may still write to the device.  For example, ext3 and ext4 will replay the
 journal if the filesystem is dirty.  To prevent this kind of write access, you
@@ -623,19 +683,23 @@ may want to mount an ext3 or ext4 filesystem with the \fBro,noload\fR mount
 options or set the block device itself to read-only mode, see the
 .BR blockdev (8)
 command.
-.IP "\fB\-w, \-\-rw, \-\-read-write\fP"
-Mount the filesystem read/write.  This is the default.  A synonym is
-.BR "\-o rw" .
-.IP "\fB\-L, \-\-label \fIlabel\fP"
-Mount the partition that has the specified
-.IR label .
-.IP "\fB\-U, \-\-uuid \fIuuid\fP"
-Mount the partition that has the specified
-.IR uuid .
-These two options require the file
-.I /proc/partitions
-(present since Linux 2.1.116) to exist.
-.IP "\fB\-T, \-\-fstab \fIpath\fP"
+.TP
+.B \-s
+Tolerate sloppy mount options rather than failing.  This will ignore mount
+options not supported by a filesystem type.  Not all filesystems support this
+option.  Currently it's supported by the \fBmount.nfs\fR mount helper only.
+.TP
+.BI \-\-source " device"
+If only one argument for the mount command is given then the argument might be
+interpreted as target (mountpoint) or source (device).  This option allows to
+explicitly define that the argument is the mount source.
+.TP
+.BI \-\-target " directory"
+If only one argument for the mount command is given then the argument might be
+interpreted as target (mountpoint) or source (device).  This option allows to
+explicitly define that the argument is the mount target.
+.TP
+.BR \-T , " \-\-fstab " \fIpath
 Specifies an alternative fstab file.  If \fIpath\fP is a directory then the files
 in the directory are sorted by
 .BR strverscmp (3);
@@ -643,22 +707,23 @@ files that start with "."\& or without an \&.fstab extension are ignored.  The o
 can be specified more than once.  This option is mostly designed for initramfs
 or chroot scripts where additional configuration is specified beyond standard
 system configuration.
-
+.sp
 Note that \fBmount\fR(8) does not pass the option \fB\-\-fstab\fP to the
 \fB/sbin/mount.\fItype\fR helpers, meaning that the alternative fstab files will be
 invisible for the helpers.  This is no problem for normal mounts, but user
 (non-root) mounts always require fstab to verify the user's rights.
-.IP "\fB\-t, \-\-types \fIvfstype\fP"
+.TP
+.BR \-t , " \-\-types " \fIfstype
 The argument following the
 .B \-t
 is used to indicate the filesystem type.  The filesystem types which are
-currently supported depend on kernel. See
+currently supported depend on the running kernel.  See
 .I /proc/filesystems
 and
 .I /lib/modules/$(uname -r)/kernel/fs
-for complete list of the filesystems. The most common are ext2, ext3, ext4, 
+for a complete list of the filesystems.  The most common are ext2, ext3, ext4,
 xfs, btrfs, vfat, sysfs, proc, nfs and cifs.
-
+.sp
 The programs
 .B mount
 and
@@ -691,7 +756,7 @@ ends in a line with a single *, mount will read
 .I /proc/filesystems
 afterwards.  While trying, all filesystem types will be
 mounted with the mount option \fBsilent\fR.
-
+.sp
 The
 .B auto
 type may be useful for user-mounted floppies.
@@ -699,23 +764,23 @@ Creating a file
 .I /etc/filesystems
 can be useful to change the probe order (e.g., to try vfat before msdos
 or ext3 before ext2) or if you use a kernel module autoloader.
-
+.sp
 More than one type may be specified in a comma-separated
-list for
+list, for option
 .B \-t
-as well as by
+as well as in an
 .I /etc/fstab
-entry.  The list of filesystem types for the option
-.B \-t 
+entry.  The list of filesystem types for option
+.B \-t
 can be prefixed with
 .B no
 to specify the filesystem types on which no action should be taken.
 The prefix
 .B no
-has no any effect when specified by
+has no effect when specified in an
 .I /etc/fstab
 entry.
-
+.sp
 The prefix
 .B no
 can be meaningful with the
@@ -750,72 +815,23 @@ program have different calling conventions,
 .B /sbin/mount.smbfs
 may have to be a shell script that sets up the desired call.
 .RE
-
-.IP "\fB\-O, \-\-test-opts \fIopts\fP"
-Limit the set of filesystems to which the
-.B \-a
-option applies.  In this regard it is like the
-.B \-t
-option except that
-.B \-O
-is useless without
-.BR \-a .
-For example, the command:
-.RS
-.RS
-.sp
-.B "mount \-a \-O no_netdev"
-.sp
-.RE
-mounts all filesystems except those which have the option
-.I _netdev
-specified in the options field in the
-.I /etc/fstab
-file.
-
-It is different from
-.B \-t
-in that each option is matched exactly; a leading
-.B no
-at the beginning of one option does not negate the rest.
-
-The
-.B \-t
-and
-.B \-O
-options are cumulative in effect; that is, the command
-.RS
-.sp
-.B "mount \-a \-t ext2 \-O _netdev"
-.sp
-.RE
-mounts all ext2 filesystems with the _netdev option, not all filesystems
-that are either ext2 or have the _netdev option specified.
-.RE
-.IP "\fB\-o, \-\-options \fIopts\fP"
-Use the specified mount options.  The \fIopts\fR argument is
-a comma-separated list.  For example:
-.RS
-.RS
-.sp
-.B "mount LABEL=mydisk \-o noatime,nodev,nosuid"
-.sp
-.RE
-
-For more details, see the
-.B FILESYSTEM-INDEPENDENT MOUNT OPTIONS
-and
-.B FILESYSTEM-SPECIFIC MOUNT OPTIONS
-sections.
-.RE
-.IP "\fB\-B, \-\-bind\fP"
-Remount a subtree somewhere else (so that its contents are available
-in both places).  See above.
-.IP "\fB\-R, \-\-rbind\fP"
-Remount a subtree and all possible submounts somewhere else (so that its
-contents are available in both places).  See above.
-.IP "\fB\-M, \-\-move\fP"
-Move a subtree to some other place.  See above.
+.TP
+.BR \-U , " \-\-uuid " \fIuuid
+Mount the partition that has the specified
+.IR uuid .
+.TP
+.BR \-v , " \-\-verbose"
+Verbose mode.
+.TP
+.BR \-w , " \-\-rw" , " \-\-read-write"
+Mount the filesystem read/write.  This is the default.  A synonym is
+.BR "\-o rw" .
+.TP
+.BR \-V , " \-\-version"
+Display version information and exit.
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
 
 .SH FILESYSTEM-INDEPENDENT MOUNT OPTIONS
 Some of these options are only useful when they appear in the
@@ -966,8 +982,8 @@ Do not permit direct execution of any binaries on the mounted filesystem.
 /lib/ld*.so /mnt/binary.  This trick fails since Linux 2.4.25 / 2.6.0.)
 .TP
 .B group
-Allow an ordinary (i.e., non-root) user to mount the filesystem if one
-of his groups matches the group of the device.
+Allow an ordinary user to mount the filesystem if one
+of that user's groups matches the group of the device.
 This option implies the options
 .BR nosuid " and " nodev
 (unless overridden by subsequent options, as in the option line
@@ -1044,8 +1060,8 @@ Turn on the silent flag.
 Turn off the silent flag.
 .TP
 .B owner
-Allow an ordinary (i.e., non-root) user to mount the filesystem if he
-is the owner of the device.
+Allow an ordinary user to mount the filesystem if that
+user is the owner of the device.
 This option implies the options
 .BR nosuid " and " nodev
 (unless overridden by subsequent options, as in the option line
@@ -1090,31 +1106,33 @@ media with a limited number of write cycles
 .TP
 .B user
 Allow an ordinary user to mount the filesystem.
-The name of the mounting user is written to mtab (or to the private libmount
-file in /run/mount on system without regular mtab) so that he can unmount the
-filesystem again.
+The name of the mounting user is written to the mtab file (or to the private
+libmount file in /run/mount on systems without a regular mtab) so that this
+same user can unmount the filesystem again.
 This option implies the options
 .BR noexec ", " nosuid ", and " nodev
 (unless overridden by subsequent options, as in the option line
 .BR user,exec,dev,suid ).
 .TP
 .B nouser
-Forbid an ordinary (i.e., non-root) user to mount the filesystem.
+Forbid an ordinary user to mount the filesystem.
 This is the default; it does not imply any other options.
 .TP
 .B users
-Allow every user to mount and unmount the filesystem.
+Allow any user to mount and to unmount the filesystem, even
+when some other ordinary user mounted it.
 This option implies the options
 .BR noexec ", " nosuid ", and " nodev
 (unless overridden by subsequent options, as in the option line
 .BR users,exec,dev,suid ).
 .TP
 .B x-*
-All options prefixed with "x-" are interpreted as comments or userspace
+All options prefixed with "x-" are interpreted as comments or as userspace
 application-specific options.  These options are not stored in the mtab file,
-nor sent to the mount.<type> helpers nor the
+nor sent to the mount.\fItype\fR helpers nor to the
 .BR mount (2)
-system call.  The suggested format is x-<appname>.<option> (e.g.\& x-systemd.automount).
+system call.  The suggested format is \fBx-\fIappname\fR.\fIoption\fR
+(e.g.\& \fBx-systemd.automount\fR).
 .TP
 .BR x-mount.mkdir [ = \fImode\fR ]
 Allow to make a target directory (mountpoint).  The optional argument
@@ -1129,7 +1147,7 @@ The following options apply only to certain filesystems.
 We sort them by filesystem.  They all follow the
 .B \-o
 flag.
-
+.sp
 What options are supported depends a bit on the running kernel.
 More info may be found in the kernel source subdirectory
 .IR Documentation/filesystems .
-- 
1.7.0.4


^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [PATCH 3/4] various: erase all traces of the long-obsolete xiafs
  2014-07-25 12:55 [PATCH 1/4] docs: fix some things that were overlooked during the first pass Benno Schulenberg
  2014-07-25 12:55 ` [PATCH 2/4] docs: improve some wordings in the man page of mount Benno Schulenberg
@ 2014-07-25 12:55 ` Benno Schulenberg
  2014-07-28  9:33   ` Karel Zak
  2014-07-25 12:55 ` [PATCH 4/4] various: erase all traces of the long-obsolete ext filesystem Benno Schulenberg
  2014-07-28  9:17 ` [PATCH 1/4] docs: fix some things that were overlooked during the first pass Karel Zak
  3 siblings, 1 reply; 6+ messages in thread
From: Benno Schulenberg @ 2014-07-25 12:55 UTC (permalink / raw)
  To: util-linux

The xiafs filesystem was removed from the kernel fifteen years ago,
and any kernel that contained it reached end of life ten years ago.
It's time to stop mentioning it in the mount man page and elsewhere.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 bash-completion/findmnt |    3 +--
 bash-completion/mount   |    2 +-
 bash-completion/umount  |    2 +-
 disk-utils/fsck.8       |    1 -
 disk-utils/fsck.c       |    3 +--
 disk-utils/mkfs.8       |    3 +--
 sys-utils/mount.8       |    5 -----
 7 files changed, 5 insertions(+), 14 deletions(-)

diff --git a/bash-completion/findmnt b/bash-completion/findmnt
index 3ed331a..0f62aa4 100644
--- a/bash-completion/findmnt
+++ b/bash-completion/findmnt
@@ -61,8 +61,7 @@ _findmnt_module()
 				hfsplus hpfs iso9660 jfs minix msdos
 				ncpfs nfs nfs4 ntfs proc qnx4 ramfs
 				reiserfs romfs squashfs smbfs sysv tmpfs
-				ubifs udf ufs umsdos usbfs vfat xenix xfs
-				xiafs"
+				ubifs udf ufs umsdos usbfs vfat xenix xfs"
 			COMPREPLY=( $(compgen -W "$TYPES" -- $cur) )
 			return 0
 			;;
diff --git a/bash-completion/mount b/bash-completion/mount
index db97a91..7ebcec3 100644
--- a/bash-completion/mount
+++ b/bash-completion/mount
@@ -20,7 +20,7 @@ devpts	  nodevpts	nfs4	  nonfs4	usbfs	  nousbfs
 efs	  noefs		ntfs	  nontfs	vfat	  novfat
 ext	  noext		proc	  noproc	xenix	  noxenix
 ext2	  noext2	qnx4	  noqnx4	xfs	  noxfs
-ext3	  noext3	ramfs	  noramfs	xiafs	  noxiafs
+ext3	  noext3	ramfs	  noramfs
 ext4	  noext4	reiserfs  noreiserfs
 hfs	  nohfs		romfs	  noromfs
 "
diff --git a/bash-completion/umount b/bash-completion/umount
index f178bd7..5be921e 100644
--- a/bash-completion/umount
+++ b/bash-completion/umount
@@ -20,7 +20,7 @@ devpts	  nodevpts	nfs4	  nonfs4	usbfs	  nousbfs
 efs	  noefs		ntfs	  nontfs	vfat	  novfat
 ext	  noext		proc	  noproc	xenix	  noxenix
 ext2	  noext2	qnx4	  noqnx4	xfs	  noxfs
-ext3	  noext3	ramfs	  noramfs	xiafs	  noxiafs
+ext3	  noext3	ramfs	  noramfs
 ext4	  noext4	reiserfs  noreiserfs
 "
 			COMPREPLY=( $(compgen -W "$TYPES" -- $cur) )
diff --git a/disk-utils/fsck.8 b/disk-utils/fsck.8
index 51864d3..833fca2 100644
--- a/disk-utils/fsck.8
+++ b/disk-utils/fsck.8
@@ -457,7 +457,6 @@ or
 .BR fsck.nfs (8),
 .BR fsck.vfat (8),
 .BR fsck.xfs (8),
-.BR fsck.xiafs (8),
 .BR reiserfsck (8).
 .ad
 .SH AUTHOR
diff --git a/disk-utils/fsck.c b/disk-utils/fsck.c
index 40c59c6..a0f9db1 100644
--- a/disk-utils/fsck.c
+++ b/disk-utils/fsck.c
@@ -81,8 +81,7 @@ static const char *really_wanted[] = {
 	"ext4",
 	"ext4dev",
 	"jfs",
-	"reiserfs",
-	"xiafs"
+	"reiserfs"
 };
 
 /*
diff --git a/disk-utils/mkfs.8 b/disk-utils/mkfs.8
index 6246db9..675822d 100644
--- a/disk-utils/mkfs.8
+++ b/disk-utils/mkfs.8
@@ -100,8 +100,7 @@ for the ext2 filesystem.
 .BR mkfs.minix (8),
 .BR mkfs.msdos (8),
 .BR mkfs.vfat (8),
-.BR mkfs.xfs (8),
-.BR mkfs.xiafs (8)
+.BR mkfs.xfs (8)
 .ad
 .SH AVAILABILITY
 The mkfs command is part of the util-linux package and is available from
diff --git a/sys-utils/mount.8 b/sys-utils/mount.8
index b73e854..1acd7ce 100644
--- a/sys-utils/mount.8
+++ b/sys-utils/mount.8
@@ -2982,11 +2982,6 @@ where failover must not result in clients seeing
 inconsistent namespace presentation during or after a
 failover event.
 
-.SH "Mount options for xiafs"
-None.  Although nothing is wrong with xiafs, it is not used much,
-and is not maintained.  Probably one shouldn't use it.
-Since Linux version 2.1.21 xiafs is no longer part of the kernel source.
-
 .SH "THE LOOP DEVICE"
 One further possible type is a mount via the loop device.  For example,
 the command
-- 
1.7.0.4


^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [PATCH 4/4] various: erase all traces of the long-obsolete ext filesystem
  2014-07-25 12:55 [PATCH 1/4] docs: fix some things that were overlooked during the first pass Benno Schulenberg
  2014-07-25 12:55 ` [PATCH 2/4] docs: improve some wordings in the man page of mount Benno Schulenberg
  2014-07-25 12:55 ` [PATCH 3/4] various: erase all traces of the long-obsolete xiafs Benno Schulenberg
@ 2014-07-25 12:55 ` Benno Schulenberg
  2014-07-28  9:17 ` [PATCH 1/4] docs: fix some things that were overlooked during the first pass Karel Zak
  3 siblings, 0 replies; 6+ messages in thread
From: Benno Schulenberg @ 2014-07-25 12:55 UTC (permalink / raw)
  To: util-linux

The same argument as for xiafs: dead for over ten years.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
---
 bash-completion/findmnt |    2 +-
 bash-completion/mount   |    2 +-
 bash-completion/umount  |    3 ++-
 sys-utils/mount.8       |   13 +++----------
 4 files changed, 7 insertions(+), 13 deletions(-)

diff --git a/bash-completion/findmnt b/bash-completion/findmnt
index 0f62aa4..a7df4a0 100644
--- a/bash-completion/findmnt
+++ b/bash-completion/findmnt
@@ -57,7 +57,7 @@ _findmnt_module()
 		'-t'|'--types')
 			local TYPES
 			TYPES="adfs affs autofs cifs coda coherent cramfs
-				debugfs devpts efs ext ext2 ext3 ext4 hfs
+				debugfs devpts efs ext2 ext3 ext4 hfs
 				hfsplus hpfs iso9660 jfs minix msdos
 				ncpfs nfs nfs4 ntfs proc qnx4 ramfs
 				reiserfs romfs squashfs smbfs sysv tmpfs
diff --git a/bash-completion/mount b/bash-completion/mount
index 7ebcec3..e4a98ad 100644
--- a/bash-completion/mount
+++ b/bash-completion/mount
@@ -18,7 +18,7 @@ cramfs	  nocramfs	ncpfs	  noncpfs	ufs	  noufs
 debugfs	  nodebugfs	nfs	  nonfs		umsdos	  noumsdos
 devpts	  nodevpts	nfs4	  nonfs4	usbfs	  nousbfs
 efs	  noefs		ntfs	  nontfs	vfat	  novfat
-ext	  noext		proc	  noproc	xenix	  noxenix
+			proc	  noproc	xenix	  noxenix
 ext2	  noext2	qnx4	  noqnx4	xfs	  noxfs
 ext3	  noext3	ramfs	  noramfs
 ext4	  noext4	reiserfs  noreiserfs
diff --git a/bash-completion/umount b/bash-completion/umount
index 5be921e..ecf78ec 100644
--- a/bash-completion/umount
+++ b/bash-completion/umount
@@ -18,10 +18,11 @@ cramfs	  nocramfs	ncpfs	  noncpfs	ufs	  noufs
 debugfs	  nodebugfs	nfs	  nonfs		umsdos	  noumsdos
 devpts	  nodevpts	nfs4	  nonfs4	usbfs	  nousbfs
 efs	  noefs		ntfs	  nontfs	vfat	  novfat
-ext	  noext		proc	  noproc	xenix	  noxenix
+			proc	  noproc	xenix	  noxenix
 ext2	  noext2	qnx4	  noqnx4	xfs	  noxfs
 ext3	  noext3	ramfs	  noramfs
 ext4	  noext4	reiserfs  noreiserfs
+hfs	  nohfs		romfs	  noromfs
 "
 			COMPREPLY=( $(compgen -W "$TYPES" -- $cur) )
 			return 0
diff --git a/sys-utils/mount.8 b/sys-utils/mount.8
index 1acd7ce..b6711ad 100644
--- a/sys-utils/mount.8
+++ b/sys-utils/mount.8
@@ -789,14 +789,14 @@ option.  For example, the command
 .RS
 .RS
 .sp
-.B "mount \-a \-t nomsdos,ext"
+.B "mount \-a \-t nomsdos,smbfs"
 .sp
 .RE
 mounts all filesystems except those of type
 .I msdos
 and
-.IR ext .
-
+.IR smbfs .
+.sp
 For most types all the
 .B mount
 program has to do is issue a simple
@@ -1499,15 +1499,8 @@ starting with 2.6.29.  Further, this option is valid only if
 CONFIG_DEVPTS_MULTIPLE_INSTANCES is enabled in the kernel
 configuration.
 
-.SH "Mount options for ext"
-None.
-Note that the `ext' filesystem is obsolete.  Don't use it.
-Since Linux version 2.1.21 extfs is no longer part of the kernel source.
-
 .SH "Mount options for ext2"
 The `ext2' filesystem is the standard Linux filesystem.
-.\" Due to a kernel bug, it may be mounted with random mount options
-.\" (fixed in Linux 2.0.4).
 Since Linux 2.5.46, for most mount options the default
 is determined by the filesystem superblock.  Set them with
 .BR tune2fs (8).
-- 
1.7.0.4


^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: [PATCH 1/4] docs: fix some things that were overlooked during the first pass
  2014-07-25 12:55 [PATCH 1/4] docs: fix some things that were overlooked during the first pass Benno Schulenberg
                   ` (2 preceding siblings ...)
  2014-07-25 12:55 ` [PATCH 4/4] various: erase all traces of the long-obsolete ext filesystem Benno Schulenberg
@ 2014-07-28  9:17 ` Karel Zak
  3 siblings, 0 replies; 6+ messages in thread
From: Karel Zak @ 2014-07-28  9:17 UTC (permalink / raw)
  To: Benno Schulenberg; +Cc: util-linux

On Fri, Jul 25, 2014 at 02:55:01PM +0200, Benno Schulenberg wrote:
>  sys-utils/dmesg.1     |   29 ++++++++------
>  sys-utils/eject.1     |   94 +++++++++++++++++++++++++++-----------------
>  sys-utils/fallocate.1 |  104 ++++++++++++++++++++++++++----------------------
>  sys-utils/flock.1     |   61 ++++++++++++++--------------
>  sys-utils/ipcmk.1     |   10 ++--
>  sys-utils/ipcrm.1     |   48 +++++++++++++----------
>  sys-utils/renice.1    |    6 +-
>  sys-utils/setpriv.1   |  102 ++++++++++++++++++++++++------------------------
>  sys-utils/setsid.1    |    9 ++++-
>  sys-utils/unshare.1   |    9 +++-
>  10 files changed, 260 insertions(+), 212 deletions(-)

 Applied all patches in the set. Thanks!

    Karel

-- 
 Karel Zak  <kzak@redhat.com>
 http://karelzak.blogspot.com

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH 3/4] various: erase all traces of the long-obsolete xiafs
  2014-07-25 12:55 ` [PATCH 3/4] various: erase all traces of the long-obsolete xiafs Benno Schulenberg
@ 2014-07-28  9:33   ` Karel Zak
  0 siblings, 0 replies; 6+ messages in thread
From: Karel Zak @ 2014-07-28  9:33 UTC (permalink / raw)
  To: Benno Schulenberg; +Cc: util-linux

On Fri, Jul 25, 2014 at 02:55:03PM +0200, Benno Schulenberg wrote:
> diff --git a/bash-completion/mount b/bash-completion/mount
> index db97a91..7ebcec3 100644
> --- a/bash-completion/mount
> +++ b/bash-completion/mount
> @@ -20,7 +20,7 @@ devpts	  nodevpts	nfs4	  nonfs4	usbfs	  nousbfs
>  efs	  noefs		ntfs	  nontfs	vfat	  novfat
>  ext	  noext		proc	  noproc	xenix	  noxenix
>  ext2	  noext2	qnx4	  noqnx4	xfs	  noxfs
> -ext3	  noext3	ramfs	  noramfs	xiafs	  noxiafs
> +ext3	  noext3	ramfs	  noramfs
>  ext4	  noext4	reiserfs  noreiserfs
>  hfs	  nohfs		romfs	  noromfs

 I have doubts that static list of the filesystems in the
 bash-completion/ is a good idea. It would be better to generate
 the list according to the current kernel features, something like

 (awk '{ if ($0 ~ /^[[:blank:]]/) { print $1 } else { print $2 } }'
 /proc/filesystems; ls /lib/modules/$(uname -r)/kernel/fs) | sort -u

    Karel

-- 
 Karel Zak  <kzak@redhat.com>
 http://karelzak.blogspot.com

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2014-07-28  9:33 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-07-25 12:55 [PATCH 1/4] docs: fix some things that were overlooked during the first pass Benno Schulenberg
2014-07-25 12:55 ` [PATCH 2/4] docs: improve some wordings in the man page of mount Benno Schulenberg
2014-07-25 12:55 ` [PATCH 3/4] various: erase all traces of the long-obsolete xiafs Benno Schulenberg
2014-07-28  9:33   ` Karel Zak
2014-07-25 12:55 ` [PATCH 4/4] various: erase all traces of the long-obsolete ext filesystem Benno Schulenberg
2014-07-28  9:17 ` [PATCH 1/4] docs: fix some things that were overlooked during the first pass Karel Zak

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).