]> git.ipfire.org Git - thirdparty/util-linux.git/blobdiff - misc-utils/findmnt.8
Manual pages: order NOTES / HISTORY / BUGS / EXAMPLE consistently
[thirdparty/util-linux.git] / misc-utils / findmnt.8
index 1dc6a8837f4d7b0229064adf20f2acf0263f5a2a..1287934515f58ccde9f4639379f4cf4190ca5afc 100644 (file)
-.\" -*- nroff -*-
-.TH FINDMNT 8 "April 2010" "util-linux" "System Administration"
+.TH FINDMNT 8 "May 2018" "util-linux" "System Administration"
 .SH NAME
 findmnt \- find a filesystem
 .SH SYNOPSIS
 .B findmnt
-.RB [ options ]
+[options]
 .sp
 .B findmnt
-.RB [ options ]
+[options]
 .IR device | mountpoint
 .sp
 .B findmnt
-.RB [ options ]
-.RB [ \--source ]
-.IR device
-.RB [ \--target ]
-.IR mountpoint
+[options]
+.RB [ \-\-source ]
+.I device
+.RB [ \-\-target | \-\-mountpoint ]
+.I mountpoint
 .SH DESCRIPTION
 .B findmnt
-will list all mounted filesytems or search for a filesystem.  The
-.B findmnt
+will list all mounted filesystems or search for a filesystem.  The
+.B \%findmnt
 command is able to search in
 .IR /etc/fstab ,
-.IR /etc/mtab
+.I /etc/mtab
 or
 .IR /proc/self/mountinfo .
 If
-.IR device
+.I device
 or
-.IR mountpoint
+.I mountpoint
 is not given, all filesystems are shown.
 .PP
-The device may be specified by device name, maj:min, filesystem LABEL or UUID
-or partition PARTUUID or PARTLABEL.  Note that device name may be interpreted
-as mountpoint (and vice versa) if --target or --source options are not
-specified.
+The device may be specified by device name, major:minor numbers,
+filesystem label or UUID, or partition label or UUID.  Note that
+.B \%findmnt
+follows
+.BR mount (8)
+behavior where a device name may be interpreted
+as a mountpoint (and vice versa) if the \fB\-\-target\fR, \fB\-\-mountpoint\fR or
+\fB\-\-source\fR options are not specified.
 .PP
 The command prints all mounted filesystems in the tree-like format by default.
 .SH OPTIONS
-.IP "\fB\-h, \-\-help\fP"
-Print help and exit.
-.IP "\fB\-s, \-\-fstab\fP"
-Search in
-.IR /etc/fstab .
-The output is in the list format (see --list).
-.IP "\fB\-m, \-\-mtab\fP"
-Search in
-.IR /etc/mtab .
-The output is in the list format (see \fB\-\-list\fP).
-.IP "\fB\-k, \-\-kernel\fP"
-Search in
-.IR /proc/self/mountinfo .
-The output is in the tree-like format.  This is the default.
-
-.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 \-b , " \-\-bytes"
+Print the SIZE, USED and AVAIL columns in bytes rather than in a human-readable format.
+.TP
+.BR \-C , " \-\-nocanonicalize"
+Do not canonicalize paths at all.  This option affects the comparing of paths
+and the evaluation of tags (LABEL, UUID, etc.).
+.TP
+.BR \-c , " \-\-canonicalize"
 Canonicalize all printed paths.
-.IP "\fB\-D, \-\-df\fP"
-Imitate the output of df(1). This option is equivalent to
-"-o SOURCE,FSTYPE,SIZE,USED,AVAIL,USE%,TARGET", but excludes all
-pseudo filesystem. Use \fB\-\-all\fP to print all filesystems.
-.IP "\fB\-d, \-\-direction \fIword\fP"
-The search direction -
-.IR forward
+.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.
+.TP
+.BR \-d , " \-\-direction \fIword\fP"
+The search direction, either
+.B forward
 or
-.IR backward .
-.IP "\fB\-e, \-\-evaluate\fP"
-Convert all tags (LABEL, UUID, PARTUUID or PARTLABEL) to the device names.
-.IP "\fB\-F, \-\-tab\-file \fIpath\fP"
-Search in an alternative file, if used with \fB\-\-fstab\fP, \fB\-\-mtab\fP
-or \fB\-\-kernel\fP then overwrites 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"
+.BR backward .
+.TP
+.BR \-e , " \-\-evaluate"
+Convert all tags (LABEL, UUID, PARTUUID or PARTLABEL) to the corresponding device names.
+.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).
+.TP
+.BR \-f , " \-\-first\-only"
 Print the first matching filesystem only.
-.IP "\fB\-i, \-\-invert\fP"
+.TP
+.BR \-h , " \-\-help"
+Display help text and exit.
+.TP
+.BR \-i , " \-\-invert"
 Invert the sense of matching.
