]> git.ipfire.org Git - thirdparty/util-linux.git/blob - misc-utils/findmnt.8.adoc
build-sys: make man pages location independent
[thirdparty/util-linux.git] / 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.
31
32 == OPTIONS
33
34 *-A*, *--all*::
35 Disable all built-in filters and print all filesystems.
36
37 *-a*, *--ascii*::
38 Use ascii characters for tree formatting.
39
40 *-b*, *--bytes*::
41 Print the SIZE, USED and AVAIL columns in bytes rather than in a human-readable format.
42
43 *-C*, *--nocanonicalize*::
44 Do not canonicalize paths at all. This option affects the comparing of paths and the evaluation of tags (LABEL, UUID, etc.).
45
46 *-c*, *--canonicalize*::
47 Canonicalize all printed paths.
48
49 *-D*, *--df*::
50 Imitate the output of df1. This option is equivalent to *-o SOURCE,FSTYPE,SIZE,USED,AVAIL,USE%,TARGET* but excludes all pseudo filesystems. Use *--all* to print all filesystems.
51
52 *-d*, *--direction* _word_::
53 The search direction, either *forward* or *backward*.
54
55 *-e*, *--evaluate*::
56 Convert all tags (LABEL, UUID, PARTUUID or PARTLABEL) to the corresponding device names.
57
58 *-F*, *--tab-file* _path_::
59 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).
60
61 *-f*, *--first-only*::
62 Print the first matching filesystem only.
63
64 *-h*, *--help*::
65 Display help text and exit.
66
67 *-i*, *--invert*::
68 Invert the sense of matching.
69
70 *-J*, *--json*::
71 Use JSON output format.
72
73 *-k*, *--kernel*::
74 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)*.
75
76 *-l*, *--list*::
77 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.
78
79 *-M*, *--mountpoint* _path_::
80 Explicitly define the mountpoint file or directory. See also *--target*.
81
82 *-m*, *--mtab*::
83 Search in _/etc/mtab_. The output is in the list format by default (see *--tree*). The output may include user space mount options.
84
85 *-N*, *--task* _tid_::
86 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.
87
88 *-n*, *--noheadings*::
89 Do not print a header line.
90
91 *-O*, *--options* _list_::
92 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.
93 //TRANSLATORS: Keep {plus} untranslated.
94
95 *-o*, *--output* _list_::
96 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.
97 +
98 The default list of columns may be extended if _list_ is specified in the format _{plus}list_ (e.g., *findmnt -o {plus}PROPAGATION*).
99 //TRANSLATORS: Keep {plus} untranslated.
100
101 *--output-all*::
102 Output almost all available columns. The columns that require *--poll* are not included.
103
104 *-P*, *--pairs*::
105 Produce output in the form of key="value" pairs. All potentially unsafe value characters are hex-escaped (\x<code>). The key (variable name) will be modified to contain only characters allowed for a shell variable identifiers, for example, FS_OPTIONS and USE_PCT instead of FS-OPTIONS and USE%.
106
107 *-p*, *--poll*[_=list_]::
108 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.
109 +
110 The time for which *--poll* will block can be restricted with the *--timeout* or *--first-only* options.
111 +
112 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:
113 +
114 *ACTION*;;
115 mount, umount, move or remount action name; this column is enabled by default
116 *OLD-TARGET*;;
117 available for umount and move actions
118 *OLD-OPTIONS*;;
119 available for umount and remount actions
120
121 *--pseudo*::
122 Print only pseudo filesystems.
123
124 *--shadow*::
125 Print only filesystems over-mounted by another filesystem.
126
127 *-R*, *--submounts*::
128 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*.
129
130 *-r*, *--raw*::
131 Use raw output format. All potentially unsafe characters are hex-escaped (\x<code>).
132
133 *--real*::
134 Print only real filesystems.
135
136 *-S*, *--source* _spec_::
137 Explicitly define the mount source. Supported specifications are _device_, __maj__**:**_min_, **LABEL=**__label__, **UUID=**__uuid__, **PARTLABEL=**__label__ and **PARTUUID=**__uuid__.
138
139 *-s*, *--fstab*::
140 Search in _/etc/fstab_. The output is in the list format (see *--list*).
141
142 *-T*, *--target* _path_::
143 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.
144
145 *-t*, *--types* _list_::
146 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).
147
148 *--tree*::
149 Enable tree-like output if possible. The options is silently ignored for tables where is missing child-parent relation (e.g., fstab).
150
151 *-U*, *--uniq*::
152 Ignore filesystems with duplicate mount targets, thus effectively skipping over-mounted mount points.
153
154 *-u*, *--notruncate*::
155 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.
156
157 *-v*, *--nofsroot*::
158 Do not print a [/dir] in the SOURCE column for bind mounts or btrfs subvolumes.
159
160 *-w*, *--timeout* _milliseconds_::
161 Specify an upper limit on the time for which *--poll* will block, in milliseconds.
162
163 *-x*, *--verify*::
164 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.
165
166 *--verbose*::
167 Force findmnt to print more information (*--verify* only for now).
168
169 *--vfs-all*::
170 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.
171
172 == ENVIRONMENT
173
174 LIBMOUNT_FSTAB=<path>::
175 overrides the default location of the fstab file
176
177 LIBMOUNT_MTAB=<path>::
178 overrides the default location of the mtab file
179
180 LIBMOUNT_DEBUG=all::
181 enables libmount debug output
182
183 LIBSMARTCOLS_DEBUG=all::
184 enables libsmartcols debug output
185
186 LIBSMARTCOLS_DEBUG_PADDING=on::
187 use visible padding characters. Requires enabled LIBSMARTCOLS_DEBUG.
188
189 == EXAMPLES
190
191 *findmnt --fstab -t nfs*::
192 Prints all NFS filesystems defined in _/etc/fstab_.
193
194 *findmnt --fstab /mnt/foo*::
195 Prints all _/etc/fstab_ filesystems where the mountpoint directory is _/mnt/foo_. It also prints bind mounts where _/mnt/foo_ is a source.
196
197 *findmnt --fstab --target /mnt/foo*::
198 Prints all _/etc/fstab_ filesystems where the mountpoint directory is _/mnt/foo_.
199
200 *findmnt --fstab --evaluate*::
201 Prints all _/etc/fstab_ filesystems and converts LABEL= and UUID= tags to the real device names.
202
203 *findmnt -n --raw --evaluate --output=target LABEL=/boot*::
204 Prints only the mountpoint where the filesystem with label "/boot" is mounted.
205
206 *findmnt --poll --mountpoint /mnt/foo*::
207 Monitors mount, unmount, remount and move on _/mnt/foo_.
208
209 *findmnt --poll=umount --first-only --mountpoint /mnt/foo*::
210 Waits for _/mnt/foo_ unmount.
211
212 *findmnt --poll=remount -t ext3 -O ro*::
213 Monitors remounts to read-only mode on all ext3 filesystems.
214
215 == AUTHORS
216
217 mailto:kzak@redhat.com[Karel Zak]
218
219 == SEE ALSO
220
221 *fstab*(5),
222 *mount*(8)
223
224 include::man-common/bugreports.adoc[]
225
226 include::man-common/footer.adoc[]
227
228 ifdef::translation[]
229 include::man-common/translation.adoc[]
230 endif::[]