misc-utils/findmnt.8.adoc

   1 //po4a: entry man manual
   2 = findmnt(8)
   3 :doctype: manpage
   4 :man manual: System Administration
   5 :man source: util-linux {release-version}
   6 :page-layout: base
   7 :command: findmnt
   8 :plus: +
   9
  10 == NAME
  11
  12 findmnt - find a filesystem
  13
  14 == SYNOPSIS
  15
  16 *findmnt* [options]
  17
  18 *findmnt* [options] _device_|_mountpoint_
  19
  20 *findmnt* [options] [*--source*] _device_ [*--target* _path_|*--mountpoint* _mountpoint_]
  21
  22 == DESCRIPTION
  23
  24 *findmnt* will list all mounted filesystems or search for a filesystem. The *findmnt* command is able to search in _/etc/fstab_, _/etc/mtab_ or _/proc/self/mountinfo_. If _device_ or _mountpoint_ is not given, all filesystems are shown.
  25
  26 The device may be specified by device name, major:minor numbers, filesystem label or UUID, or partition label or UUID. Note that *findmnt* follows *mount*(8) behavior where a device name may be interpreted as a mountpoint (and vice versa) if the *--target*, *--mountpoint* or *--source* options are not specified.
  27
  28 The command-line option *--target* accepts any file or directory and then *findmnt* displays the filesystem for the given path.
  29
  30 The command prints all mounted filesystems in the tree-like format by default. The default output, is subject to change. So whenever possible, you should avoid using default output in your scripts. Always explicitly define expected columns by using *--output columns-list* in environments where a stable output is required.
  31
  32 The relationship between block devices and filesystems is not always one-to-one. The filesystem may use more block devices. This is why *findmnt* provides  SOURCE and SOURCES (pl.) columns. The column SOURCES displays all devices where it is possible to find the same filesystem  UUID (or another tag specified in _fstab_ when executed with *--fstab* and *--evaluate*).
  33
  34 == OPTIONS
  35
  36 *-A*, *--all*::
  37 Disable all built-in filters and print all filesystems.
  38
  39 *-a*, *--ascii*::
  40 Use ascii characters for tree formatting.
  41
  42 *-b*, *--bytes*::
  43 include::man-common/in-bytes.adoc[]
  44
  45 *-C*, *--nocanonicalize*::
  46 Do not canonicalize paths at all. This option affects the comparing of paths and the evaluation of tags (LABEL, UUID, etc.).
  47
  48 *-c*, *--canonicalize*::
  49 Canonicalize all printed paths.
  50
  51 *--deleted*::
  52 Print filesystems where target (mountpoint) is marked as deleted by kernel.
  53
  54 *-D*, *--df*::
  55 Imitate the output of *df*(1). This option is equivalent to *-o SOURCE,FSTYPE,SIZE,USED,AVAIL,USE%,TARGET* but excludes all pseudo filesystems. Use *--all* to print all filesystems.
  56
  57 *-d*, *--direction* _word_::
  58 The search direction, either *forward* or *backward*.
  59
  60 *-e*, *--evaluate*::
  61 Convert all tags (LABEL, UUID, PARTUUID, or PARTLABEL) to the corresponding device names for the SOURCE column.  It's an unusual situation, but the same tag may be duplicated (used for more devices). For this purpose, there is SOURCES (pl.) column. This column displays by multi-line cell all devices where the tag is detected by libblkid. This option makes sense for _fstab_ only.
  62
  63 *-F*, *--tab-file* _path_::
  64 Search in an alternative file. If used with *--fstab*, *--mtab* or *--kernel*, then it overrides the default paths. If specified more than once, then tree-like output is disabled (see the *--list* option).
  65
  66 *-f*, *--first-only*::
  67 Print the first matching filesystem only.
  68
  69 *-H*, *--list-columns*::
  70 List the available columns, use with *--json* or *--raw* to get output in machine-readable format.
  71
  72 *-i*, *--invert*::
  73 Invert the sense of matching.
  74
  75 *-J*, *--json*::
  76 Use JSON output format.
  77
  78 *-k*, *--kernel*::
  79 Search in _/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 *--mtab*).
  80
  81 *-l*, *--list*::
  82 Use the list output format. This output format is automatically enabled if the output is restricted by the *-t*, *-O*, *-S* or *-T* option and the option *--submounts* is not used or if more that one source file (the option *-F*) is specified.
  83
  84 *-M*, *--mountpoint* _path_::
  85 Explicitly define the mountpoint file or directory. See also *--target*.
  86
  87 *-m*, *--mtab*::
  88 Search in _/etc/mtab_. The output is in the list format by default (see *--tree*). The output may include user space mount options.
  89
  90 *-N*, *--task* _tid_::
  91 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 *--list* option). See also the *unshare*(1) command.
  92
  93 *-n*, *--noheadings*::
  94 Do not print a header line.
  95
  96 *-O*, *--options* _list_::
  97 Limit the set of printed filesystems. More than one option may be specified in a comma-separated list. The *-t* and *-O* options are cumulative in effect. It is different from *-t* in that each option is matched exactly; a leading _no_ 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 "{plus}" prefix.
  98 //TRANSLATORS: Keep {plus} untranslated.
  99
 100 *-o*, *--output* _list_::
 101 Define output columns. See the *--help* output to get a list of the currently supported columns. The *TARGET* column contains tree formatting if the *--list* or *--raw* options are not specified.
 102 +
 103 The default list of columns may be extended if _list_ is specified in the format _{plus}list_ (e.g., *findmnt -o {plus}PROPAGATION*).
 104 //TRANSLATORS: Keep {plus} untranslated.
 105
 106 *--output-all*::
 107 Output almost all available columns. The columns that require *--poll* are not included.
 108
 109 *-P*, *--pairs*::
 110 Produce output in the form of key="value" pairs. All potentially unsafe value characters are hex-escaped (\x<code>). See also option *--shell*.
 111 +
 112 Note that SOURCES column, use multi-line cells. In these cases, the column use an array-like formatting in the output, for example *name=("aaa" "bbb" "ccc")*.
 113
 114 *-p*, *--poll*[_=list_]::
 115 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.
 116 +
 117 The time for which *--poll* will block can be restricted with the *--timeout* or *--first-only* options.
 118 +
 119 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 *findmnt*. The poll mode allows using extra columns:
 120 +
 121 *ACTION*;;
 122 mount, umount, move or remount action name; this column is enabled by default
 123 *OLD-TARGET*;;
 124 available for umount and move actions
 125 *OLD-OPTIONS*;;
 126 available for umount and remount actions
 127
 128 *--pseudo*::
 129 Print only pseudo filesystems.
 130
 131 *--shadow*::
 132 Print only filesystems over-mounted by another filesystem.
 133
 134 *-R*, *--submounts*::
 135 Print recursively all submounts for the selected filesystems. The restrictions defined by options *-t*, *-O*, *-S*, *-T* and *--direction* 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 *--mtab* or *--fstab*.
 136
 137 *-r*, *--raw*::
 138 Use raw output format. All potentially unsafe characters are hex-escaped (\x<code>).
 139 +
 140 Note that column SOURCES, use multi-line cells. In these cases, the column may produce more strings on the same line.
 141
 142 *--real*::
 143 Print only real filesystems.
 144
 145 *-S*, *--source* _spec_::
 146 Explicitly define the mount source. Supported specifications are _device_, __maj__**:**_min_, **LABEL=**__label__, **UUID=**__uuid__, **PARTLABEL=**__label__ and **PARTUUID=**__uuid__.
 147
 148 *-s*, *--fstab*::
 149 Search in _/etc/fstab_. The output is in the list format (see *--list*).
 150
 151 *-T*, *--target* _path_::
 152 Define the mount target. If _path_ is not a mountpoint file or directory, then *findmnt* checks the _path_ elements in reverse order to get the mountpoint (this feature is supported only when searching in kernel files and unsupported for *--fstab*). It's recommended to use the option *--mountpoint* when checks of _path_ elements are unwanted and _path_ is a strictly specified mountpoint.
 153
 154 *-t*, *--types* _list_::
 155 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 *no* to specify the filesystem types on which no action should be taken. For more details see *mount*(8).
 156
 157 *--tree*::
 158 Enable tree-like output if possible. The options is silently ignored for tables where is missing child-parent relation (e.g., _fstab_).
 159
 160 *--shadowed*::
 161 Print only filesystems over-mounted by another filesystem.
 162
 163 *-U*, *--uniq*::
 164 Ignore filesystems with duplicate mount targets, thus effectively skipping over-mounted mount points.
 165
 166 *-u*, *--notruncate*::
 167 Do not truncate text in columns. The default is to not truncate the *TARGET*, *SOURCE*, *UUID*, *LABEL*, *PARTUUID*, *PARTLABEL* columns. This option disables text truncation also in all other columns.
 168
 169 *-v*, *--nofsroot*::
 170 Do not print a [/dir] in the SOURCE column for bind mounts or btrfs subvolumes.
 171
 172 *-w*, *--timeout* _milliseconds_::
 173 Specify an upper limit on the time for which *--poll* will block, in milliseconds.
 174
 175 *-x*, *--verify*::
 176 Check mount table content. The default is to verify _/etc/fstab_ parsability and usability. It's possible to use this option also with *--tab-file*. It's possible to specify source (device) or target (mountpoint) to filter mount table. The option *--verbose* forces *findmnt* to print more details.
 177
 178 *--verbose*::
 179 Force *findmnt* to print more information (*--verify* only for now).
 180
 181 *--vfs-all*::
 182 When used with *VFS-OPTIONS* column, print all VFS (fs-independent) flags. This option is designed for auditing purposes to list also default VFS kernel mount options which are normally not listed.
 183
 184 *-y*, *--shell*::
 185 The column name will be modified to contain only characters allowed for shell variable identifiers. This is usable, for example, with *--pairs*. Note that this feature has been automatically enabled for *--pairs* in version 2.37, but due to compatibility issues, now it's necessary to request this behavior by *--shell*.
 186
 187 include::man-common/help-version.adoc[]
 188
 189 == EXIT STATUS
 190
 191 The exit value is 0 if there is something to display, or 1 on any error
 192 (for example if no filesystem is found based on the user's filter
 193 specification, or the device path or mountpoint does not exist).
 194
 195 == ENVIRONMENT
 196
 197 *LIBMOUNT_FSTAB*=<path>::
 198 overrides the default location of the _fstab_ file
 199
 200 *LIBMOUNT_MTAB*=<path>::
 201 overrides the default location of the _mtab_ file
 202
 203 *LIBMOUNT_DEBUG*=all::
 204 enables libmount debug output
 205
 206 *LIBSMARTCOLS_DEBUG*=all::
 207 enables libsmartcols debug output
 208
 209 *LIBSMARTCOLS_DEBUG_PADDING*=on::
 210 use visible padding characters.
 211
 212 == EXAMPLES
 213
 214 *findmnt --fstab -t nfs*::
 215 Prints all NFS filesystems defined in _/etc/fstab_.
 216
 217 *findmnt --fstab /mnt/foo*::
 218 Prints all _/etc/fstab_ filesystems where the mountpoint directory is _/mnt/foo_. It also prints bind mounts where _/mnt/foo_ is a source.
 219
 220 *findmnt --fstab --target /mnt/foo*::
 221 Prints all _/etc/fstab_ filesystems where the mountpoint directory is _/mnt/foo_.
 222
 223 *findmnt --fstab --evaluate*::
 224 Prints all _/etc/fstab_ filesystems and converts LABEL= and UUID= tags to the real device names.
 225
 226 *findmnt -n --raw --evaluate --output=target LABEL=/boot*::
 227 Prints only the mountpoint where the filesystem with label "/boot" is mounted.
 228
 229 *findmnt --poll --mountpoint /mnt/foo*::
 230 Monitors mount, unmount, remount and move on _/mnt/foo_.
 231
 232 *findmnt --poll=umount --first-only --mountpoint /mnt/foo*::
 233 Waits for _/mnt/foo_ unmount.
 234
 235 *findmnt --poll=remount -t ext3 -O ro*::
 236 Monitors remounts to read-only mode on all ext3 filesystems.
 237
 238 == AUTHORS
 239
 240 mailto:kzak@redhat.com[Karel Zak]
 241
 242 == SEE ALSO
 243
 244 *fstab*(5),
 245 *mount*(8)
 246
 247 include::man-common/bugreports.adoc[]
 248
 249 include::man-common/footer.adoc[]
 250
 251 ifdef::translation[]
 252 include::man-common/translation.adoc[]
 253 endif::[]