-.IP "\fB\-l, \-\-list\fP"
-Use the list output format. This output format is automatically enabled if the
-output is restricted by \fB\-t\fP, \fB\-O\fP, \fB\-S\fP or \fB\-T\fP
+.TP
+.BR \-J , " \-\-json"
+Use JSON output format.
+.TP
+.BR \-k , " \-\-kernel"
+Search in
+.IR /proc/self/mountinfo .
+The output is in the tree-like format.  This is the default.  The output
+contains only mount options maintained by kernel (see also \fB\-\-mtab)\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\-v, \-\-nofsroot\fP"
-Do not print a [/dir] in the SOURCE column for bind-mounts or btrfs subvolumes.
-.IP "\fB\-N, \-\-task \fItid\fP"
+.TP
+.BR \-M , " \-\-mountpoint \fIpath\fP"
+Explicitly define the mountpoint file or directory.  See also \fB\-\-target\fP.
+.TP
+.BR \-m , " \-\-mtab"
+Search in
+.IR /etc/mtab .
+The output is in the list format by default (see \fB\-\-tree\fP).  The output may include user
+space mount options.
+.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
+/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\-u, \-\-notruncate\fP"
-Do not truncate text in columns.  The default is to not truncate the
-.BR TARGET ,
-.BR SOURCE ,
-.BR UUID ,
-.BR LABEL ,
-.BR PARTUUID ,
-.BR PARTLABEL
-columns.  This option disables text truncation also in all other columns.
-.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
@@ -112,33 +133,43 @@ options are cumulative in effect.  It is different from
 .B \-t
 in that each option is matched exactly; a leading
 .I no
-at the beginning does not have global meaning. The "no" could used for
-individual items in the list. The "no" prefix interpratation could be disabled
+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"
-Define output columns. See the \fB\-\-help\fP output to get list of the
-currently supported columns. The
-.BR TARGET
+.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
+.B TARGET
 column contains tree formatting if the
 .B \-\-list
 or
 .B \-\-raw
 options are not specified.
 
-The default list of the columns maybe be extended if the \fIlist\fP is
-specified in format +<list> (e.g. findmnt -o +PROPAGATION).
-.IP "\fB\-p, \-\-poll\fR[\fI=list\fR]\fP"
-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.
+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).
+.TP
+.B \-\-output\-all
+Output almost all available columns.  The columns that require
+.B \-\-poll
+are not included.
+.TP
+.BR \-P , " \-\-pairs"
+Use key="value" output format.  All potentially unsafe characters are hex-escaped (\\x<code>).
+.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.
 
-The time for which \fB--poll\fR will block can be restricted with the \fB\-\-timeout\fP
-or \fB\-\-first-only\fP options.
+The time for which \fB\-\-poll\fR will block can be restricted with the \fB\-\-timeout\fP
+or \fB\-\-first\-only\fP options.
 
 The standard columns always use the new version of the information from the
 mountinfo file, except the umount action which is based on the original
 information cached by
-.BR findmnt (8) .
+.BR findmnt (8).
 The poll mode allows to use extra columns:
 .RS
 .TP
@@ -151,70 +182,127 @@ available for umount and move actions
 .B OLD-OPTIONS
 available for umount and remount actions
 .RE
-.IP "\fB\-P, \-\-pairs\fP"
-Use key="value" output format. All potentially unsafe characters are hex-escaped (\\x<code>).
-.IP "\fB\-r, \-\-raw\fP"
-Use raw output format. All potentially unsafe characters are hex-escaped (\\x<code>).
-.IP "\fB\-t, \-\-types \fIlist\fP"
+.TP
+.B \-\-pseudo
+Print only pseudo filesystems.
+.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.
+.TP
+.BR \-r , " \-\-raw"
+Use raw output format.  All potentially unsafe characters are hex-escaped (\\x<code>).
+.TP
+.B \-\-real
+Print only real filesystems.
+.TP
+.BR \-S , " \-\-source \fIspec\fP"
+Explicitly define the mount source.  Supported specifications are \fIdevice\fR,
+\fImaj\fB:\fImin\fR, \fBLABEL=\fIlabel\fR, \fBUUID=\fIuuid\fR,
+\fBPARTLABEL=\fIlabel\fR and \fBPARTUUID=\fIuuid\fR.
+.TP
+.BR \-s , " \-\-fstab"
+Search in
+.IR /etc/fstab .
+The output is in the list format (see \fB\-\-list\fR).
+.TP
+.BR \-T , " \-\-target \fIpath\fP"
+Define the mount target.  If \fIpath\fR
+is not a mountpoint file or directory, then
+.B findmnt
+checks the \fIpath\fR elements in reverse order to get the mountpoint (this feature is
+supported only when searching in kernel files and unsupported for \fB\-\-fstab\fP).  It's
+recommended to use the option \fB\-\-mountpoint\fR when checks of \fIpath\fR elements are
+unwanted and \fIpath\fR is a strictly specified mountpoint.
+.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
-.I no
+.B no
 to specify the filesystem types on which no action should be taken.  For
 more details see
 .BR mount (8).
