]> git.ipfire.org Git - thirdparty/util-linux.git/blame - sys-utils/mount.8.adoc
mount: (man) add note about -o bind,rw
[thirdparty/util-linux.git] / sys-utils / mount.8.adoc
CommitLineData
295b3979 1//po4a: entry man manual
14179682
MB
2////
3Copyright (c) 1996-2004 Andries Brouwer
4Copyright (C) 2006-2012 Karel Zak <kzak@redhat.com>
5
6This page is somewhat derived from a page that was
7(c) 1980, 1989, 1991 The Regents of the University of California
8and had been heavily modified by Rik Faith and myself.
9(Probably no BSD text remains.)
10Fragments of text were written by Werner Almesberger, Remy Card,
11Stephen Tweedie and Eric Youngdale.
12
13This is free documentation; you can redistribute it and/or
14modify it under the terms of the GNU General Public License as
15published by the Free Software Foundation; either version 2 of
16the License, or (at your option) any later version.
17
18The GNU General Public License's references to "object code"
19and "executables" are to be interpreted as the output of any
20document formatting or typesetting system, including
21intermediate and printed output.
22
23This manual is distributed in the hope that it will be useful,
24but WITHOUT ANY WARRANTY; without even the implied warranty of
25MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26GNU General Public License for more details.
27
28You should have received a copy of the GNU General Public License along
29with this program; if not, write to the Free Software Foundation, Inc.,
3051 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
31////
32= mount(8)
33:doctype: manpage
a09649ca 34:man manual: System Administration
14179682
MB
35:man source: util-linux {release-version}
36:page-layout: base
37:command: mount
4eab78d3 38:asterisk: *
14179682
MB
39
40== NAME
41
42mount - mount a filesystem
43
44== SYNOPSIS
45
46*mount* [*-h*|*-V*]
e08e3d58 47
14179682
MB
48*mount* [*-l*] [*-t* _fstype_]
49
50*mount* *-a* [*-fFnrsvw*] [*-t* _fstype_] [*-O* _optlist_]
51
52*mount* [*-fnrsvw*] [*-o* _options_] _device_|_mountpoint_
53
54*mount* [*-fnrsvw*] [*-t* _fstype_] [*-o* _options_] _device mountpoint_
55
56*mount* *--bind*|*--rbind*|*--move* _olddir newdir_
57
141fbd76 58*mount* *--make-*[*shared*|*slave*|*private*|*unbindable*|*rshared*|*rslave*|*rprivate*|*runbindable*] _mountpoint_
14179682
MB
59
60== DESCRIPTION
61
b4c04b3d 62All files accessible in a Unix system are arranged in one big tree, the file hierarchy, rooted at _/_. These files can be spread out over several devices. The *mount* command serves to attach the filesystem found on some device to the big file tree. Conversely, the *umount*(8) command will detach it again. The filesystem is used to control how data is stored on the device or provided in a virtual way by network or other services.
14179682
MB
63
64The standard form of the *mount* command is:
65
66____
67*mount -t* _type device dir_
68____
69
70This tells the kernel to attach the filesystem found on _device_ (which is of type _type_) at the directory _dir_. The option *-t* _type_ is optional. The *mount* command is usually able to detect a filesystem. The root permissions are necessary to mount a filesystem by default. See section "Non-superuser mounts" below for more details. The previous contents (if any) and owner and mode of _dir_ become invisible, and as long as this filesystem remains mounted, the pathname _dir_ refers to the root of the filesystem on _device_.
71
72If only the directory or the device is given, for example:
73
74____
bd67ca44 75*mount* _/dir_
14179682
MB
76____
77
78then *mount* looks for a mountpoint (and if not found then for a device) in the _/etc/fstab_ file. It's possible to use the *--target* or *--source* options to avoid ambiguous interpretation of the given argument. For example:
79
80____
bd67ca44 81*mount --target* _/mountpoint_
14179682
MB
82____
83
84The same filesystem may be mounted more than once, and in some cases (e.g., network filesystems) the same filesystem may be mounted on the same mountpoint multiple times. The *mount* command does not implement any policy to control this behavior. All behavior is controlled by the kernel and it is usually specific to the filesystem driver. The exception is *--all*, in this case already mounted filesystems are ignored (see *--all* below for more details).
85
86=== Listing the mounts
87
88The listing mode is maintained for backward compatibility only.
89
90For more robust and customizable output use *findmnt*(8), *especially in your scripts*. Note that control characters in the mountpoint name are replaced with '?'.
91
92The following command lists all mounted filesystems (of type _type_):
93
94____
95*mount* [*-l*] [*-t* _type_]
96____
97
98The option *-l* adds labels to this listing. See below.
99
100=== Indicating the device and filesystem
101
102Most devices are indicated by a filename (of a block special device), like _/dev/sda1_, but there are other possibilities. For example, in the case of an NFS mount, _device_ may look like _knuth.cwi.nl:/dir_.
103
104The device names of disk partitions are unstable; hardware reconfiguration, and adding or removing a device can cause changes in names. This is the reason why it's strongly recommended to use filesystem or partition identifiers like UUID or LABEL. Currently supported identifiers (tags):
105
14179682 106LABEL=__label__::
4eab78d3
MB
107Human readable filesystem identifier. See also *-L*.
108
14179682 109UUID=__uuid__::
4eab78d3
MB
110Filesystem universally unique identifier. The format of the UUID is usually a series of hex digits separated by hyphens. See also *-U*.
111+
112Note that *mount* uses UUIDs as strings. The UUIDs from the command line or from *fstab*(5) are not converted to internal binary representation. The string representation of the UUID should be based on lower case characters.
113
14179682 114PARTLABEL=__label__::
bd67ca44 115Human readable partition identifier. This identifier is independent on filesystem and does not change by *mkfs* or *mkswap* operations. It's supported for example for GUID Partition Tables (GPT).
4eab78d3 116
14179682 117PARTUUID=__uuid__::
bd67ca44 118Partition universally unique identifier. This identifier is independent on filesystem and does not change by *mkfs* or *mkswap* operations. It's supported for example for GUID Partition Tables (GPT).
4eab78d3 119
14179682 120ID=__id__::
4eab78d3 121Hardware block device ID as generated by udevd. This identifier is usually based on WWN (unique storage identifier) and assigned by the hardware manufacturer. See *ls /dev/disk/by-id* for more details, this directory and running udevd is required. This identifier is not recommended for generic use as the identifier is not strictly defined and it depends on udev, udev rules and hardware.
14179682
MB
122
123The command *lsblk --fs* provides an overview of filesystems, LABELs and UUIDs on available block devices. The command *blkid -p <device>* provides details about a filesystem on the specified device.
124
125Don't forget that there is no guarantee that UUIDs and labels are really unique, especially if you move, share or copy the device. Use *lsblk -o +UUID,PARTUUID* to verify that the UUIDs are really unique in your system.
126
5723eae7 127The recommended setup is to use tags (e.g. *UUID*=_uuid_) rather than _/dev/disk/by-{label,uuid,id,partuuid,partlabel}_ udev symlinks in the _/etc/fstab_ file. Tags are more readable, robust and portable. The *mount*(8) command internally uses udev symlinks, so the use of symlinks in _/etc/fstab_ has no advantage over tags. For more details see *libblkid*(3).
14179682 128
4eab78d3 129The _proc_ filesystem is not associated with a special device, and when mounting it, an arbitrary keyword - for example, __proc__ - can be used instead of a device specification. (The customary choice _none_ is less fortunate: the error message 'none already mounted' from *mount* can be confusing.)
14179682
MB
130
131=== The files /etc/fstab, /etc/mtab and /proc/mounts
132
133The file _/etc/fstab_ (see *fstab*(5)), may contain lines describing what devices are usually mounted where, using which options. The default location of the *fstab*(5) file can be overridden with the *--fstab* _path_ command-line option (see below for more details).
134
135The command
136
137____
138*mount -a* [*-t* _type_] [*-O* _optlist_]
139____
140
141(usually given in a bootscript) causes all filesystems mentioned in _fstab_ (of the proper type and/or having or not having the proper options) to be mounted as indicated, except for those whose line contains the *noauto* keyword. Adding the *-F* option will make *mount* fork, so that the filesystems are mounted in parallel.
142
143When mounting a filesystem mentioned in _fstab_ or _mtab_, it suffices to specify on the command line only the device, or only the mount point.
144
145The programs *mount* and *umount*(8) traditionally maintained a list of currently mounted filesystems in the file _/etc/mtab_. The support for regular classic _/etc/mtab_ is completely disabled at compile time by default, because on current Linux systems it is better to make _/etc/mtab_ a symlink to _/proc/mounts_ instead. The regular _mtab_ file maintained in userspace cannot reliably work with namespaces, containers and other advanced Linux features. If the regular _mtab_ support is enabled, then it's possible to use the file as well as the symlink.
146
147If no arguments are given to *mount*, the list of mounted filesystems is printed.
148
149If you want to override mount options from _/etc/fstab_, you have to use the *-o* option:
150
151____
bd67ca44 152*mount* __device__|__dir__ *-o* _options_
14179682
MB
153____
154
155and then the mount options from the command line will be appended to the list of options from _/etc/fstab_. This default behaviour can be changed using the *--options-mode* command-line option. The usual behavior is that the last option wins if there are conflicting ones.
156
157The *mount* program does not read the _/etc/fstab_ file if both _device_ (or LABEL, UUID, ID, PARTUUID or PARTLABEL) and _dir_ are specified. For example, to mount device *foo* at */dir*:
158
159____
160*mount /dev/foo /dir*
161____
162
163This default behaviour can be changed by using the *--options-source-force* command-line option to always read configuration from _fstab_. For non-root users *mount* always reads the _fstab_ configuration.
164
165=== Non-superuser mounts
166
167Normally, only the superuser can mount filesystems. However, when _fstab_ contains the *user* option on a line, anybody can mount the corresponding filesystem.
168
169Thus, given a line
170
171____
172*/dev/cdrom /cd iso9660 ro,user,noauto,unhide*
173____
174
175any user can mount the iso9660 filesystem found on an inserted CDROM using the command:
176
177____
178*mount /cd*
179____
180
181Note that *mount* is very strict about non-root users and all paths specified on command line are verified before _fstab_ is parsed or a helper program is executed. It's strongly recommended to use a valid mountpoint to specify filesystem, otherwise *mount* may fail. For example it's a bad idea to use NFS or CIFS source on command line.
182
183Since util-linux 2.35, *mount* does not exit when user permissions are inadequate according to libmount's internal security rules. Instead, it drops suid permissions and continues as regular non-root user. This behavior supports use-cases where root permissions are not necessary (e.g., fuse filesystems, user namespaces, etc).
184
4eab78d3 185For more details, see *fstab*(5). Only the user that mounted a filesystem can unmount it again. If any user should be able to unmount it, then use *users* instead of *user* in the _fstab_ line. The *owner* option is similar to the *user* option, with the restriction that the user must be the owner of the special file. This may be useful e.g. for _/dev/fd_ if a login script makes the console user owner of this device. The *group* option is similar, with the restriction that the user must be a member of the group of the special file.
14179682 186
a96b486d
KZ
187The *user* mount option is accepted if no username is specified. If used in the format *user=someone*, the option is silently ignored and visible only for external mount helpers (/sbin/mount.<type>) for compatibility with some network filesystems.
188
14179682
MB
189=== Bind mount operation
190
191Remount part of the file hierarchy somewhere else. The call is:
192
193____
194*mount --bind* _olddir newdir_
195____
196
197or by using this _fstab_ entry:
198
199____
200**/**__olddir__ **/**__newdir__ *none bind*
201____
202
203After this call the same contents are accessible in two places.
204
205It is important to understand that "bind" does not create any second-class or special node in the kernel VFS. The "bind" is just another operation to attach a filesystem. There is nowhere stored information that the filesystem has been attached by a "bind" operation. The _olddir_ and _newdir_ are independent and the _olddir_ may be unmounted.
206
207One can also remount a single file (on a single file). It's also possible to use a bind mount to create a mountpoint from a regular directory, for example:
208
209____
210*mount --bind foo foo*
211____
212
213The bind mount call attaches only (part of) a single filesystem, not possible submounts. The entire file hierarchy including submounts can be attached a second place by using:
214
215____
216*mount --rbind* _olddir newdir_
217____
218
219Note that the filesystem mount options maintained by the kernel will remain the same as those on the original mount point. The userspace mount options (e.g., _netdev) will not be copied by *mount* and it's necessary to explicitly specify the options on the *mount* command line.
220
221Since util-linux 2.27 *mount* permits changing the mount options by passing the relevant options along with *--bind*. For example:
222
223____
224*mount -o bind,ro foo foo*
225____
226
227This feature is not supported by the Linux kernel; it is implemented in userspace by an additional *mount*(2) remounting system call. This solution is not atomic.
228
229The alternative (classic) way to create a read-only bind mount is to use the remount operation, for example:
230
231____
355d3ef7
KZ
232*mount --bind* _olddir newdir_
233
234*mount -o remount,bind,ro* _olddir newdir_
14179682
MB
235____
236
237Note that a read-only bind will create a read-only mountpoint (VFS entry), but the original filesystem superblock will still be writable, meaning that the _olddir_ will be writable, but the _newdir_ will be read-only.
238
8a4bfc73 239It's also possible to change nosuid, nodev, noexec, noatime, nodiratime, relatime and nosymfollow VFS entry flags via a "remount,bind" operation. The other flags (for example filesystem-specific flags) are silently ignored. The classic *mount*(2) system call does not allow to change mount options recursively (for example with *-o rbind,ro*). The recursive semantic is possible with a new *mount_setattr*(2) kernel system call and it's supported since libmount from util-linux v2.39 by a new experimental "recursive" option argument (e.g. *-o rbind,ro=recursive*). For more details see the *FILESYSTEM-INDEPENDENT MOUNT OPTIONS* section.
14179682 240
bd67ca44 241Since util-linux 2.31, *mount* ignores the *bind* flag from _/etc/fstab_ on a *remount* operation (if *-o remount* is specified on command line). This is necessary to fully control mount options on remount by command line. In previous versions the bind flag has been always applied and it was impossible to re-define mount options without interaction with the bind semantic. This *mount* behavior does not affect situations when "remount,bind" is specified in the _/etc/fstab_ file.
14179682 242
bd69e791
KZ
243Since util-linux 2.39, *mount* may use the new kernel mount API if it is available. This new kernel interface provides a more precise way to work with mountpoint attributes. For example, the *-o bind,rw* operation will create a read-write node even if the original node was read-only. This was impossible with the old classic mount(2) syscall, where the read-only VFS flag was inherited from the original node.
244
14179682
MB
245=== The move operation
246
247Move a *mounted tree* to another place (atomically). The call is:
248
249____
250*mount --move* _olddir newdir_
251____
252
253This will cause the contents which previously appeared under _olddir_ to now be accessible under _newdir_. The physical location of the files is not changed. Note that _olddir_ has to be a mountpoint.
254
255Note also that moving a mount residing under a shared mount is invalid and unsupported. Use *findmnt -o TARGET,PROPAGATION* to see the current propagation flags.
256
257=== Shared subtree operations
258
259Since Linux 2.6.15 it is possible to mark a mount and its submounts as shared, private, slave or unbindable. A shared mount provides the ability to create mirrors of that mount such that mounts and unmounts within any of the mirrors propagate to the other mirror. A slave mount receives propagation from its master, but not vice versa. A private mount carries no propagation abilities. An unbindable mount is a private mount which cannot be cloned through a bind operation. The detailed semantics are documented in _Documentation/filesystems/sharedsubtree.txt_ file in the kernel source tree; see also *mount_namespaces*(7).
260
261Supported operations are:
262
263....
264mount --make-shared mountpoint
265mount --make-slave mountpoint
266mount --make-private mountpoint
267mount --make-unbindable mountpoint
268....
269
270The following commands allow one to recursively change the type of all the mounts under a given mountpoint.
271
272....
273mount --make-rshared mountpoint
274mount --make-rslave mountpoint
275mount --make-rprivate mountpoint
276mount --make-runbindable mountpoint
277....
278
bd67ca44 279*mount* *does not read* *fstab*(5) when a *--make-** operation is requested. All necessary information has to be specified on the command line.
14179682
MB
280
281Note that the Linux kernel does not allow changing multiple propagation flags with a single *mount*(2) system call, and the flags cannot be mixed with other mount options and operations.
282
6e68b841 283Since util-linux 2.23 the *mount* command can be used to do more propagation (topology) changes by one *mount*(8) call and do it also together with other mount operations. The propagation flags are applied by additional *mount*(2) system calls when the preceding mount operations were successful. Note that this use case is not atomic. It is possible to specify the propagation flags in *fstab*(5) as mount options (*private*, *slave*, *shared*, *unbindable*, *rprivate*, *rslave*, *rshared*, *runbindable*).
14179682
MB
284
285For example:
286
287....
288mount --make-private --make-unbindable /dev/sda1 /foo
289....
290
291is the same as:
292
293....
294mount /dev/sda1 /foo
295mount --make-private /foo
296mount --make-unbindable /foo
297....
298
299== COMMAND-LINE OPTIONS
300
301The full set of mount options used by an invocation of *mount* is determined by first extracting the mount options for the filesystem from the _fstab_ table, then applying any options specified by the *-o* argument, and finally applying a *-r* or *-w* option, when present.
302
c83a52f0 303The *mount* command does not pass all command-line options to the **/sbin/mount.**__suffix__ mount helpers. The interface between *mount* and the mount helpers is described below in the *EXTERNAL HELPERS* section.
14179682
MB
304
305Command-line options available for the *mount* command are:
306
307*-a*, *--all*::
4eab78d3
MB
308Mount all filesystems (of the given types) mentioned in _fstab_ (except for those whose line contains the *noauto* keyword). The filesystems are mounted following their order in _fstab_. The *mount* command compares filesystem source, target (and fs root for bind mount or btrfs) to detect already mounted filesystems. The kernel table with already mounted filesystems is cached during *mount --all*. This means that all duplicated _fstab_ entries will be mounted.
309+
344b0cd4 310The correct functionality depends on _/proc_ (to detect already mounted filesystems) and on _/sys_ (to evaluate filesystem tags like UUID= or LABEL=). It's strongly recommended to mount _/proc_ and _/sys_ filesystems before *mount -a* is executed, or keep /proc and /sys at the beginning of _fstab_.
3e019017 311+
4eab78d3
MB
312The option *--all* is possible to use for remount operation too. In this case all filters (*-t* and *-O*) are applied to the table of already mounted filesystems.
313+
344b0cd4 314Since version 2.35 it is possible to use the command line option *-o* to alter mount options from _fstab_ (see also *--options-mode*).
4eab78d3
MB
315+
316Note that it is a bad practice to use *mount -a* for _fstab_ checking. The recommended solution is *findmnt --verify*.
14179682
MB
317
318*-B*, *--bind*::
ebb107bc 319Remount a subtree somewhere else (so that its contents are available in both places). See above, under *Bind mount operation*.
14179682
MB
320
321*-c*, *--no-canonicalize*::
c19ae209 322Don't canonicalize paths. The *mount* command canonicalizes all paths (from the command line or _fstab_) by default. This option can be used together with the *-f* flag for already canonicalized absolute paths. The option is designed for mount helpers which call *mount -i*. It is strongly recommended to not use this command-line option for normal mount operations.
4eab78d3
MB
323+
324Note that *mount* does not pass this option to the **/sbin/mount.**__type__ helpers.
14179682
MB
325
326*-F*, *--fork*::
4eab78d3 327(Used in conjunction with *-a*.) Fork off a new incarnation of *mount* for each device. This will do the mounts on different devices or different NFS servers in parallel. This has the advantage that it is faster; also NFS timeouts proceed in parallel. A disadvantage is that the order of the mount operations is undefined. Thus, you cannot use this option if you want to mount both _/usr_ and _/usr/spool_.
14179682
MB
328
329*-f, --fake*::
cc3edae7 330Causes everything to be done except for the mount-related system calls. The *--fake* option was originally designed to write an entry to _/etc/mtab_ without actually mounting.
b42e4e23 331+
cc3edae7 332The _/etc/mtab_ is no longer maintained in userspace, and starting from version 2.39, the mount operation can be a complex chain of operations with dependencies between the syscalls. The *--fake* option forces libmount to skip all mount source preparation, mount option analysis, and the actual mounting process.
b42e4e23 333+
cc3edae7 334The difference between fake and non-fake execution is huge. This is the reason why the *--fake* option has minimal significance for the current *mount*(8) implementation and it is maintained mostly for backward compatibility.
14179682
MB
335
336*-i, --internal-only*::
4eab78d3 337Don't call the **/sbin/mount.**__filesystem__ helper even if it exists.
14179682
MB
338
339*-L*, *--label* _label_::
4eab78d3 340Mount the partition that has the specified _label_.
14179682
MB
341
342*-l*, *--show-labels*::
4eab78d3 343Add the labels in the mount output. *mount* must have permission to read the disk device (e.g. be set-user-ID root) for this to work. One can set such a label for ext2, ext3 or ext4 using the *e2label*(8) utility, or for XFS using *xfs_admin*(8), or for reiserfs using *reiserfstune*(8).
14179682
MB
344
345*-M*, *--move*::
4eab78d3 346Move a subtree to some other place. See above, the subsection *The move operation*.
14179682 347
5a72054b
KZ
348*-m*, **--mkdir**[=__mode__]::
349Allow to make a target directory (mountpoint) if it does not exist yet. Alias to "-o X-mount.mkdir[=mode]", the default mode is 0755. For more details see *X-mount.mkdir* below.
350
a61bbb37
CW
351*--map-groups*, *--map-users* _inner_:_outer_:_count_::
352Add the specified user/group mapping to an *X-mount.idmap* map. These options can be given multiple times to build up complete mappings for users and groups. For more details see *X-mount.idmap* below.
353
354*--map-users* /proc/_PID_/ns/user::
355Use the specified user namespace for user and group mapping in an id-mapped mount. This is an alias for "-o X-mount.idmap=/proc/_PID_/ns/user" and cannot be used twice nor together with the _inner_:_outer_:_count_ option format above. For more details see *X-mount.idmap* below.
356
14179682 357*-n*, *--no-mtab*::
4eab78d3 358Mount without writing in _/etc/mtab_. This is necessary for example when _/etc_ is on a read-only filesystem.
14179682
MB
359
360*-N*, *--namespace* _ns_::
4eab78d3
MB
361Perform the mount operation in the mount namespace specified by _ns_. _ns_ is either PID of process running in that namespace or special file representing that namespace.
362+
bd67ca44 363*mount* switches to the mount namespace when it reads _/etc/fstab_, writes _/etc/mtab: (or writes to _/run/mount_) and calls *mount*(2), otherwise it runs in the original mount namespace. This means that the target namespace does not have to contain any libraries or other requirements necessary to execute the *mount*(2) call.
4eab78d3
MB
364+
365See *mount_namespaces*(7) for more information.
14179682
MB
366
367*-O*, *--test-opts* _opts_::
4eab78d3
MB
368Limit the set of filesystems to which the *-a* option applies. In this regard it is like the *-t* option except that *-O* is useless without *-a*. For example, the command
369+
370*mount -a -O no_netdev*
371+
372mounts all filesystems except those which have the option _netdev_ specified in the options field in the _/etc/fstab_ file.
373+
374It is different from *-t* in that each option is matched exactly; a leading *no* at the beginning of one option does not negate the rest.
375+
376The *-t* and *-O* options are cumulative in effect; that is, the command
377+
378*mount -a -t ext2 -O _netdev*
379+
380mounts all ext2 filesystems with the _netdev option, not all filesystems that are either ext2 or have the _netdev option specified.
14179682
MB
381
382*-o*, *--options* _opts_::
4eab78d3
MB
383Use the specified mount options. The _opts_ argument is a comma-separated list. For example:
384+
385*mount LABEL=mydisk -o noatime,nodev,nosuid*
386+
5603aee0
KZ
387Note that the order of the options matters, as the last option wins if there are conflicting ones. The options from the command line also overwrite options from fstab by default.
388+
4eab78d3 389For more details, see the *FILESYSTEM-INDEPENDENT MOUNT OPTIONS* and *FILESYSTEM-SPECIFIC MOUNT OPTIONS* sections.
14179682 390
3d1c41c8 391*--onlyonce*::
cc3edae7 392Forces *mount* command to check if the filesystem is already mounted. This behavior is the default for *--all*; otherwise, it depends on the kernel filesystem driver. Some filesystems may be mounted more than once on the same mount point (e.g. tmpfs).
3d1c41c8 393
14179682 394*--options-mode* _mode_::
4eab78d3 395Controls how to combine options from _fstab_/_mtab_ with options from the command line. _mode_ can be one of *ignore*, *append*, *prepend* or *replace*. For example, *append* means that options from _fstab_ are appended to options from the command line. The default value is *prepend* -- it means command line options are evaluated after _fstab_ options. Note that the last option wins if there are conflicting ones.
14179682
MB
396
397*--options-source* _source_::
bd67ca44 398Source of default options. _source_ is a comma-separated list of *fstab*, *mtab* and *disable*. *disable* disables *fstab* and *mtab* and enables *--options-source-force*. The default value is *fstab,mtab*.
14179682
MB
399
400*--options-source-force*::
4eab78d3 401Use options from _fstab_/_mtab_ even if both _device_ and _dir_ are specified.
14179682
MB
402
403*-R*, *--rbind*::
ebb107bc 404Remount a subtree and all possible submounts somewhere else (so that its contents are available in both places). See above, the subsection *Bind mount operation*.
14179682
MB
405
406*-r*, *--read-only*::
4eab78d3
MB
407Mount the filesystem read-only. A synonym is *-o ro*.
408+
409Note 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 may want to mount an ext3 or ext4 filesystem with the *ro,noload* mount options or set the block device itself to read-only mode, see the *blockdev*(8) command.
14179682
MB
410
411*-s*::
4eab78d3 412Tolerate 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 *mount.nfs* mount helper only.
14179682
MB
413
414*--source* _device_::
4eab78d3 415If only one argument for the *mount* command is given, then the argument might be interpreted as the target (mountpoint) or source (device). This option allows you to explicitly define that the argument is the mount source.
14179682
MB
416
417*--target* _directory_::
4eab78d3 418If only one argument for the mount command is given, then the argument might be interpreted as the target (mountpoint) or source (device). This option allows you to explicitly define that the argument is the mount target.
14179682
MB
419
420*--target-prefix* _directory_::
4eab78d3
MB
421Prepend the specified directory to all mount targets. This option can be used to follow _fstab_, but mount operations are done in another place, for example:
422+
423*mount --all --target-prefix /chroot -o X-mount.mkdir*
424+
425mounts all from system _fstab_ to _/chroot_, all missing mountpoint are created (due to X-mount.mkdir). See also *--fstab* to use an alternative _fstab_.
14179682
MB
426
427*-T*, *--fstab* _path_::
4eab78d3
MB
428Specifies an alternative _fstab_ file. If _path_ is a directory, then the files in the directory are sorted by *strverscmp*(3); files that start with "." or without an _.fstab_ extension are ignored. The option 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.
429+
430Note that *mount* does not pass the option *--fstab* to the **/sbin/mount.**__type__ 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.
14179682
MB
431
432*-t*, *--types* _fstype_::
4eab78d3
MB
433The argument following the *-t* is used to indicate the filesystem type. The filesystem types which are currently supported depend on the running kernel. See _/proc/filesystems_ and _/lib/modules/$(uname -r)/kernel/fs_ for a complete list of the filesystems. The most common are ext2, ext3, ext4, xfs, btrfs, vfat, sysfs, proc, nfs and cifs.
434+
435The programs *mount* and *umount*(8) support filesystem subtypes. The subtype is defined by a '.subtype' suffix. For example 'fuse.sshfs'. It's recommended to use subtype notation rather than add any prefix to the mount source (for example 'sshfs#example.com' is deprecated).
436+
437If no *-t* option is given, or if the *auto* type is specified, *mount* will try to guess the desired type. *mount* uses the *libblkid*(3) library for guessing the filesystem type; if that does not turn up anything that looks familiar, *mount* will try to read the file _/etc/filesystems_, or, if that does not exist, _/proc/filesystems_. All of the filesystem types listed there will be tried, except for those that are labeled "nodev" (e.g. _devpts_, _proc_ and _nfs_). If _/etc/filesystems_ ends in a line with a single {asterisk}, mount will read _/proc/filesystems_ afterwards. While trying, all filesystem types will be mounted with the mount option *silent*.
438//TRANSLATORS: Keep {asterisk} untranslated.
439+
440The *auto* type may be useful for user-mounted floppies. Creating a file _/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.
441+
442More than one type may be specified in a comma-separated list, for the *-t* option as well as in an _/etc/fstab_ entry. The list of filesystem types for the *-t* option can be prefixed with *no* to specify the filesystem types on which no action should be taken. The prefix *no* has no effect when specified in an _/etc/fstab_ entry.
443+
444The prefix *no* can be meaningful with the *-a* option. For example, the command
445+
446*mount -a -t nomsdos,smbfs*
447+
448mounts all filesystems except those of type _msdos_ and _smbfs_.
449+
450For most types all the *mount* program has to do is issue a simple *mount*(2) system call, and no detailed knowledge of the filesystem type is required. For a few types however (like nfs, nfs4, cifs, smbfs, ncpfs) an ad hoc code is necessary. The nfs, nfs4, cifs, smbfs, and ncpfs filesystems have a separate mount program. In order to make it possible to treat all types in a uniform way, *mount* will execute the program **/sbin/mount.**__type__ (if that exists) when called with type _type_. Since different versions of the *smbmount* program have different calling conventions, */sbin/mount.smbfs* may have to be a shell script that sets up the desired call.
14179682
MB
451
452*-U*, *--uuid* _uuid_::
4eab78d3 453Mount the partition that has the specified _uuid_.
14179682
MB
454
455*-v*, *--verbose*::
4eab78d3 456Verbose mode.
14179682
MB
457
458*-w*, *--rw*, *--read-write*::
6ccd33fb 459Mount the filesystem read/write. Read-write is the kernel default and the *mount* default is to try read-only if the previous *mount*(2) syscall with read-write flags on write-protected devices failed.
4eab78d3
MB
460+
461A synonym is *-o rw*.
462+
463Note that specifying *-w* on the command line forces *mount* to never try read-only mount on write-protected devices or already mounted read-only filesystems.
14179682 464
2b2d3172 465include::man-common/help-version.adoc[]
14179682
MB
466
467== FILESYSTEM-INDEPENDENT MOUNT OPTIONS
468
469Some of these options are only useful when they appear in the _/etc/fstab_ file.
470
f5c68982 471Some of these options could be enabled or disabled by default in the system kernel. To check the current setting see the options in _/proc/mounts_. Note that filesystems also have per-filesystem specific default mount options (see for example *tune2fs -l* output for ext__N__ filesystems).
14179682 472
e84f01c1
KZ
473The options *nosuid*, *noexec*, *nodiratime*, *relatime*, *noatime*, *strictatime*, and *nosymfollow* are interpreted only by the abstract VFS kernel layer and applied to the mountpoint node rather than to the filesystem itself. Try:
474____
475
476 findmnt -o TARGET,VFS-OPTIONS,FS-OPTIONS
477____
478
479to get a complete overview of filesystems and VFS options.
480
481The read-only setting (*ro* or *rw*) is interpreted by VFS and the filesystem
8a4bfc73 482and depends on how the option is specified on the *mount*(8) command line. The
e84f01c1
KZ
483default is to interpret it on the filesystem level. The operation "-o bind,remount,ro"
484is applied only to the VFS mountpoint, and operation "-o remount,ro" is applied to
485VFS and filesystem superblock. This semantic allows create a read-only
486mountpoint but keeps the filesystem writable from another mountpoint.
487
488Since v2.39 libmount can use a new kernel mount interface to set the VFS
489options recursive. For backward compatibility, this feature is not enabled by
490default, although recursive operation (e.g. rbind) has been requested. The new
491option argument "recursive" could be specified, for example:
492____
493
494 mount -orbind,ro=recursive,noexec=recursive,nosuid /foo /bar
495____
496
497recursively binds filesystems from /foo to /bar, /bar, and all submounts will
498be read-only and noexec, but only /bar itself will be "nosuid". The "recursive"
499optional argument for VFS mount options is an EXPERIMENTAL feature.
500
4eab78d3 501The following options apply to any filesystem that is being mounted (but not every filesystem actually honors them - e.g., the *sync* option today has an effect only for ext2, ext3, ext4, fat, vfat, ufs and xfs):
14179682
MB
502
503*async*::
4eab78d3 504All I/O to the filesystem should be done asynchronously. (See also the *sync* option.)
14179682
MB
505
506*atime*::
544e64e0 507Do not use the *noatime* feature, so the inode access time is controlled by kernel defaults. See also the descriptions of the *relatime* and *strictatime* mount options.
14179682
MB
508
509*noatime*::
544e64e0 510Do not update inode access times on this filesystem (e.g. for faster access on the news spool to speed up news servers). This works for all inode types (directories too), so it implies *nodiratime*.
14179682
MB
511
512*auto*::
4eab78d3 513Can be mounted with the *-a* option.
14179682
MB
514
515*noauto*::
4eab78d3 516Can only be mounted explicitly (i.e., the *-a* option will not cause the filesystem to be mounted).
14179682 517
f933e53c 518**context=**__context__, **fscontext=**__context__, **defcontext=**__context__, and **rootcontext=**__context__::
4eab78d3
MB
519The *context=* option is useful when mounting filesystems that do not support extended attributes, such as a floppy or hard disk formatted with VFAT, or systems that are not normally running under SELinux, such as an ext3 or ext4 formatted disk from a non-SELinux workstation. You can also use *context=* on filesystems you do not trust, such as a floppy. It also helps in compatibility with xattr-supporting filesystems on earlier 2.4.<x> kernel versions. Even where xattrs are supported, you can save time not having to label every file by assigning the entire disk one security context.
520+
f933e53c 521A commonly used option for removable media is *context="system_u:object_r:removable_t*.
4eab78d3 522+
4eab78d3
MB
523The *fscontext=* option works for all filesystems, regardless of their xattr support. The fscontext option sets the overarching filesystem label to a specific security context. This filesystem label is separate from the individual labels on the files. It represents the entire filesystem for certain kinds of permission checks, such as during mount or file creation. Individual file labels are still obtained from the xattrs on the files themselves. The context option actually sets the aggregate context that fscontext provides, in addition to supplying the same label for individual files.
524+
e08e3d58 525You can set the default security context for unlabeled files using *defcontext=* option. This overrides the value set for unlabeled files in the policy and requires a filesystem that supports xattr labeling.
4eab78d3 526+
cbbe29e6 527The *rootcontext=* option allows you to explicitly label the root inode of a FS being mounted before that FS or inode becomes visible to userspace. This was found to be useful for things like stateless Linux. The special value *@target* can be used to assign the current context of the target mountpoint location.
4eab78d3
MB
528+
529Note that the kernel rejects any remount request that includes the context option, *even* when unchanged from the current context.
530+
531*Warning: the* _context_ *value might contain commas*, in which case the value has to be properly quoted, otherwise *mount* will interpret the comma as a separator between mount options. Don't forget that the shell strips off quotes and thus *double quoting is required*. For example:
7293d663 532+
4eab78d3 533____
7293d663 534....
4eab78d3
MB
535mount -t tmpfs none /mnt -o \
536'context="system_u:object_r:tmp_t:s0:c127,c456",noexec'
7293d663 537....
4eab78d3
MB
538____
539
540For more details, see *selinux*(8).
14179682
MB
541
542*defaults*::
4eab78d3
MB
543Use the default options: *rw*, *suid*, *dev*, *exec*, *auto*, *nouser*, and *async*.
544+
545Note that the real set of all default mount options depends on the kernel and filesystem type. See the beginning of this section for more details.
14179682
MB
546
547*dev*::
4eab78d3 548Interpret character or block special devices on the filesystem.
14179682
MB
549
550*nodev*::
4eab78d3 551Do not interpret character or block special devices on the filesystem.
14179682
MB
552
553*diratime*::
4eab78d3 554Update directory inode access times on this filesystem. This is the default. (This option is ignored when *noatime* is set.)
14179682
MB
555
556*nodiratime*::
4eab78d3 557Do not update directory inode access times on this filesystem. (This option is implied when *noatime* is set.)
14179682
MB
558
559*dirsync*::
4eab78d3 560All directory updates within the filesystem should be done synchronously. This affects the following system calls: *creat*(2), *link*(2), *unlink*(2), *symlink*(2), *mkdir*(2), *rmdir*(2), *mknod*(2) and *rename*(2).
14179682
MB
561
562*exec*::
bd67ca44 563Permit execution of binaries and other executable files.
14179682
MB
564
565*noexec*::
4eab78d3 566Do not permit direct execution of any binaries on the mounted filesystem.
14179682
MB
567
568*group*::
4eab78d3 569Allow 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 *nosuid* and *nodev* (unless overridden by subsequent options, as in the option line *group,dev,suid*).
14179682
MB
570
571*iversion*::
4eab78d3 572Every time the inode is modified, the i_version field will be incremented.
14179682
MB
573
574*noiversion*::
4eab78d3 575Do not increment the i_version inode field.
14179682
MB
576
577*mand*::
c3ea860b 578Allow mandatory locks on this filesystem. See *fcntl*(2). This option was deprecated in Linux 5.15.
14179682
MB
579
580*nomand*::
4eab78d3 581Do not allow mandatory locks on this filesystem.
14179682
MB
582
583*_netdev*::
4eab78d3 584The filesystem resides on a device that requires network access (used to prevent the system from attempting to mount these filesystems until the network has been enabled on the system).
14179682
MB
585
586*nofail*::
4eab78d3 587Do not report errors for this device if it does not exist.
14179682
MB
588
589*relatime*::
9154eac9 590Update inode access times relative to modify or change time. Access time is only updated if the previous access time was earlier than or equal to the current modify or change time. (Similar to *noatime*, but it doesn't break *mutt*(1) or other applications that need to know if a file has been read since the last time it was modified.)
4eab78d3 591+
f933e53c 592Since Linux 2.6.30, the kernel defaults to the behavior provided by this option (unless *noatime* was specified), and the *strictatime* option is required to obtain traditional semantics. In addition, since Linux 2.6.30, the file's last access time is always updated if it is more than 1 day old.
14179682
MB
593
594*norelatime*::
4eab78d3 595Do not use the *relatime* feature. See also the *strictatime* mount option.
14179682
MB
596
597*strictatime*::
f933e53c 598Allows to explicitly request full atime updates. This makes it possible for the kernel to default to *relatime* or *noatime* but still allow userspace to override it. For more details about the default system mount options see _/proc/mounts_.
14179682
MB
599
600*nostrictatime*::
4eab78d3 601Use the kernel's default behavior for inode access time updates.
14179682
MB
602
603*lazytime*::
4eab78d3
MB
604Only update times (atime, mtime, ctime) on the in-memory version of the file inode.
605+
606This mount option significantly reduces writes to the inode table for workloads that perform frequent random writes to preallocated files.
607+
608The on-disk timestamps are updated only when:
609+
610* the inode needs to be updated for some change unrelated to file timestamps
611* the application employs *fsync*(2), *syncfs*(2), or *sync*(2)
612* an undeleted inode is evicted from memory
613* more than 24 hours have passed since the inode was written to disk.
14179682
MB
614
615*nolazytime*::
4eab78d3 616Do not use the lazytime feature.
14179682
MB
617
618*suid*::
4eab78d3 619Honor set-user-ID and set-group-ID bits or file capabilities when executing programs from this filesystem.
14179682
MB
620
621*nosuid*::
344b0cd4 622Do not honor set-user-ID and set-group-ID bits or file capabilities when executing programs from this filesystem. In addition, SELinux domain transitions require permission _nosuid_transition_, which in turn needs also policy capability _nnp_nosuid_transition_.
14179682
MB
623
624*silent*::
4eab78d3 625Turn on the silent flag.
14179682
MB
626
627*loud*::
4eab78d3 628Turn off the silent flag.
14179682
MB
629
630*owner*::
4eab78d3 631Allow an ordinary user to mount the filesystem if that user is the owner of the device. This option implies the options *nosuid* and *nodev* (unless overridden by subsequent options, as in the option line *owner,dev,suid*).
14179682
MB
632
633*remount*::
4eab78d3
MB
634Attempt to remount an already-mounted filesystem. This is commonly used to change the mount flags for a filesystem, especially to make a readonly filesystem writable. It does not change device or mount point.
635+
ebb107bc 636The remount operation together with the *bind* flag has special semantics. See above, the subsection *Bind mount operation*.
4eab78d3 637+
abf3f8a6 638The default kernel behavior for VFS mount flags (nodev,nosuid,noexec,ro) is to
add0a3e7
MB
639reset all unspecified flags on remount. That's why *mount*(8) tries to
640keep the current setting according to _fstab_ or _/proc/self/mountinfo_. This
abf3f8a6 641default behavior is possible to change by *--options-mode*. The recursive
add0a3e7
MB
642change of the mount flags (supported since v2.39 on systems with *mount_setattr*(2)
643syscall), for example, *mount -o remount,ro=recursive*, do not use
abf3f8a6
KZ
644"reset-unspecified" behavior, and it works as a simple add/remove operation
645and unspecified flags are not modified.
646+
4eab78d3
MB
647The remount functionality follows the standard way the *mount* command works with options from _fstab_. This means that *mount* does not read _fstab_ (or _mtab_) only when both _device_ and _dir_ are specified.
648+
649*mount -o remount,rw /dev/foo /dir*
650+
bd67ca44 651After this call all old mount options are replaced and arbitrary stuff from _fstab_ (or _mtab_) is ignored, except the *loop=* option which is internally generated and maintained by the *mount* command.
4eab78d3
MB
652+
653*mount -o remount,rw /dir*
654+
add0a3e7 655After this call, *mount* reads _fstab_ and merges these options with the options from the command line (*-o*). If no mountpoint is found in _fstab_, then it defaults to mount options from _/proc/self/mountinfo_.
4eab78d3 656+
abf3f8a6 657
4eab78d3
MB
658*mount* allows the use of *--all* to remount all already mounted filesystems which match a specified filter (*-O* and *-t*). For example:
659+
660*mount --all -o remount,ro -t vfat*
661+
bd67ca44 662remounts all already mounted vfat filesystems in read-only mode. Each of the filesystems is remounted by *mount -o remount,ro* _/dir_ semantic. This means the *mount* command reads _fstab_ or _mtab_ and merges these options with the options from the command line.
14179682
MB
663
664*ro*::
4eab78d3 665Mount the filesystem read-only.
14179682
MB
666
667*rw*::
4eab78d3 668Mount the filesystem read-write.
14179682
MB
669
670*sync*::
4eab78d3 671All I/O to the filesystem should be done synchronously. In the case of media with a limited number of write cycles (e.g. some flash drives), *sync* may cause life-cycle shortening.
14179682
MB
672
673*user*::
4eab78d3 674Allow an ordinary user to mount the filesystem. 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 *noexec*, *nosuid*, and *nodev* (unless overridden by subsequent options, as in the option line *user,exec,dev,suid*).
14179682
MB
675
676*nouser*::
4eab78d3 677Forbid an ordinary user to mount the filesystem. This is the default; it does not imply any other options.
14179682
MB
678
679*users*::
4eab78d3 680Allow any user to mount and to unmount the filesystem, even when some other ordinary user mounted it. This option implies the options *noexec*, *nosuid*, and *nodev* (unless overridden by subsequent options, as in the option line *users,exec,dev,suid*).
14179682
MB
681
682*X-**::
4eab78d3 683All options prefixed with "X-" are interpreted as comments or as userspace application-specific options. These options are not stored in user space (e.g., _mtab_ file), nor sent to the mount._type_ helpers nor to the *mount*(2) system call. The suggested format is **X-**__appname__._option_.
14179682
MB
684
685*x-**::
4eab78d3
MB
686The same as *X-** options, but stored permanently in user space. This means the options are also available for *umount*(8) or other operations. Note that maintaining mount options in user space is tricky, because it's necessary use libmount-based tools and there is no guarantee that the options will be always available (for example after a move mount operation or in unshared namespace).
687+
688Note that before util-linux v2.30 the x-* options have not been maintained by libmount and stored in user space (functionality was the same as for X-* now), but due to the growing number of use-cases (in initrd, systemd etc.) the functionality has been extended to keep existing _fstab_ configurations usable without a change.
14179682 689
1592425a
KZ
690*X-mount.auto-fstypes*=_list_::
691Specifies allowed or forbidden filesystem types for automatic filesystem
692detection.
693+
694The _list_ is a comma-separated list of the filesystem names. The
695automatic filesystem detection is triggered by the "auto" filesystem type or
696when the filesystem type is not specified.
697+
cc3edae7 698The _list_ follows how mount
1592425a
KZ
699evaluates type patterns (see *-t* for more details). Only specified filesystem
700types are allowed, or all specified types are forbidden if the list is prefixed
701by "no".
702+
703For example, X-mount.auto-fstypes="ext4,btrfs" accepts only ext4 and
704btrfs, and X-mount.auto-fstypes="novfat,xfs" accepts all filesystems except vfat
705and xfs.
706+
707Note that comma is used as a separator between mount options, it means
708that auto-fstypes values have to be properly quoted, don’t forget that the shell
709strips off quotes and thus double quoting is required. For example:
710____
711mount -t auto -o'X-mount.auto-fstypes="noext2,ext3"' /dev/sdc1 /mnt/test
712____
713
14179682 714*X-mount.mkdir*[=_mode_]::
bd67ca44 715Allow to make a target directory (mountpoint) if it does not exist yet. The optional argument _mode_ specifies the filesystem access mode used for *mkdir*(2) in octal notation. The default mode is 0755. This functionality is supported only for root users or when *mount* is executed without suid permissions. The option is also supported as *x-mount.mkdir*, but this notation is deprecated since v2.30. See also *--mkdir* command line option.
14179682 716
e311e731 717**X-mount.subdir=**__directory__::
21866774
KZ
718Allow mounting sub-directory from a filesystem instead of the root directory. For now, this feature is implemented by temporary filesystem root directory mount in unshared namespace and then bind the sub-directory to the final mount point and umount the root of the filesystem. The sub-directory mount shows up atomically for the rest of the system although it is implemented by multiple *mount*(2) syscalls.
719+
1a0f793e 720Note that this feature will not work in session with an unshared private mount namespace (after *unshare --mount*) on old kernels or with *mount*(8) without support for file-descriptors-based mount kernel API. In this case, you need *unshare --mount --propagation shared*.
21866774
KZ
721+
722This feature is EXPERIMENTAL.
e311e731 723
722c9697 724*X-mount.owner*=_username_|_UID_, *X-mount.group*=_group_|_GID_::
725Set _mountpoint_'s ownership after mounting. Names resolved in the target mount namespace, see *-N*.
726
727*X-mount.mode*=_mode_::
728Set _mountpoint_'s mode after mounting.
729
0bbc62dd
CB
730*X-mount.idmap*=__id-type__:__id-mount__:__id-host__:__id-range__ [__id-type__:__id-mount__:__id-host__:__id-range__], *X-mount.idmap*=__file__::
731Use this option to create an idmapped mount.
732An idmapped mount allows to change ownership of all files located under a mount according to the ID-mapping associated with a user namespace.
733The ownership change is tied to the lifetime and localized to the relevant mount.
734The relevant ID-mapping can be specified in two ways:
735+
736* A user can specify the ID-mapping directly.
737+
738The ID-mapping must be specified using the syntax __id-type__:__id-mount__:__id-host__:__id-range__.
739Specifying *u* as the __id-type__ prefix creates a UID-mapping, *g* creates a GID-mapping and omitting __id-type__ or specifying *b* creates both a UID- and GID-mapping.
740The __id-mount__ parameter indicates the starting ID in the new mount.
741The __id-host__ parameter indicates the starting ID in the filesystem.
742The __id-range__ parameter indicates how many IDs are to be mapped.
743It is possible to specify multiple ID-mappings.
744The individual ID-mappings must be separated by spaces.
745+
746For example, the ID-mapping *X-mount.idmap=u:1000:0:1 g:1001:1:2 5000:1000:2* creates an idmapped mount where
747UID 0 is mapped to UID 1000, GID 1 is mapped to GUID 1001, GID 2 is mapped to GID 1002, UID and GID 1000 are mapped to 5000, and UID and GID 1001 are mapped to 5001 in the mount.
748+
749When an ID-mapping is specified directly a new user namespace will be allocated with the requested ID-mapping.
750The newly created user namespace will be attached to the mount.
751* A user can specify a user namespace file.
752+
753The user namespace will then be attached to the mount and the ID-mapping of the user namespace will become the ID-mapping of the mount.
754+
755For example, *X-mount.idmap=/proc/PID/ns/user* will attach the user namespace of the process PID to the mount.
756
14179682 757*nosymfollow*::
4eab78d3 758Do not follow symlinks when resolving paths. Symlinks can still be created, and *readlink*(1), *readlink*(2), *realpath*(1), and *realpath*(3) all still work properly.
14179682
MB
759
760== FILESYSTEM-SPECIFIC MOUNT OPTIONS
761
762This section lists options that are specific to particular filesystems. Where possible, you should first consult filesystem-specific manual pages for details. Some of those pages are listed in the following table.
763
764[cols=",",options="header",]
765|===
766|*Filesystem(s)* |*Manual page*
767|btrfs |*btrfs*(5)
768|cifs |*mount.cifs*(8)
769|ext2, ext3, ext4 |*ext4*(5)
770|fuse |*fuse*(8)
771|nfs |*nfs*(5)
772|tmpfs |*tmpfs*(5)
773|xfs |*xfs*(5)
774|===
775
776Note that some of the pages listed above might be available only after you install the respective userland tools.
777
778The following options apply only to certain filesystems. We sort them by filesystem. All options follow the *-o* flag.
779
780What options are supported depends a bit on the running kernel. Further information may be available in filesystem-specific files in the kernel source subdirectory _Documentation/filesystems_.
781
782=== Mount options for adfs
783
784**uid=**__value__ and **gid=**__value__::
4eab78d3 785Set the owner and group of the files in the filesystem (default: uid=gid=0).
14179682
MB
786
787**ownmask=**__value__ and **othmask=**__value__::
4eab78d3 788Set the permission mask for ADFS 'owner' permissions and 'other' permissions, respectively (default: 0700 and 0077, respectively). See also _/usr/src/linux/Documentation/filesystems/adfs.rst_.
14179682
MB
789
790=== Mount options for affs
791
792**uid=**__value__ and **gid=**__value__::
4eab78d3 793Set the owner and group of the root of the filesystem (default: uid=gid=0, but with option *uid* or *gid* without specified value, the UID and GID of the current process are taken).
14179682
MB
794
795**setuid=**__value__ and **setgid=**__value__::
4eab78d3 796Set the owner and group of all files.
14179682
MB
797
798**mode=**__value__::
4eab78d3 799Set the mode of all files to _value_ & 0777 disregarding the original permissions. Add search permission to directories that have read permission. The value is given in octal.
14179682
MB
800
801*protect*::
4eab78d3 802Do not allow any changes to the protection bits on the filesystem.
14179682
MB
803
804*usemp*::
4eab78d3 805Set UID and GID of the root of the filesystem to the UID and GID of the mount point upon the first sync or umount, and then clear this option. Strange...
14179682
MB
806
807*verbose*::
4eab78d3 808Print an informational message for each successful mount.
14179682
MB
809
810**prefix=**__string__::
4eab78d3 811Prefix used before volume name, when following a link.
14179682
MB
812
813**volume=**__string__::
4eab78d3 814Prefix (of length at most 30) used before '/' when following a symbolic link.
14179682
MB
815
816**reserved=**__value__::
4eab78d3 817(Default: 2.) Number of unused blocks at the start of the device.
14179682
MB
818
819**root=**__value__::
4eab78d3 820Give explicitly the location of the root block.
14179682
MB
821
822**bs=**__value__::
4eab78d3 823Give blocksize. Allowed values are 512, 1024, 2048, 4096.
14179682
MB
824
825**grpquota**|**noquota**|**quota**|*usrquota*::
4eab78d3 826These options are accepted but ignored. (However, quota utilities may react to such strings in _/etc/fstab_.)
14179682
MB
827
828=== Mount options for debugfs
829
830The debugfs filesystem is a pseudo filesystem, traditionally mounted on _/sys/kernel/debug_. As of kernel version 3.4, debugfs has the following options:
831
832**uid=**__n__**, gid=**__n__::
4eab78d3 833Set the owner and group of the mountpoint.
14179682
MB
834
835**mode=**__value__::
4eab78d3 836Sets the mode of the mountpoint.
14179682
MB
837
838=== Mount options for devpts
839
840The devpts filesystem is a pseudo filesystem, traditionally mounted on _/dev/pts_. In order to acquire a pseudo terminal, a process opens _/dev/ptmx_; the number of the pseudo terminal is then made available to the process and the pseudo terminal slave can be accessed as _/dev/pts/_<number>.
841
842**uid=**__value__ and **gid=**__value__::
4eab78d3 843This sets the owner or the group of newly created pseudo terminals to the specified values. When nothing is specified, they will be set to the UID and GID of the creating process. For example, if there is a tty group with GID 5, then *gid=5* will cause newly created pseudo terminals to belong to the tty group.
14179682
MB
844
845**mode=**__value__::
4eab78d3 846Set the mode of newly created pseudo terminals to the specified value. The default is 0600. A value of *mode=620* and *gid=5* makes "mesg y" the default on newly created pseudo terminals.
14179682
MB
847
848*newinstance*::
4eab78d3
MB
849Create a private instance of the devpts filesystem, such that indices of pseudo terminals allocated in this new instance are independent of indices created in other instances of devpts.
850+
851All mounts of devpts without this *newinstance* option share the same set of pseudo terminal indices (i.e., legacy mode). Each mount of devpts with the *newinstance* option has a private set of pseudo terminal indices.
852+
853This option is mainly used to support containers in the Linux kernel. It is implemented in Linux kernel versions starting with 2.6.29. Further, this mount option is valid only if *CONFIG_DEVPTS_MULTIPLE_INSTANCES* is enabled in the kernel configuration.
854+
855To use this option effectively, _/dev/ptmx_ must be a symbolic link to _pts/ptmx_. See _Documentation/filesystems/devpts.txt_ in the Linux kernel source tree for details.
14179682
MB
856
857**ptmxmode=**__value__::
4eab78d3
MB
858Set the mode for the new _ptmx_ device node in the devpts filesystem.
859+
860With the support for multiple instances of devpts (see *newinstance* option above), each instance has a private _ptmx_ node in the root of the devpts filesystem (typically _/dev/pts/ptmx_).
861+
862For compatibility with older versions of the kernel, the default mode of the new _ptmx_ node is 0000. **ptmxmode=**__value__ specifies a more useful mode for the _ptmx_ node and is highly recommended when the *newinstance* option is specified.
863+
864This option is only implemented in Linux kernel versions starting with 2.6.29. Further, this option is valid only if *CONFIG_DEVPTS_MULTIPLE_INSTANCES* is enabled in the kernel configuration.
14179682
MB
865
866=== Mount options for fat
867
868(Note: _fat_ is not a separate filesystem, but a common part of the _msdos_, _umsdos_ and _vfat_ filesystems.)
869
870*blocksize=*{**512**|**1024**|*2048*}::
4eab78d3 871Set blocksize (default 512). This option is obsolete.
14179682
MB
872
873**uid=**__value__ and **gid=**__value__::
4eab78d3 874Set the owner and group of all files. (Default: the UID and GID of the current process.)
14179682
MB
875
876**umask=**__value__::
4eab78d3 877Set the umask (the bitmask of the permissions that are *not* present). The default is the umask of the current process. The value is given in octal.
14179682
MB
878
879**dmask=**__value__::
4eab78d3 880Set the umask applied to directories only. The default is the umask of the current process. The value is given in octal.
14179682
MB
881
882**fmask=**__value__::
4eab78d3 883Set the umask applied to regular files only. The default is the umask of the current process. The value is given in octal.
14179682
MB
884
885**allow_utime=**__value__::
4eab78d3 886This option controls the permission check of mtime/atime.
9637ed96
MB
887
888*20*;;
4eab78d3 889If current process is in group of file's group ID, you can change timestamp.
9637ed96
MB
890
891*2*;;
4eab78d3 892Other users can change timestamp.
14179682 893
4eab78d3 894The default is set from 'dmask' option. (If the directory is writable, *utime*(2) is also allowed. I.e. ~dmask & 022)
14179682
MB
895
896Normally *utime*(2) checks that the current process is owner of the file, or that it has the *CAP_FOWNER* capability. But FAT filesystems don't have UID/GID on disk, so the normal check is too inflexible. With this option you can relax it.
897
898**check=**__value__::
4eab78d3 899Three different levels of pickiness can be chosen:
9637ed96
MB
900
901*r*[*elaxed*];;
4eab78d3 902Upper and lower case are accepted and equivalent, long name parts are truncated (e.g. _verylongname.foobar_ becomes _verylong.foo_), leading and embedded spaces are accepted in each name part (name and extension).
9637ed96
MB
903
904*n*[*ormal*];;
4eab78d3 905Like "relaxed", but many special characters (*, ?, <, spaces, etc.) are rejected. This is the default.
9637ed96
MB
906
907*s*[*trict*];;
4eab78d3 908Like "normal", but names that contain long parts or special characters that are sometimes used on Linux but are not accepted by MS-DOS (+, =, etc.) are rejected.
14179682
MB
909
910**codepage=**__value__::
4eab78d3 911Sets the codepage for converting to shortname characters on FAT and VFAT filesystems. By default, codepage 437 is used.
14179682
MB
912
913**conv=**__mode__::
4eab78d3 914This option is obsolete and may fail or be ignored.
14179682
MB
915
916**cvf_format=**__module__::
bd67ca44 917Forces the driver to use the CVF (Compressed Volume File) module cvf___module__ instead of auto-detection. If the kernel supports *kmod*, the **cvf_format=**__xxx__ option also controls on-demand CVF module loading. This option is obsolete.
14179682
MB
918
919**cvf_option=**__option__::
4eab78d3 920Option passed to the CVF module. This option is obsolete.
14179682
MB
921
922*debug*::
4eab78d3 923Turn on the _debug_ flag. A version string and a list of filesystem parameters will be printed (these data are also printed if the parameters appear to be inconsistent).
14179682
MB
924
925*discard*::
4eab78d3 926If set, causes discard/TRIM commands to be issued to the block device when blocks are freed. This is useful for SSD devices and sparse/thinly-provisioned LUNs.
14179682
MB
927
928*dos1xfloppy*::
4eab78d3 929If set, use a fallback default BIOS Parameter Block configuration, determined by backing device size. These static parameters match defaults assumed by DOS 1.x for 160 kiB, 180 kiB, 320 kiB, and 360 kiB floppies and floppy images.
14179682
MB
930
931*errors=*{**panic**|**continue**|*remount-ro*}::
4eab78d3 932Specify FAT behavior on critical errors: panic, continue without doing anything, or remount the partition in read-only mode (default behavior).
14179682
MB
933
934*fat=*{**12**|**16**|*32*}::
4eab78d3 935Specify a 12, 16 or 32 bit fat. This overrides the automatic FAT type detection routine. Use with caution!
14179682
MB
936
937**iocharset=**__value__::
4eab78d3 938Character set to use for converting between 8 bit characters and 16 bit Unicode characters. The default is iso8859-1. Long filenames are stored on disk in Unicode format.
14179682
MB
939
940*nfs=*{**stale_rw**|*nostale_ro*}::
4eab78d3
MB
941Enable this only if you want to export the FAT filesystem over NFS.
942+
943*stale_rw*: This option maintains an index (cache) of directory inodes which is used by the nfs-related code to improve look-ups. Full file operations (read/write) over NFS are supported but with cache eviction at NFS server, this could result in spurious *ESTALE* errors.
944+
945*nostale_ro*: This option bases the inode number and file handle on the on-disk location of a file in the FAT directory entry. This ensures that *ESTALE* will not be returned after a file is evicted from the inode cache. However, it means that operations such as rename, create and unlink could cause file handles that previously pointed at one file to point at a different file, potentially causing data corruption. For this reason, this option also mounts the filesystem readonly.
946+
947To maintain backward compatibility, *-o nfs* is also accepted, defaulting to *stale_rw*.
14179682
MB
948
949*tz=UTC*::
4eab78d3 950This option disables the conversion of timestamps between local time (as used by Windows on FAT) and UTC (which Linux uses internally). This is particularly useful when mounting devices (like digital cameras) that are set to UTC in order to avoid the pitfalls of local time.
14179682
MB
951
952**time_offset=**__minutes__::
4eab78d3 953Set offset for conversion of timestamps from local time used by FAT to UTC. I.e., _minutes_ will be subtracted from each timestamp to convert it to UTC used internally by Linux. This is useful when the time zone set in the kernel via *settimeofday*(2) is not the time zone used by the filesystem. Note that this option still does not provide correct time stamps in all cases in presence of DST - time stamps in a different DST setting will be off by one hour.
14179682
MB
954
955*quiet*::
4eab78d3 956Turn on the _quiet_ flag. Attempts to chown or chmod files do not return errors, although they fail. Use with caution!
14179682
MB
957
958*rodir*::
4eab78d3
MB
959FAT has the *ATTR_RO* (read-only) attribute. On Windows, the *ATTR_RO* of the directory will just be ignored, and is used only by applications as a flag (e.g. it's set for the customized folder).
960+
961If you want to use *ATTR_RO* as read-only flag even for the directory, set this option.
14179682
MB
962
963*showexec*::
4eab78d3 964If set, the execute permission bits of the file will be allowed only if the extension part of the name is .EXE, .COM, or .BAT. Not set by default.
14179682
MB
965
966*sys_immutable*::
4eab78d3 967If set, *ATTR_SYS* attribute on FAT is handled as *IMMUTABLE* flag on Linux. Not set by default.
14179682
MB
968
969*flush*::
4eab78d3 970If set, the filesystem will try to flush to disk more early than normal. Not set by default.
14179682
MB
971
972*usefree*::
4eab78d3 973Use the "free clusters" value stored on *FSINFO*. It'll be used to determine number of free clusters without scanning disk. But it's not used by default, because recent Windows don't update it correctly in some case. If you are sure the "free clusters" on *FSINFO* is correct, by this option you can avoid scanning disk.
14179682
MB
974
975*dots*, *nodots*, *dotsOK=*[**yes**|*no*]::
4eab78d3 976Various misguided attempts to force Unix or DOS conventions onto a FAT filesystem.
14179682
MB
977
978=== Mount options for hfs
979
980**creator=**__cccc__**, type=**__cccc__::
4eab78d3 981Set the creator/type values as shown by the MacOS finder used for creating new files. Default values: '????'.
14179682
MB
982
983**uid=**__n__**, gid=**__n__::
4eab78d3 984Set the owner and group of all files. (Default: the UID and GID of the current process.)
14179682
MB
985
986**dir_umask=**__n__**, file_umask=**__n__**, umask=**__n__::
4eab78d3 987Set the umask used for all directories, all regular files, or all files and directories. Defaults to the umask of the current process.
14179682
MB
988
989**session=**__n__::
4eab78d3 990Select the CDROM session to mount. Defaults to leaving that decision to the CDROM driver. This option will fail with anything but a CDROM as underlying device.
14179682
MB
991
992**part=**__n__::
4eab78d3 993Select partition number n from the device. Only makes sense for CDROMs. Defaults to not parsing the partition table at all.
14179682
MB
994
995*quiet*::
4eab78d3 996Don't complain about invalid mount options.
14179682
MB
997
998=== Mount options for hpfs
999
1000**uid=**__value__ and **gid=**__value__::
4eab78d3 1001Set the owner and group of all files. (Default: the UID and GID of the current process.)
14179682
MB
1002
1003**umask=**__value__::
4eab78d3 1004Set the umask (the bitmask of the permissions that are *not* present). The default is the umask of the current process. The value is given in octal.
14179682
MB
1005
1006*case=*{**lower**|*asis*}::
4eab78d3 1007Convert all files names to lower case, or leave them. (Default: *case=lower*.)
14179682
MB
1008
1009**conv=**__mode__::
4eab78d3 1010This option is obsolete and may fail or being ignored.
14179682
MB
1011
1012*nocheck*::
4eab78d3 1013Do not abort mounting when certain consistency checks fail.
14179682
MB
1014
1015=== Mount options for iso9660
1016
1017ISO 9660 is a standard describing a filesystem structure to be used on CD-ROMs. (This filesystem type is also seen on some DVDs. See also the _udf_ filesystem.)
1018
1019Normal _iso9660_ filenames appear in an 8.3 format (i.e., DOS-like restrictions on filename length), and in addition all characters are in upper case. Also there is no field for file ownership, protection, number of links, provision for block/character devices, etc.
1020
1021Rock Ridge is an extension to iso9660 that provides all of these UNIX-like features. Basically there are extensions to each directory record that supply all of the additional information, and when Rock Ridge is in use, the filesystem is indistinguishable from a normal UNIX filesystem (except that it is read-only, of course).
1022
1023*norock*::
4eab78d3 1024Disable the use of Rock Ridge extensions, even if available. Cf. *map*.
14179682
MB
1025
1026*nojoliet*::
4eab78d3 1027Disable the use of Microsoft Joliet extensions, even if available. Cf. *map*.
14179682
MB
1028
1029*check=*{*r*[*elaxed*]|*s*[*trict*]}::
4eab78d3 1030With *check=relaxed*, a filename is first converted to lower case before doing the lookup. This is probably only meaningful together with *norock* and *map=normal*. (Default: *check=strict*.)
14179682
MB
1031
1032**uid=**__value__ and **gid=**__value__::
4eab78d3 1033Give all files in the filesystem the indicated user or group id, possibly overriding the information found in the Rock Ridge extensions. (Default: *uid=0,gid=0*.)
14179682
MB
1034
1035*map=*{*n*[*ormal*]|*o*[*ff*]|*a*[*corn*]}::
4eab78d3 1036For non-Rock Ridge volumes, normal name translation maps upper to lower case ASCII, drops a trailing ';1', and converts ';' to '.'. With *map=off* no name translation is done. See *norock*. (Default: *map=normal*.) *map=acorn* is like *map=normal* but also apply Acorn extensions if present.
14179682
MB
1037
1038**mode=**__value__::
4eab78d3 1039For non-Rock Ridge volumes, give all files the indicated mode. (Default: read and execute permission for everybody.) Octal mode values require a leading 0.
14179682
MB
1040
1041*unhide*::
4eab78d3 1042Also show hidden and associated files. (If the ordinary files and the associated or hidden files have the same filenames, this may make the ordinary files inaccessible.)
14179682
MB
1043
1044*block=*{**512**|**1024**|*2048*}::
4eab78d3 1045Set the block size to the indicated value. (Default: *block=1024*.)
14179682
MB
1046
1047**conv=**__mode__::
4eab78d3 1048This option is obsolete and may fail or being ignored.
14179682
MB
1049
1050*cruft*::
b53360d8 1051If the high byte of the file length contains other garbage, set this mount option to ignore the high order bits of the file length. This implies that a file cannot be larger than 16 MB.
14179682
MB
1052
1053**session=**__x__::
4eab78d3 1054Select number of session on a multisession CD.
14179682
MB
1055
1056**sbsector=**__xxx__::
4eab78d3 1057Session begins from sector xxx.
14179682
MB
1058
1059The following options are the same as for vfat and specifying them only makes sense when using discs encoded using Microsoft's Joliet extensions.
1060
1061**iocharset=**__value__::
4eab78d3 1062Character set to use for converting 16 bit Unicode characters on CD to 8 bit characters. The default is iso8859-1.
14179682
MB
1063
1064*utf8*::
4eab78d3 1065Convert 16 bit Unicode characters on CD to UTF-8.
14179682
MB
1066
1067=== Mount options for jfs
1068
1069**iocharset=**__name__::
4eab78d3 1070Character set to use for converting from Unicode to ASCII. The default is to do no conversion. Use *iocharset=utf8* for UTF8 translations. This requires *CONFIG_NLS_UTF8* to be set in the kernel _.config_ file.
14179682
MB
1071
1072**resize=**__value__::
4eab78d3 1073Resize the volume to _value_ blocks. JFS only supports growing a volume, not shrinking it. This option is only valid during a remount, when the volume is mounted read-write. The *resize* keyword with no value will grow the volume to the full size of the partition.
14179682
MB
1074
1075*nointegrity*::
4eab78d3 1076Do not write to the journal. The primary use of this option is to allow for higher performance when restoring a volume from backup media. The integrity of the volume is not guaranteed if the system abnormally ends.
14179682
MB
1077
1078*integrity*::
4eab78d3 1079Default. Commit metadata changes to the journal. Use this option to remount a volume where the *nointegrity* option was previously specified in order to restore normal behavior.
14179682
MB
1080
1081*errors=*{**continue**|**remount-ro**|*panic*}::
4eab78d3 1082Define the behavior when an error is encountered. (Either ignore errors and just mark the filesystem erroneous and continue, or remount the filesystem read-only, or panic and halt the system.)
14179682
MB
1083
1084**noquota**|**quota**|**usrquota**|*grpquota*::
4eab78d3 1085These options are accepted but ignored.
14179682
MB
1086
1087=== Mount options for msdos
1088
1089See mount options for fat. If the _msdos_ filesystem detects an inconsistency, it reports an error and sets the file system read-only. The filesystem can be made writable again by remounting it.
1090
1091=== Mount options for ncpfs
1092
bd67ca44 1093Just like _nfs_, the _ncpfs_ implementation expects a binary argument (a _struct ncp_mount_data_) to the *mount*(2) system call. This argument is constructed by *ncpmount*(8) and the current version of *mount* (2.12) does not know anything about ncpfs.
14179682
MB
1094
1095=== Mount options for ntfs
1096
1097**iocharset=**__name__::
4eab78d3 1098Character set to use when returning file names. Unlike VFAT, NTFS suppresses names that contain nonconvertible characters. Deprecated.
14179682
MB
1099
1100**nls=**__name__::
4eab78d3 1101New name for the option earlier called _iocharset_.
14179682
MB
1102
1103*utf8*::
4eab78d3 1104Use UTF-8 for converting file names.
14179682
MB
1105
1106*uni_xlate=*{**0**|**1**|*2*}::
4eab78d3 1107For 0 (or 'no' or 'false'), do not use escape sequences for unknown Unicode characters. For 1 (or 'yes' or 'true') or 2, use vfat-style 4-byte escape sequences starting with ":". Here 2 gives a little-endian encoding and 1 a byteswapped bigendian encoding.
14179682
MB
1108
1109*posix=[0|1]*::
4eab78d3 1110If enabled (posix=1), the filesystem distinguishes between upper and lower case. The 8.3 alias names are presented as hard links instead of being suppressed. This option is obsolete.
14179682
MB
1111
1112**uid=**__value__, **gid=**__value__ and **umask=**__value__::
4eab78d3 1113Set the file permission on the filesystem. The umask value is given in octal. By default, the files are owned by root and not readable by somebody else.
14179682
MB
1114
1115=== Mount options for overlay
1116
1117Since Linux 3.18 the overlay pseudo filesystem implements a union mount for other filesystems.
1118
1119An overlay filesystem combines two filesystems - an *upper* filesystem and a *lower* filesystem. When a name exists in both filesystems, the object in the upper filesystem is visible while the object in the lower filesystem is either hidden or, in the case of directories, merged with the upper object.
1120
1121The lower filesystem can be any filesystem supported by Linux and does not need to be writable. The lower filesystem can even be another overlayfs. The upper filesystem will normally be writable and if it is it must support the creation of trusted.* extended attributes, and must provide a valid d_type in readdir responses, so NFS is not suitable.
1122
1123A read-only overlay of two read-only filesystems may use any filesystem type. The options *lowerdir* and *upperdir* are combined into a merged directory by using:
1124
1125____
1126....
1127mount -t overlay overlay \
1128 -olowerdir=/lower,upperdir=/upper,workdir=/work /merged
1129....
1130____
1131
1132**lowerdir=**__directory__::
4eab78d3 1133Any filesystem, does not need to be on a writable filesystem.
14179682
MB
1134
1135**upperdir=**__directory__::
4eab78d3 1136The upperdir is normally on a writable filesystem.
14179682
MB
1137
1138**workdir=**__directory__::
4eab78d3 1139The workdir needs to be an empty directory on the same filesystem as upperdir.
14179682 1140
9fd75ae7
T
1141*userxattr*::
1142Use the "*user.overlay.*" xattr namespace instead of "*trusted.overlay.*". This is useful for unprivileged mounting of overlayfs.
1143
1144*redirect_dir=*{**on**|**off**|**follow**|**nofollow**}::
1145If the _redirect_dir_ feature is enabled, then the directory will be copied up (but not the contents). Then the "{**trusted**|**user**}.overlay.redirect" extended attribute is set to the path of the original location from the root of the overlay. Finally the directory is moved to the new location.
1146+
1147*on*;;
1148Redirects are enabled.
1149
1150*off*;;
1151Redirects are not created and only followed if "redirect_always_follow" feature is enabled in the kernel/module config.
1152
1153*follow*;;
1154Redirects are not created, but followed.
1155
1156*nofollow*;;
1157Redirects are not created and not followed (equivalent to "redirect_dir=off" if "redirect_always_follow" feature is not enabled).
1158
1159*index=*{**on**|**off**}::
1160Inode index. If this feature is disabled and a file with multiple hard links is copied up, then this will "break" the link. Changes will not be propagated to other names referring to the same inode.
1161
1162*uuid=*{**on**|**off**}::
1163Can be used to replace UUID of the underlying filesystem in file handles with null, and effectively disable UUID checks. This can be useful in case the underlying disk is copied and the UUID of this copy is changed. This is only applicable if all lower/upper/work directories are on the same filesystem, otherwise it will fallback to normal behaviour.
1164
1165*nfs_export=*{**on**|**off**}::
0197bdb2
KZ
1166When the underlying filesystems supports NFS export and the "nfs_export"
1167feature is enabled, an overlay filesystem may be exported to NFS.
1168+
256e524f 1169With the "nfs_export" feature, on copy_up of any lower object, an index entry
0197bdb2
KZ
1170is created under the index directory. The index entry name is the hexadecimal
1171representation of the copy up origin file handle. For a non-directory object,
1172the index entry is a hard link to the upper inode. For a directory object, the
1173index entry has an extended attribute "{**trusted**|**user**}.overlay.upper"
1174with an encoded file handle of the upper directory inode.
1175+
1176When encoding a file handle from an overlay filesystem object, the following rules apply;;
9fd75ae7 1177
0197bdb2
KZ
1178* For a non-upper object, encode a lower file handle from lower inode
1179* For an indexed object, encode a lower file handle from copy_up origin
1180* For a pure-upper object and for an existing non-indexed upper object, encode an upper file handle from upper inode
9fd75ae7 1181
0197bdb2
KZ
1182+
1183The encoded overlay file handle includes;;
9fd75ae7 1184
0197bdb2
KZ
1185* Header including path type information (e.g. lower/upper)
1186* UUID of the underlying filesystem
1187* Underlying filesystem encoding of underlying inode
9fd75ae7 1188
0197bdb2 1189+
bd67ca44 1190This encoding format is identical to the encoding format of file handles that are stored in extended attribute "{**trusted**|**user**}.overlay.origin". When decoding an overlay file handle, the following steps are followed;;
9fd75ae7 1191
0197bdb2
KZ
1192* Find underlying layer by UUID and path type information.
1193* Decode the underlying filesystem file handle to underlying dentry.
1194* For a lower file handle, lookup the handle in index directory by name.
256e524f 1195* If a whiteout is found in index, return **ESTALE**. This represents an overlay object that was deleted after its file handle was encoded.
0197bdb2
KZ
1196* For a non-directory, instantiate a disconnected overlay dentry from the decoded underlying dentry, the path type and index inode, if found.
1197* For a directory, use the connected underlying decoded dentry, path type and index, to lookup a connected overlay dentry.
9fd75ae7 1198
0197bdb2
KZ
1199+
1200--
1201Decoding a non-directory file handle may return a disconnected dentry. copy_up
1202of that disconnected dentry will create an upper index entry with no upper
1203alias.
1204
1205When overlay filesystem has multiple lower layers, a middle layer directory may
1206have a "redirect" to lower directory. Because middle layer "redirects" are not
1207indexed, a lower file handle that was encoded from the "redirect" origin
1208directory, cannot be used to find the middle or upper layer directory.
1209Similarly, a lower file handle that was encoded from a descendant of the
1210"redirect" origin directory, cannot be used to reconstruct a connected overlay
1211path. To mitigate the cases of directories that cannot be decoded from a lower
1212file handle, these directories are copied up on encode and encoded as an upper
1213file handle. On an overlay filesystem with no upper layer this mitigation
1214cannot be used NFS export in this setup requires turning off redirect follow
1215(e.g. "__redirect_dir=nofollow__").
9fd75ae7
T
1216
1217The overlay filesystem does not support non-directory connectable file handles, so exporting with the _subtree_check_ exportfs configuration will cause failures to lookup files over NFS.
1218
1219When the NFS export feature is enabled, all directory index entries are verified on mount time to check that upper file handles are not stale. This verification may cause significant overhead in some cases.
1220
0197bdb2
KZ
1221Note: the mount options __index=off,nfs_export=on__ are conflicting for a
1222read-write mount and will result in an error.
1223--
9fd75ae7 1224
344b0cd4 1225*xino=*{**on**|**off**|**auto**}::
9fd75ae7 1226The "xino" feature composes a unique object identifier from the real object st_ino and an underlying fsid index. The "xino" feature uses the high inode number bits for fsid, because the underlying filesystems rarely use the high inode number bits. In case the underlying inode number does overflow into the high xino bits, overlay filesystem will fall back to the non xino behavior for that inode.
0197bdb2 1227+
26c9eb35 1228For a detailed description of the effect of this option please refer to https://docs.kernel.org/filesystems/overlayfs.html
9fd75ae7
T
1229
1230*metacopy=*{**on**|**off**}::
1231When metadata only copy up feature is enabled, overlayfs will only copy up metadata (as opposed to whole file), when a metadata specific operation like chown/chmod is performed. Full file will be copied up later when file is opened for WRITE operation.
0197bdb2 1232+
9fd75ae7
T
1233In other words, this is delayed data copy up operation and data is copied up when there is a need to actually modify data.
1234
1235*volatile*::
1236Volatile mounts are not guaranteed to survive a crash. It is strongly recommended that volatile mounts are only used if data written to the overlay can be recreated without significant effort.
0197bdb2 1237+
9fd75ae7 1238The advantage of mounting with the "volatile" option is that all forms of sync calls to the upper filesystem are omitted.
0197bdb2 1239+
9fd75ae7 1240In order to avoid a giving a false sense of safety, the syncfs (and fsync) semantics of volatile mounts are slightly different than that of the rest of VFS. If any writeback error occurs on the upperdir’s filesystem after a volatile mount takes place, all sync functions will return an error. Once this condition is reached, the filesystem will not recover, and every subsequent sync call will return an error, even if the upperdir has not experience a new error since the last sync call.
0197bdb2 1241+
9fd75ae7
T
1242When overlay is mounted with "volatile" option, the directory "$workdir/work/incompat/volatile" is created. During next mount, overlay checks for this directory and refuses to mount if present. This is a strong indicator that user should throw away upper and work directories and create fresh one. In very limited cases where the user knows that the system has not crashed and contents of upperdir are intact, The "volatile" directory can be removed.
1243
14179682
MB
1244=== Mount options for reiserfs
1245
1246Reiserfs is a journaling filesystem.
1247
1248*conv*::
4eab78d3 1249Instructs version 3.6 reiserfs software to mount a version 3.5 filesystem, using the 3.6 format for newly created objects. This filesystem will no longer be compatible with reiserfs 3.5 tools.
14179682
MB
1250
1251*hash=*{**rupasov**|**tea**|**r5**|*detect*}::
4eab78d3
MB
1252Choose which hash function reiserfs will use to find files within directories.
1253+
1254*rupasov*;;
1255A hash invented by Yury Yu. Rupasov. It is fast and preserves locality, mapping lexicographically close file names to close hash values. This option should not be used, as it causes a high probability of hash collisions.
1256
1257*tea*;;
1258A Davis-Meyer function implemented by Jeremy Fitzhardinge. It uses hash permuting bits in the name. It gets high randomness and, therefore, low probability of hash collisions at some CPU cost. This may be used if *EHASHCOLLISION* errors are experienced with the r5 hash.
1259
1260*r5*;;
1261A modified version of the rupasov hash. It is used by default and is the best choice unless the filesystem has huge directories and unusual file-name patterns.
1262
1263*detect*;;
1264Instructs *mount* to detect which hash function is in use by examining the filesystem being mounted, and to write this information into the reiserfs superblock. This is only useful on the first mount of an old format filesystem.
14179682
MB
1265
1266*hashed_relocation*::
4eab78d3 1267Tunes the block allocator. This may provide performance improvements in some situations.
14179682
MB
1268
1269*no_unhashed_relocation*::
4eab78d3 1270Tunes the block allocator. This may provide performance improvements in some situations.
14179682
MB
1271
1272*noborder*::
4eab78d3 1273Disable the border allocator algorithm invented by Yury Yu. Rupasov. This may provide performance improvements in some situations.
14179682
MB
1274
1275*nolog*::
4eab78d3 1276Disable journaling. This will provide slight performance improvements in some situations at the cost of losing reiserfs's fast recovery from crashes. Even with this option turned on, reiserfs still performs all journaling operations, save for actual writes into its journaling area. Implementation of _nolog_ is a work in progress.
14179682
MB
1277
1278*notail*::
4eab78d3 1279By default, reiserfs stores small files and 'file tails' directly into its tree. This confuses some utilities such as *lilo*(8). This option is used to disable packing of files into the tree.
14179682
MB
1280
1281*replayonly*::
4eab78d3 1282Replay the transactions which are in the journal, but do not actually mount the filesystem. Mainly used by _reiserfsck_.
14179682
MB
1283
1284**resize=**__number__::
4eab78d3 1285A remount option which permits online expansion of reiserfs partitions. Instructs reiserfs to assume that the device has _number_ blocks. This option is designed for use with devices which are under logical volume management (LVM). There is a special _resizer_ utility which can be obtained from _ftp://ftp.namesys.com/pub/reiserfsprogs_.
14179682
MB
1286
1287*user_xattr*::
4eab78d3 1288Enable Extended User Attributes. See the *attr*(1) manual page.
14179682
MB
1289
1290*acl*::
4eab78d3 1291Enable POSIX Access Control Lists. See the *acl*(5) manual page.
14179682
MB
1292
1293*barrier=none* / *barrier=flush*::
4eab78d3 1294This disables / enables the use of write barriers in the journaling code. *barrier=none* disables, *barrier=flush* enables (default). This also requires an IO stack which can support barriers, and if reiserfs gets an error on a barrier write, it will disable barriers again with a warning. Write barriers enforce proper on-disk ordering of journal commits, making volatile disk write caches safe to use, at some performance penalty. If your disks are battery-backed in one way or another, disabling barriers may safely improve performance.
14179682
MB
1295
1296=== Mount options for ubifs
1297
1298UBIFS is a flash filesystem which works on top of UBI volumes. Note that *atime* is not supported and is always turned off.
1299
1300The device name may be specified as
1301
1302____
1303*ubiX_Y*::
1304 UBI device number *X*, volume number *Y*
1305*ubiY*::
1306 UBI device number *0*, volume number *Y*
1307*ubiX:NAME*::
1308 UBI device number *X*, volume with name *NAME*
1309*ubi:NAME*::
1310 UBI device number *0*, volume with name *NAME*
1311____
1312
1313Alternative *!* separator may be used instead of *:*.
1314
1315The following mount options are available:
1316
1317*bulk_read*::
4eab78d3 1318Enable bulk-read. VFS read-ahead is disabled because it slows down the filesystem. Bulk-Read is an internal optimization. Some flashes may read faster if the data are read at one go, rather than at several read requests. For example, OneNAND can do "read-while-load" if it reads more than one NAND page.
14179682
MB
1319
1320*no_bulk_read*::
4eab78d3 1321Do not bulk-read. This is the default.
14179682
MB
1322
1323*chk_data_crc*::
4eab78d3 1324Check data CRC-32 checksums. This is the default.
14179682
MB
1325
1326*no_chk_data_crc*::
4eab78d3 1327Do not check data CRC-32 checksums. With this option, the filesystem does not check CRC-32 checksum for data, but it does check it for the internal indexing information. This option only affects reading, not writing. CRC-32 is always calculated when writing the data.
14179682
MB
1328
1329*compr=*{**none**|**lzo**|*zlib*}::
4eab78d3 1330Select the default compressor which is used when new files are written. It is still possible to read compressed files if mounted with the *none* option.
14179682
MB
1331
1332=== Mount options for udf
1333
1334UDF is the "Universal Disk Format" filesystem defined by OSTA, the Optical Storage Technology Association, and is often used for DVD-ROM, frequently in the form of a hybrid UDF/ISO-9660 filesystem. It is, however, perfectly usable by itself on disk drives, flash drives and other block devices. See also _iso9660_.
1335
1336*uid=*::
4eab78d3 1337Make all files in the filesystem belong to the given user. uid=forget can be specified independently of (or usually in addition to) uid=<user> and results in UDF not storing uids to the media. In fact the recorded uid is the 32-bit overflow uid -1 as defined by the UDF standard. The value is given as either <user> which is a valid user name or the corresponding decimal user id, or the special string "forget".
14179682
MB
1338
1339*gid=*::
4eab78d3 1340Make all files in the filesystem belong to the given group. gid=forget can be specified independently of (or usually in addition to) gid=<group> and results in UDF not storing gids to the media. In fact the recorded gid is the 32-bit overflow gid -1 as defined by the UDF standard. The value is given as either <group> which is a valid group name or the corresponding decimal group id, or the special string "forget".
14179682
MB
1341
1342*umask=*::
4eab78d3 1343Mask out the given permissions from all inodes read from the filesystem. The value is given in octal.
14179682
MB
1344
1345*mode=*::
4eab78d3 1346If *mode=* is set the permissions of all non-directory inodes read from the filesystem will be set to the given mode. The value is given in octal.
14179682
MB
1347
1348*dmode=*::
4eab78d3 1349If *dmode=* is set the permissions of all directory inodes read from the filesystem will be set to the given dmode. The value is given in octal.
14179682
MB
1350
1351*bs=*::
4eab78d3
MB
1352Set the block size. Default value prior to kernel version 2.6.30 was 2048. Since 2.6.30 and prior to 4.11 it was logical device block size with fallback to 2048. Since 4.11 it is logical block size with fallback to any valid block size between logical device block size and 4096.
1353+
c83a52f0 1354For other details see the *mkudffs*(8) 2.0+ manpage, see the *COMPATIBILITY* and *BLOCK SIZE* sections.
14179682
MB
1355
1356*unhide*::
4eab78d3 1357Show otherwise hidden files.
14179682
MB
1358
1359*undelete*::
4eab78d3 1360Show deleted files in lists.
14179682
MB
1361
1362*adinicb*::
4eab78d3 1363Embed data in the inode. (default)
14179682
MB
1364
1365*noadinicb*::
4eab78d3 1366Don't embed data in the inode.
14179682
MB
1367
1368*shortad*::
4eab78d3 1369Use short UDF address descriptors.
14179682
MB
1370
1371*longad*::
4eab78d3 1372Use long UDF address descriptors. (default)
14179682
MB
1373
1374*nostrict*::
4eab78d3 1375Unset strict conformance.
14179682
MB
1376
1377*iocharset=*::
4eab78d3 1378Set the NLS character set. This requires kernel compiled with *CONFIG_UDF_NLS* option.
14179682
MB
1379
1380*utf8*::
4eab78d3 1381Set the UTF-8 character set.
14179682
MB
1382
1383=== Mount options for debugging and disaster recovery
1384
1385*novrs*::
4eab78d3 1386Ignore the Volume Recognition Sequence and attempt to mount anyway.
14179682
MB
1387
1388*session=*::
4eab78d3 1389Select the session number for multi-session recorded optical media. (default= last session)
14179682
MB
1390
1391*anchor=*::
4eab78d3 1392Override standard anchor location. (default= 256)
14179682
MB
1393
1394*lastblock=*::
4eab78d3 1395Set the last block of the filesystem.
14179682
MB
1396
1397=== Unused historical mount options that may be encountered and should be removed
1398
1399*uid=ignore*::
4eab78d3 1400Ignored, use uid=<user> instead.
14179682
MB
1401
1402*gid=ignore*::
4eab78d3 1403Ignored, use gid=<group> instead.
14179682
MB
1404
1405*volume=*::
4eab78d3 1406Unimplemented and ignored.
14179682
MB
1407
1408*partition=*::
4eab78d3 1409Unimplemented and ignored.
14179682
MB
1410
1411*fileset=*::
4eab78d3 1412Unimplemented and ignored.
14179682
MB
1413
1414*rootdir=*::
4eab78d3 1415Unimplemented and ignored.
14179682
MB
1416
1417=== Mount options for ufs
1418
1419**ufstype=**__value__::
4eab78d3
MB
1420UFS is a filesystem widely used in different operating systems. The problem are differences among implementations. Features of some implementations are undocumented, so its hard to recognize the type of ufs automatically. That's why the user must specify the type of ufs by mount option. Possible values are:
1421+
1422*old*;;
1423Old format of ufs, this is the default, read only. (Don't forget to give the *-r* option.)
1424
1425*44bsd*;;
1426For filesystems created by a BSD-like system (NetBSD, FreeBSD, OpenBSD).
1427
1428*ufs2*;;
1429Used in FreeBSD 5.x supported as read-write.
1430
1431*5xbsd*;;
1432Synonym for ufs2.
1433
1434*sun*;;
1435For filesystems created by SunOS or Solaris on Sparc.
1436
1437*sunx86*;;
1438For filesystems created by Solaris on x86.
1439
1440*hp*;;
1441For filesystems created by HP-UX, read-only.
1442
1443*nextstep*;;
1444For filesystems created by NeXTStep (on NeXT station) (currently read only).
1445
1446*nextstep-cd*;;
1447For NextStep CDROMs (block_size == 2048), read-only.
1448
1449*openstep*;;
bd67ca44 1450For filesystems created by OpenStep (currently read only). The same filesystem type is also used by macOS.
14179682
MB
1451
1452**onerror=**__value__::
4eab78d3
MB
1453Set behavior on error:
1454
1455*panic*;;
1456If an error is encountered, cause a kernel panic.
1457
1458[**lock**|**umount**|*repair*];;
1459These mount options don't do anything at present; when an error is encountered only a console message is printed.
14179682
MB
1460
1461=== Mount options for umsdos
1462
1463See mount options for msdos. The *dotsOK* option is explicitly killed by _umsdos_.
1464
1465=== Mount options for vfat
1466
1467First of all, the mount options for _fat_ are recognized. The *dotsOK* option is explicitly killed by _vfat_. Furthermore, there are
1468
1469*uni_xlate*::
4eab78d3 1470Translate unhandled Unicode characters to special escaped sequences. This lets you backup and restore filenames that are created with any Unicode characters. Without this option, a '?' is used when no translation is possible. The escape character is ':' because it is otherwise invalid on the vfat filesystem. The escape sequence that gets used, where u is the Unicode character, is: ':', (u & 0x3f), ((u>>6) & 0x3f), (u>>12).
14179682
MB
1471
1472*posix*::
4eab78d3 1473Allow two files with names that only differ in case. This option is obsolete.
14179682
MB
1474
1475*nonumtail*::
4eab78d3 1476First try to make a short name without sequence number, before trying _name~num.ext_.
14179682
MB
1477
1478*utf8*::
4eab78d3 1479UTF8 is the filesystem safe 8-bit encoding of Unicode that is used by the console. It can be enabled for the filesystem with this option or disabled with utf8=0, utf8=no or utf8=false. If _uni_xlate_ gets set, UTF8 gets disabled.
14179682
MB
1480
1481**shortname=**__mode__::
4eab78d3
MB
1482Defines the behavior for creation and display of filenames which fit into 8.3 characters. If a long name for a file exists, it will always be the preferred one for display. There are four __mode__s:
1483
1484*lower*;;
1485Force the short name to lower case upon display; store a long name when the short name is not all upper case.
1486
1487*win95*;;
1488Force the short name to upper case upon display; store a long name when the short name is not all upper case.
1489
1490*winnt*;;
1491Display the short name as is; store a long name when the short name is not all lower case or all upper case.
1492
1493*mixed*;;
1494Display the short name as is; store a long name when the short name is not all upper case. This mode is the default since Linux 2.6.32.
14179682
MB
1495
1496=== Mount options for usbfs
1497
1498**devuid=**__uid__ and **devgid=**__gid__ and **devmode=**__mode__::
4eab78d3 1499Set the owner and group and mode of the device files in the usbfs filesystem (default: uid=gid=0, mode=0644). The mode is given in octal.
14179682
MB
1500
1501**busuid=**__uid__ and **busgid=**__gid__ and **busmode=**__mode__::
4eab78d3 1502Set the owner and group and mode of the bus directories in the usbfs filesystem (default: uid=gid=0, mode=0555). The mode is given in octal.
14179682
MB
1503
1504**listuid=**__uid__ and **listgid=**__gid__ and **listmode=**__mode__::
4eab78d3 1505Set the owner and group and mode of the file _devices_ (default: uid=gid=0, mode=0444). The mode is given in octal.
14179682 1506
d9567bde 1507== DM-VERITY SUPPORT
14179682 1508
bd67ca44 1509The device-mapper verity target provides read-only transparent integrity checking of block devices using kernel crypto API. The *mount* command can open the dm-verity device and do the integrity verification before the device filesystem is mounted. Requires libcryptsetup with in libmount (optionally via *dlopen*(3)). If libcryptsetup supports extracting the root hash of an already mounted device, existing devices will be automatically reused in case of a match. Mount options for dm-verity:
14179682
MB
1510
1511**verity.hashdevice=**__path__::
4eab78d3 1512Path to the hash tree device associated with the source volume to pass to dm-verity.
14179682
MB
1513
1514**verity.roothash=**__hex__::
4eab78d3 1515Hex-encoded hash of the root of _verity.hashdevice_. Mutually exclusive with _verity.roothashfile._
14179682
MB
1516
1517**verity.roothashfile=**__path__::
4eab78d3 1518Path to file containing the hex-encoded hash of the root of _verity.hashdevice._ Mutually exclusive with _verity.roothash._
14179682
MB
1519
1520**verity.hashoffset=**__offset__::
4eab78d3 1521If the hash tree device is embedded in the source volume, _offset_ (default: 0) is used by dm-verity to get to the tree.
14179682
MB
1522
1523**verity.fecdevice=**__path__::
4eab78d3 1524Path to the Forward Error Correction (FEC) device associated with the source volume to pass to dm-verity. Optional. Requires kernel built with *CONFIG_DM_VERITY_FEC*.
14179682
MB
1525
1526**verity.fecoffset=**__offset__::
4eab78d3 1527If the FEC device is embedded in the source volume, _offset_ (default: 0) is used by dm-verity to get to the FEC area. Optional.
14179682
MB
1528
1529**verity.fecroots=**__value__::
4eab78d3 1530Parity bytes for FEC (default: 2). Optional.
14179682
MB
1531
1532**verity.roothashsig=**__path__::
4eab78d3 1533Path to *pkcs7*(1ssl) signature of root hash hex string. Requires crypt_activate_by_signed_key() from cryptsetup and kernel built with *CONFIG_DM_VERITY_VERIFY_ROOTHASH_SIG*. For device reuse, signatures have to be either used by all mounts of a device or by none. Optional.
14179682 1534
ce02babf
LB
1535**verity.oncorruption=**__ignore__|__restart__|__panic__::
1536Instruct the kernel to ignore, reboot or panic when corruption is detected. By default the I/O operation simply fails. Requires Linux 4.1 or newer, and libcrypsetup 2.3.4 or newer. Optional.
1537
14179682
MB
1538Supported since util-linux v2.35.
1539
1540For example commands:
1541
1542....
013bf9e3
LB
1543mksquashfs /etc /tmp/etc.raw
1544veritysetup format /tmp/etc.raw /tmp/etc.verity --root-hash-file=/tmp/etc.roothash
1545openssl smime -sign -in /tmp/etc.roothash -nocerts -inkey private.key \
c9c5933a 1546-signer private.crt -noattr -binary -outform der -out /tmp/etc.roothash.p7s
013bf9e3
LB
1547mount -o verity.hashdevice=/tmp/etc.verity,verity.roothashfile=/tmp/etc.roothash,\
1548verity.roothashsig=/tmp/etc.roothash.p7s /tmp/etc.raw /mnt
14179682
MB
1549....
1550
1551create squashfs image from _/etc_ directory, verity hash device and mount verified filesystem image to _/mnt_. The kernel will verify that the root hash is signed by a key from the kernel keyring if roothashsig is used.
1552
1553== LOOP-DEVICE SUPPORT
1554
1555One further possible type is a mount via the loop device. For example, the command
1556
1557____
1558*mount /tmp/disk.img /mnt -t vfat -o loop=/dev/loop3*
1559____
1560
1561will set up the loop device _/dev/loop3_ to correspond to the file _/tmp/disk.img_, and then mount this device on _/mnt_.
1562
4eab78d3 1563If no explicit loop device is mentioned (but just an option '**-o loop**' is given), then *mount* will try to find some unused loop device and use that, for example
14179682
MB
1564
1565____
1566*mount /tmp/disk.img /mnt -o loop*
1567____
1568
1569The *mount* command *automatically* creates a loop device from a regular file if a filesystem type is not specified or the filesystem is known for libblkid, for example:
1570
1571____
1572*mount /tmp/disk.img /mnt*
1573
1574*mount -t ext4 /tmp/disk.img /mnt*
1575____
1576
544e64e0 1577This type of mount knows about three options, namely *loop*, *offset* and *sizelimit*, that are really options to *losetup*(8). (These options can be used in addition to those specific to the filesystem type.)
14179682
MB
1578
1579Since Linux 2.6.25 auto-destruction of loop devices is supported, meaning that any loop device allocated by *mount* will be freed by *umount* independently of _/etc/mtab_.
1580
1581You can also free a loop device by hand, using *losetup -d* or *umount -d*.
1582
1583Since util-linux v2.29, *mount* re-uses the loop device rather than initializing a new device if the same backing file is already used for some loop device with the same offset and sizelimit. This is necessary to avoid a filesystem corruption.
1584
1585== EXIT STATUS
1586
1587*mount* has the following exit status values (the bits can be ORed):
1588
1589*0*::
4eab78d3 1590success
14179682
MB
1591
1592*1*::
4eab78d3 1593incorrect invocation or permissions
14179682
MB
1594
1595*2*::
4eab78d3 1596system error (out of memory, cannot fork, no more loop devices)
14179682
MB
1597
1598*4*::
4eab78d3 1599internal *mount* bug
14179682
MB
1600
1601*8*::
4eab78d3 1602user interrupt
14179682
MB
1603
1604*16*::
4eab78d3 1605problems writing or locking _/etc/mtab_
14179682
MB
1606
1607*32*::
4eab78d3 1608mount failure
14179682
MB
1609
1610*64*::
4eab78d3
MB
1611some mount succeeded
1612+
1613The command *mount -a* returns 0 (all succeeded), 32 (all failed), or 64 (some failed, some succeeded).
14179682
MB
1614
1615== EXTERNAL HELPERS
1616
1617The syntax of external mount helpers is:
1618
1619**/sbin/mount.**__suffix__ _spec dir_ [*-sfnv*] [*-N* _namespace_] [*-o* _options_] [*-t* __type__**.**_subtype_]
1620
1621where the _suffix_ is the filesystem type and the *-sfnvoN* options have the same meaning as the normal mount options. The *-t* option is used for filesystems with subtypes support (for example */sbin/mount.fuse -t fuse.sshfs*).
1622
1623The command *mount* does not pass the mount options *unbindable*, *runbindable*, *private*, *rprivate*, *slave*, *rslave*, *shared*, *rshared*, *auto*, *noauto*, *comment*, *x-**, *loop*, *offset* and *sizelimit* to the mount.<suffix> helpers. All other options are used in a comma-separated list as an argument to the *-o* option.
1624
1625== ENVIRONMENT
1626
fd6b4d94 1627*LIBMOUNT_FORCE_MOUNT2*={always|never|auto}::
cc3edae7 1628force to use classic *mount*(2) system call (requires support for new file descriptors based mount API). The default is *auto*; in this case, libmount tries to be smart and use classic *mount*(2) only for well-known issues. If the new mount API is unavailable, libmount can still use traditional *mount*(2), although LIBMOUNT_FORCE_MOUNT2 is set to *never*.
fd6b4d94 1629
e6743239 1630*LIBMOUNT_FSTAB*=<path>::
4eab78d3 1631overrides the default location of the _fstab_ file (ignored for suid)
14179682 1632
e6743239 1633*LIBMOUNT_DEBUG*=all::
4eab78d3 1634enables libmount debug output
14179682 1635
e6743239 1636*LIBBLKID_DEBUG*=all::
4eab78d3 1637enables libblkid debug output
14179682 1638
e6743239 1639*LOOPDEV_DEBUG*=all::
4eab78d3 1640enables loop device setup debug output
14179682
MB
1641
1642== FILES
1643
1644See also "*The files /etc/fstab, /etc/mtab and /proc/mounts*" section above.
1645
1646_/etc/fstab_::
4eab78d3 1647filesystem table
14179682
MB
1648
1649_/run/mount_::
4eab78d3 1650libmount private runtime directory
14179682
MB
1651
1652_/etc/mtab_::
4eab78d3 1653table of mounted filesystems or symlink to _/proc/mounts_
14179682
MB
1654
1655_/etc/mtab~_::
4eab78d3 1656lock file (unused on systems with _mtab_ symlink)
14179682
MB
1657
1658_/etc/mtab.tmp_::
4eab78d3 1659temporary file (unused on systems with _mtab_ symlink)
14179682
MB
1660
1661_/etc/filesystems_::
4eab78d3 1662a list of filesystem types to try
14179682
MB
1663
1664== HISTORY
1665
1666A *mount* command existed in Version 5 AT&T UNIX.
1667
1668== BUGS
1669
1670It is possible for a corrupted filesystem to cause a crash.
1671
1672Some Linux filesystems don't support *-o sync* and *-o dirsync* (the ext2, ext3, ext4, fat and vfat filesystems _do_ support synchronous updates (a la BSD) when mounted with the *sync* option).
1673
1674The *-o remount* may not be able to change mount parameters (all _ext2fs_-specific parameters, except *sb*, are changeable with a remount, for example, but you can't change *gid* or *umask* for the _fatfs_).
1675
1676It is possible that the files _/etc/mtab_ and _/proc/mounts_ don't match on systems with a regular _mtab_ file. The first file is based only on the *mount* command options, but the content of the second file also depends on the kernel and others settings (e.g. on a remote NFS server -- in certain cases the *mount* command may report unreliable information about an NFS mount point and the _/proc/mount_ file usually contains more reliable information.) This is another reason to replace the _mtab_ file with a symlink to the _/proc/mounts_ file.
1677
1678Checking files on NFS filesystems referenced by file descriptors (i.e. the *fcntl* and *ioctl* families of functions) may lead to inconsistent results due to the lack of a consistency check in the kernel even if the *noac* mount option is used.
1679
4eab78d3 1680The *loop* option with the *offset* or *sizelimit* options used may fail when using older kernels if the *mount* command can't confirm that the size of the block device has been configured as requested. This situation can be worked around by using the *losetup*(8) command manually before calling *mount* with the configured loop device.
14179682
MB
1681
1682== AUTHORS
1683
1684mailto:kzak@redhat.com[Karel Zak]
1685
1686== SEE ALSO
1687
14179682
MB
1688*mount*(2),
1689*umount*(2),
1690*filesystems*(5),
1691*fstab*(5),
1692*nfs*(5),
1693*xfs*(5),
1694*mount_namespaces*(7),
1695*xattr*(7),
1696*e2label*(8),
1697*findmnt*(8),
1698*losetup*(8),
5723eae7 1699*lsblk*(8),
14179682
MB
1700*mke2fs*(8),
1701*mountd*(8),
1702*nfsd*(8),
1703*swapon*(8),
1704*tune2fs*(8),
1705*umount*(8),
1706*xfs_admin*(8)
1707
625e9c61 1708include::man-common/bugreports.adoc[]
14179682 1709
625e9c61 1710include::man-common/footer.adoc[]
14179682
MB
1711
1712ifdef::translation[]
625e9c61 1713include::man-common/translation.adoc[]
14179682 1714endif::[]