summaryrefslogtreecommitdiffstats
path: root/misc-utils/findmnt.8
diff options
context:
space:
mode:
authorBenno Schulenberg2013-03-04 21:01:29 +0100
committerKarel Zak2013-03-20 14:08:03 +0100
commit4b44c245dd4de622fcd560275e8b648be5687752 (patch)
treeade7edb4a8eebe63222282150db34a75ca0dbb53 /misc-utils/findmnt.8
parentdocs: sort the options in findmnt man page alphabetically (diff)
downloadkernel-qcow2-util-linux-4b44c245dd4de622fcd560275e8b648be5687752.tar.gz
kernel-qcow2-util-linux-4b44c245dd4de622fcd560275e8b648be5687752.tar.xz
kernel-qcow2-util-linux-4b44c245dd4de622fcd560275e8b648be5687752.zip
docs: normalize formatting of findmnt man page
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
Diffstat (limited to 'misc-utils/findmnt.8')
-rw-r--r--misc-utils/findmnt.884
1 files changed, 56 insertions, 28 deletions
diff --git a/misc-utils/findmnt.8 b/misc-utils/findmnt.8
index 429c0fa75..407636ea4 100644
--- a/misc-utils/findmnt.8
+++ b/misc-utils/findmnt.8
@@ -38,58 +38,74 @@ are not specified.
.PP
The command prints all mounted filesystems in the tree-like format by default.
.SH OPTIONS
-.IP "\fB\-A, \-\-all\fP"
+.TP
+.BR \-A , " \-\-all"
Disable all built-in filters and print all filesystems.
-.IP "\fB\-a, \-\-ascii\fP"
+.TP
+.BR \-a , " \-\-ascii"
Use ascii characters for tree formatting.
-.IP "\fB\-c, \-\-canonicalize\fP"
+.TP
+.BR \-c , " \-\-canonicalize"
Canonicalize all printed paths.
-.IP "\fB\-D, \-\-df\fP"
+.TP
+.BR \-D , " \-\-df"
Imitate the output of
.BR df (1).
This option is equivalent to
.B -o SOURCE,FSTYPE,SIZE,USED,AVAIL,USE%,TARGET
but excludes all pseudo filesystems.
Use \fB\-\-all\fP to print all filesystems.
-.IP "\fB\-d, \-\-direction \fIword\fP"
+.TP
+.BR \-d , " \-\-direction \fIword\fP"
The search direction, either
.IR forward
or
.IR backward .
-.IP "\fB\-e, \-\-evaluate\fP"
+.TP
+.BR \-e , " \-\-evaluate"
Convert all tags (LABEL, UUID, PARTUUID or PARTLABEL) to the device names.
-.IP "\fB\-F, \-\-tab\-file \fIpath\fP"
+.TP
+.BR \-F , " \-\-tab\-file \fIpath\fP"
Search in an alternative file. If used with \fB\-\-fstab\fP, \fB\-\-mtab\fP
or \fB\-\-kernel\fP, then it overrides the default paths. If specified more
than once, then tree-like output is disabled (see the \fB\-\-list\fP option).
-.IP "\fB\-f, \-\-first\-only\fP"
+.TP
+.BR \-f , " \-\-first\-only"
Print the first matching filesystem only.
-.IP "\fB\-h, \-\-help\fP"
+.TP
+.BR \-h , " \-\-help"
Print help and exit.
-.IP "\fB\-i, \-\-invert\fP"
+.TP
+.BR \-i , " \-\-invert"
Invert the sense of matching.
-.IP "\fB\-k, \-\-kernel\fP"
+.TP
+.BR \-k , " \-\-kernel"
Search in
.IR /proc/self/mountinfo .
The output is in the tree-like format. This is the default.
-.IP "\fB\-l, \-\-list\fP"
+.TP
+.BR \-l , " \-\-list"
Use the list output format. This output format is automatically enabled if the
output is restricted by the \fB\-t\fP, \fB\-O\fP, \fB\-S\fP or \fB\-T\fP
option and the option \fB\-\-submounts\fP is not used or if more that one
source file (the option \fB\-F\fP) is specified.
-.IP "\fB\-m, \-\-mtab\fP"
+.TP
+.BR \-m , " \-\-mtab"
Search in
.IR /etc/mtab .
The output is in the list format (see \fB\-\-list\fP).
-.IP "\fB\-N, \-\-task \fItid\fP"
+.TP
+.BR \-N , " \-\-task \fItid\fP"
Use alternative namespace /proc/<tid>/mountinfo rather than the default
/proc/self/mountinfo. If the option is specified more than once, then
tree-like output is disabled (see the \fB\-\-list\fP option). See also the
.BR unshare (1)
command.
-.IP "\fB\-n, \-\-noheadings\fP"
+.TP
+.BR \-n , " \-\-noheadings"
Do not print a header line.
-.IP "\fB\-O, \-\-options \fIlist\fP"
+.TP
+.BR \-O , " \-\-options \fIlist\fP"
Limit the set of printed filesystems. More than one option
may be specified in a comma-separated list. The
.B \-t
@@ -102,7 +118,8 @@ in that each option is matched exactly; a leading
at the beginning does not have global meaning. The "no" can used for
individual items in the list. The "no" prefix interpretation can be disabled
by "+" prefix.
-.IP "\fB\-o, \-\-output \fIlist\fP"
+.TP
+.BR \-o , " \-\-output \fIlist\fP"
Define output columns. See the \fB\-\-help\fP output to get a list of the
currently supported columns. The
.BR TARGET
@@ -114,9 +131,11 @@ options are not specified.
The default list of columns may be extended if \fIlist\fP is
specified in the format \fI+list\fP (e.g. \fBfindmnt -o +PROPAGATION\fP).
-.IP "\fB\-P, \-\-pairs\fP"
+.TP
+.BR \-P , " \-\-pairs"
Use key="value" output format. All potentially unsafe characters are hex-escaped (\\x<code>).
-.IP "\fB\-p, \-\-poll\fR[\fI=list\fR]\fP"
+.TP
+.BR \-p , " \-\-poll\fR[\fI=list\fR]"
Monitor changes in the /proc/self/mountinfo file. Supported actions are: mount,
umount, remount and move. More than one action may be specified in a
comma-separated list. All actions are monitored by default.
@@ -140,24 +159,30 @@ available for umount and move actions
.B OLD-OPTIONS
available for umount and remount actions
.RE
-.IP "\fB\-R, \-\-submounts\fP"
+.TP
+.BR \-R , " \-\-submounts"
Print recursively all submounts for the selected filesystems. The restrictions
defined by options \fB\-t\fP, \fB\-O\fP, \fB\-S\fP, \fB\-T\fP and
\fB\--direction\fP are not applied to submounts. All submounts are always
printed in tree-like order. The option enables the tree-like output format by
default. This option has no effect for \fB\-\-mtab\fP or \fB\-\-fstab\fP.
-.IP "\fB\-r, \-\-raw\fP"
+.TP
+.BR \-r , " \-\-raw"
Use raw output format. All potentially unsafe characters are hex-escaped (\\x<code>).
-.IP "\fB\-S, \-\-source \fIspec\fP"
+.TP
+.BR \-S , " \-\-source \fIspec\fP"
Explicitly define the mount source. Supported are \fIdevice\fR, \fImaj:min\fR,
\fILABEL=\fR, \fIUUID=\fR, \fIPARTLABEL=\fR or \fIPARTUUID=\fR.
-.IP "\fB\-s, \-\-fstab\fP"
+.TP
+.BR \-s , " \-\-fstab"
Search in
.IR /etc/fstab .
The output is in the list format (see \fB--list\fR).
-.IP "\fB\-T, \-\-target \fIdir\fP"
+.TP
+.BR \-T , " \-\-target \fIdir\fP"
Explicitly define the mount target (mountpoint directory).
-.IP "\fB\-t, \-\-types \fIlist\fP"
+.TP
+.BR \-t , " \-\-types \fIlist\fP"
Limit the set of printed filesystems. More than one type may be
specified in a comma-separated list. The list of filesystem types can be
prefixed with
@@ -165,7 +190,8 @@ prefixed with
to specify the filesystem types on which no action should be taken. For
more details see
.BR mount (8).
-.IP "\fB\-u, \-\-notruncate\fP"
+.TP
+.BR \-u , " \-\-notruncate"
Do not truncate text in columns. The default is to not truncate the
.BR TARGET ,
.BR SOURCE ,
@@ -174,9 +200,11 @@ Do not truncate text in columns. The default is to not truncate the
.BR PARTUUID ,
.BR PARTLABEL
columns. This option disables text truncation also in all other columns.
-.IP "\fB\-v, \-\-nofsroot\fP"
+.TP
+.BR \-v , " \-\-nofsroot"
Do not print a [/dir] in the SOURCE column for bind-mounts or btrfs subvolumes.
-.IP "\fB\-w, \-\-timeout \fImilliseconds\fP"
+.TP
+.BR \-w , " \-\-timeout \fImilliseconds\fP"
Specify an upper limit on the time for which \fB--poll\fR will block, in milliseconds.
.SH EXAMPLES
.IP "\fBfindmnt \-\-fstab \-t nfs\fP"