-.IP "\fB\-R, \-\-submounts\fP"
-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\-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\-T, \-\-target \fIdir\fP"
-Explicitly define the mount target (mountpoint directory).
-.IP "\fB\-w, \-\-timeout \fImilliseconds\fP"
-Specify an upper limit on the time for which \fB--poll\fR will block, in milliseconds.
-.SH EXAMPLES
+.TP
+.B \-\-tree
+Enable tree-like output if possible.  The options is silently ignored for
+tables where is missing child-parent relation (e.g., fstab).
+.TP
+.BR \-U , " \-\-uniq"
+Ignore filesystems with duplicate mount targets, thus effectively skipping
+over-mounted mount points.
+.TP
+.BR \-u , " \-\-notruncate"
+Do not truncate text in columns.  The default is to not truncate the
+.BR TARGET ,
+.BR SOURCE ,
+.BR UUID ,
+.BR LABEL ,
+.BR PARTUUID ,
+.B PARTLABEL
+columns.  This option disables text truncation also in all other columns.
+.TP
+.BR \-v , " \-\-nofsroot"
+Do not print a [/dir] in the SOURCE column for bind mounts or btrfs subvolumes.
+.TP
+.BR \-w , " \-\-timeout \fImilliseconds\fP"
+Specify an upper limit on the time for which \fB\-\-poll\fR will block, in milliseconds.
+.TP
+.BR \-x , " \-\-verify"
+Check mount table content. The default is to verify
+.I /etc/fstab
+parsability and usability. It's possible to use this option also with \fB\-\-tab\-file\fP.
+It's possible to specify source (device) or target (mountpoint) to filter mount table. The option
+\fB\-\-verbose\fP forces findmnt to print more details.
+.TP
+.B \-\-verbose
+Force findmnt to print more information (\fB\-\-verify\fP only for now).
+.SH ENVIRONMENT
+.IP LIBMOUNT_FSTAB=<path>
+overrides the default location of the fstab file
+.IP LIBMOUNT_MTAB=<path>
+overrides the default location of the mtab file
+.IP LIBMOUNT_DEBUG=all
+enables libmount debug output
+.IP LIBSMARTCOLS_DEBUG=all
+enables libsmartcols debug output
+.IP LIBSMARTCOLS_DEBUG_PADDING=on
+use visible padding characters. Requires enabled LIBSMARTCOLS_DEBUG.
+.SH EXAMPLE
 .IP "\fBfindmnt \-\-fstab \-t nfs\fP"
-Prints all nfs filesystems defined in
+Prints all NFS filesystems defined in
 .IR /etc/fstab .
 .IP "\fBfindmnt \-\-fstab /mnt/foo\fP"
 Prints all
-.IR /etc/fstab
+.I /etc/fstab
 filesystems where the mountpoint directory is /mnt/foo.  It also prints bind mounts where /mnt/foo
 is a source.
-.IP "\fBfindmnt \-\-fstab --target /mnt/foo\fP"
+.IP "\fBfindmnt \-\-fstab \-\-target /mnt/foo\fP"
 Prints all
-.IR /etc/fstab
+.I /etc/fstab
 filesystems where the mountpoint directory is /mnt/foo.
-.IP "\fBfindmnt --fstab --evaluate\fP"
+.IP "\fBfindmnt \-\-fstab \-\-evaluate\fP"
 Prints all
-.IR /etc/fstab
+.I /etc/fstab
 filesystems and converts LABEL= and UUID= tags to the real device names.
-.IP "\fBfindmnt -n --raw --evaluate --output=target LABEL=/boot\fP"
+.IP "\fBfindmnt \-n \-\-raw \-\-evaluate \-\-output=target LABEL=/boot\fP"
 Prints only the mountpoint where the filesystem with label "/boot" is mounted.
-.IP "\fBfindmnt --poll --target /mnt/foo\fP"
-Monitors mount, umount, remount and move on /mnt/foo.
-.IP "\fBfindmnt --poll=umount --first-only --target /mnt/foo\fP"
-Waits for /mnt/foo umount.
-.IP "\fBfindmnt --poll=remount -t ext3 -O ro\fP"
+.IP "\fBfindmnt \-\-poll \-\-mountpoint /mnt/foo\fP"
+Monitors mount, unmount, remount and move on /mnt/foo.
+.IP "\fBfindmnt \-\-poll=umount \-\-first-only \-\-mountpoint /mnt/foo\fP"
+Waits for /mnt/foo unmount.
+.IP "\fBfindmnt \-\-poll=remount \-t ext3 \-O ro\fP"
 Monitors remounts to read-only mode on all ext3 filesystems.
-.SH ENVIRONMENT
-.IP LIBMOUNT_FSTAB=<path>
-overrides the default location of the fstab file
-.IP LIBMOUNT_MTAB=<path>
-overrides the default location of the mtab file
-.IP LIBMOUNT_DEBUG=0xffff
-enables debug output
 .SH AUTHORS
 .nf
 Karel Zak <kzak@redhat.com>
 .fi
 .SH SEE ALSO
-.BR mount (8),
-.BR fstab (5)
+.BR fstab (5),
+.BR mount (8)
 .SH AVAILABILITY
 The findmnt command is part of the util-linux package and is available from
-ftp://ftp.kernel.org/pub/linux/utils/util-linux/.
+https://www.kernel.org/pub/linux/utils/util-linux/.