]> git.ipfire.org Git - thirdparty/util-linux.git/blame - sys-utils/mount.8.adoc
libmount: improve debug messages
[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
MB
186
187=== Bind mount operation
188
189Remount part of the file hierarchy somewhere else. The call is:
190
191____
192*mount --bind* _olddir newdir_
193____
194
195or by using this _fstab_ entry:
196
197____
198**/**__olddir__ **/**__newdir__ *none bind*
199____
200
201After this call the same contents are accessible in two places.
202
203It 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.
204
205One 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:
206
207____
208*mount --bind foo foo*
209____
210
211The 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:
212
213____
214*mount --rbind* _olddir newdir_
215____
216
217Note 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.
218
219Since util-linux 2.27 *mount* permits changing the mount options by passing the relevant options along with *--bind*. For example:
220
221____
222*mount -o bind,ro foo foo*
223____
224
225This 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.
226
227The alternative (classic) way to create a read-only bind mount is to use the remount operation, for example:
228
229____
355d3ef7
KZ
230*mount --bind* _olddir newdir_
231
232*mount -o remount,bind,ro* _olddir newdir_
14179682
MB
233____
234
235Note 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.
236
36a3923c 237It'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. It's impossible to change mount options recursively (for example with *-o rbind,ro*).
14179682 238
bd67ca44 239Since 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
MB
240
241=== The move operation
242
243Move a *mounted tree* to another place (atomically). The call is:
244
245____
246*mount --move* _olddir newdir_
247____
248
249This 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.
250
251Note 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.
252
253=== Shared subtree operations
254
255Since 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).
256
257Supported operations are:
258
259....
260mount --make-shared mountpoint
261mount --make-slave mountpoint
262mount --make-private mountpoint
263mount --make-unbindable mountpoint
264....
265
266The following commands allow one to recursively change the type of all the mounts under a given mountpoint.
267
268....
269mount --make-rshared mountpoint
270mount --make-rslave mountpoint
271mount --make-rprivate mountpoint
272mount --make-runbindable mountpoint
273....
274
bd67ca44 275*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
276
277Note 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.
278
6e68b841 279Since 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
280
281For example:
282
283....
284mount --make-private --make-unbindable /dev/sda1 /foo
285....
286
287is the same as:
288
289....
290mount /dev/sda1 /foo
291mount --make-private /foo
292mount --make-unbindable /foo
293....
294
295== COMMAND-LINE OPTIONS
296
297The 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.
298
c83a52f0 299The *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
300
301Command-line options available for the *mount* command are:
302
303*-a*, *--all*::
4eab78d3
MB
304Mount 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.
305+
344b0cd4 306The 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 307+
4eab78d3
MB
308The 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.
309+
344b0cd4 310Since 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
311+
312Note that it is a bad practice to use *mount -a* for _fstab_ checking. The recommended solution is *findmnt --verify*.
14179682
MB
313
314*-B*, *--bind*::
ebb107bc 315Remount a subtree somewhere else (so that its contents are available in both places). See above, under *Bind mount operation*.
14179682
MB
316
317*-c*, *--no-canonicalize*::
4eab78d3
MB
318Don'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.
319+
320Note that *mount* does not pass this option to the **/sbin/mount.**__type__ helpers.
14179682
MB
321
322*-F*, *--fork*::
4eab78d3 323(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
324
325*-f, --fake*::
4eab78d3 326Causes everything to be done except for the actual system call; if it's not obvious, this "fakes" mounting the filesystem. This option is useful in conjunction with the *-v* flag to determine what the *mount* command is trying to do. It can also be used to add entries for devices that were mounted earlier with the *-n* option. The *-f* option checks for an existing record in _/etc/mtab_ and fails when the record already exists (with a regular non-fake mount, this check is done by the kernel).
14179682
MB
327
328*-i, --internal-only*::
4eab78d3 329Don't call the **/sbin/mount.**__filesystem__ helper even if it exists.
14179682
MB
330
331*-L*, *--label* _label_::
4eab78d3 332Mount the partition that has the specified _label_.
14179682
MB
333
334*-l*, *--show-labels*::
4eab78d3 335Add 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
336
337*-M*, *--move*::
4eab78d3 338Move a subtree to some other place. See above, the subsection *The move operation*.
14179682 339
5a72054b
KZ
340*-m*, **--mkdir**[=__mode__]::
341Allow 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.
342
14179682 343*-n*, *--no-mtab*::
4eab78d3 344Mount without writing in _/etc/mtab_. This is necessary for example when _/etc_ is on a read-only filesystem.
14179682
MB
345
346*-N*, *--namespace* _ns_::
4eab78d3
MB
347Perform 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.
348+
bd67ca44 349*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
350+
351See *mount_namespaces*(7) for more information.
14179682
MB
352
353*-O*, *--test-opts* _opts_::
4eab78d3
MB
354Limit 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
355+
356*mount -a -O no_netdev*
357+
358mounts all filesystems except those which have the option _netdev_ specified in the options field in the _/etc/fstab_ file.
359+
360It 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.
361+
362The *-t* and *-O* options are cumulative in effect; that is, the command
363+
364*mount -a -t ext2 -O _netdev*
365+
366mounts all ext2 filesystems with the _netdev option, not all filesystems that are either ext2 or have the _netdev option specified.
14179682
MB
367
368*-o*, *--options* _opts_::
4eab78d3
MB
369Use the specified mount options. The _opts_ argument is a comma-separated list. For example:
370+
371*mount LABEL=mydisk -o noatime,nodev,nosuid*
372+
373For more details, see the *FILESYSTEM-INDEPENDENT MOUNT OPTIONS* and *FILESYSTEM-SPECIFIC MOUNT OPTIONS* sections.
14179682 374
3d1c41c8
KZ
375*--onlyonce*::
376Forces 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).
377
14179682 378*--options-mode* _mode_::
4eab78d3 379Controls 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
380
381*--options-source* _source_::
bd67ca44 382Source 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
383
384*--options-source-force*::
4eab78d3 385Use options from _fstab_/_mtab_ even if both _device_ and _dir_ are specified.
14179682
MB
386
387*-R*, *--rbind*::
ebb107bc 388Remount 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
389
390*-r*, *--read-only*::
4eab78d3
MB
391Mount the filesystem read-only. A synonym is *-o ro*.
392+
393Note 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
394
395*-s*::
4eab78d3 396Tolerate 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
397
398*--source* _device_::
4eab78d3 399If 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
400
401*--target* _directory_::
4eab78d3 402If 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
403
404*--target-prefix* _directory_::
4eab78d3
MB
405Prepend 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:
406+
407*mount --all --target-prefix /chroot -o X-mount.mkdir*
408+
409mounts 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
410
411*-T*, *--fstab* _path_::
4eab78d3
MB
412Specifies 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.
413+
414Note 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
415
416*-t*, *--types* _fstype_::
4eab78d3
MB
417The 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.
418+
419The 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).
420+
421If 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*.
422//TRANSLATORS: Keep {asterisk} untranslated.
423+
424The *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.
425+
426More 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.
427+
428The prefix *no* can be meaningful with the *-a* option. For example, the command
429+
430*mount -a -t nomsdos,smbfs*
431+
432mounts all filesystems except those of type _msdos_ and _smbfs_.
433+
434For 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
435
436*-U*, *--uuid* _uuid_::
4eab78d3 437Mount the partition that has the specified _uuid_.
14179682
MB
438
439*-v*, *--verbose*::
4eab78d3 440Verbose mode.
14179682
MB
441
442*-w*, *--rw*, *--read-write*::
6ccd33fb 443Mount 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
444+
445A synonym is *-o rw*.
446+
447Note 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 448
2b2d3172 449include::man-common/help-version.adoc[]
14179682
MB
450
451== FILESYSTEM-INDEPENDENT MOUNT OPTIONS
452
453Some of these options are only useful when they appear in the _/etc/fstab_ file.
454
f5c68982 455Some 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 456
4eab78d3 457The 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
458
459*async*::
4eab78d3 460All I/O to the filesystem should be done asynchronously. (See also the *sync* option.)
14179682
MB
461
462*atime*::
544e64e0 463Do 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
464
465*noatime*::
544e64e0 466Do 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
467
468*auto*::
4eab78d3 469Can be mounted with the *-a* option.
14179682
MB
470
471*noauto*::
4eab78d3 472Can only be mounted explicitly (i.e., the *-a* option will not cause the filesystem to be mounted).
14179682 473
f933e53c 474**context=**__context__, **fscontext=**__context__, **defcontext=**__context__, and **rootcontext=**__context__::
4eab78d3
MB
475The *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.
476+
f933e53c 477A commonly used option for removable media is *context="system_u:object_r:removable_t*.
4eab78d3 478+
4eab78d3
MB
479The *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.
480+
e08e3d58 481You 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
MB
482+
483The *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.
484+
485Note that the kernel rejects any remount request that includes the context option, *even* when unchanged from the current context.
486+
487*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:
488____
489mount -t tmpfs none /mnt -o \
490'context="system_u:object_r:tmp_t:s0:c127,c456",noexec'
491____
492
493For more details, see *selinux*(8).
14179682
MB
494
495*defaults*::
4eab78d3
MB
496Use the default options: *rw*, *suid*, *dev*, *exec*, *auto*, *nouser*, and *async*.
497+
498Note 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
499
500*dev*::
4eab78d3 501Interpret character or block special devices on the filesystem.
14179682
MB
502
503*nodev*::
4eab78d3 504Do not interpret character or block special devices on the filesystem.
14179682
MB
505
506*diratime*::
4eab78d3 507Update directory inode access times on this filesystem. This is the default. (This option is ignored when *noatime* is set.)
14179682
MB
508
509*nodiratime*::
4eab78d3 510Do not update directory inode access times on this filesystem. (This option is implied when *noatime* is set.)
14179682
MB
511
512*dirsync*::
4eab78d3 513All 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
514
515*exec*::
bd67ca44 516Permit execution of binaries and other executable files.
14179682
MB
517
518*noexec*::
4eab78d3 519Do not permit direct execution of any binaries on the mounted filesystem.
14179682
MB
520
521*group*::
4eab78d3 522Allow 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
523
524*iversion*::
4eab78d3 525Every time the inode is modified, the i_version field will be incremented.
14179682
MB
526
527*noiversion*::
4eab78d3 528Do not increment the i_version inode field.
14179682
MB
529
530*mand*::
c3ea860b 531Allow mandatory locks on this filesystem. See *fcntl*(2). This option was deprecated in Linux 5.15.
14179682
MB
532
533*nomand*::
4eab78d3 534Do not allow mandatory locks on this filesystem.
14179682
MB
535
536*_netdev*::
4eab78d3 537The 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
538
539*nofail*::
4eab78d3 540Do not report errors for this device if it does not exist.
14179682
MB
541
542*relatime*::
544e64e0 543Update inode access times relative to modify or change time. Access time is only updated if the previous access time was earlier than 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 544+
f933e53c 545Since 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
546
547*norelatime*::
4eab78d3 548Do not use the *relatime* feature. See also the *strictatime* mount option.
14179682
MB
549
550*strictatime*::
f933e53c 551Allows 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
552
553*nostrictatime*::
4eab78d3 554Use the kernel's default behavior for inode access time updates.
14179682
MB
555
556*lazytime*::
4eab78d3
MB
557Only update times (atime, mtime, ctime) on the in-memory version of the file inode.
558+
559This mount option significantly reduces writes to the inode table for workloads that perform frequent random writes to preallocated files.
560+
561The on-disk timestamps are updated only when:
562+
563* the inode needs to be updated for some change unrelated to file timestamps
564* the application employs *fsync*(2), *syncfs*(2), or *sync*(2)
565* an undeleted inode is evicted from memory
566* more than 24 hours have passed since the inode was written to disk.
14179682
MB
567
568*nolazytime*::
4eab78d3 569Do not use the lazytime feature.
14179682
MB
570
571*suid*::
4eab78d3 572Honor set-user-ID and set-group-ID bits or file capabilities when executing programs from this filesystem.
14179682
MB
573
574*nosuid*::
344b0cd4 575Do 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
576
577*silent*::
4eab78d3 578Turn on the silent flag.
14179682
MB
579
580*loud*::
4eab78d3 581Turn off the silent flag.
14179682
MB
582
583*owner*::
4eab78d3 584Allow 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
585
586*remount*::
4eab78d3
MB
587Attempt 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.
588+
ebb107bc 589The remount operation together with the *bind* flag has special semantics. See above, the subsection *Bind mount operation*.
4eab78d3
MB
590+
591The 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.
592+
593*mount -o remount,rw /dev/foo /dir*
594+
bd67ca44 595After 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
596+
597*mount -o remount,rw /dir*
598+
e6743239 599After 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 a remount with unspecified source is allowed.
4eab78d3
MB
600+
601*mount* allows the use of *--all* to remount all already mounted filesystems which match a specified filter (*-O* and *-t*). For example:
602+
603*mount --all -o remount,ro -t vfat*
604+
bd67ca44 605remounts 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
606
607*ro*::
4eab78d3 608Mount the filesystem read-only.
14179682
MB
609
610*rw*::
4eab78d3 611Mount the filesystem read-write.
14179682
MB
612
613*sync*::
4eab78d3 614All 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
615
616*user*::
4eab78d3 617Allow 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
618
619*nouser*::
4eab78d3 620Forbid an ordinary user to mount the filesystem. This is the default; it does not imply any other options.
14179682
MB
621
622*users*::
4eab78d3 623Allow 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
624
625*X-**::
4eab78d3 626All 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
627
628*x-**::
4eab78d3
MB
629The 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).
630+
631Note 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
MB
632
633*X-mount.mkdir*[=_mode_]::
bd67ca44 634Allow 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 635
e311e731 636**X-mount.subdir=**__directory__::
6ccd33fb 637Allow 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. This feature is EXPERIMENTAL.
e311e731 638
722c9697 639*X-mount.owner*=_username_|_UID_, *X-mount.group*=_group_|_GID_::
640Set _mountpoint_'s ownership after mounting. Names resolved in the target mount namespace, see *-N*.
641
642*X-mount.mode*=_mode_::
643Set _mountpoint_'s mode after mounting.
644
14179682 645*nosymfollow*::
4eab78d3 646Do 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
647
648== FILESYSTEM-SPECIFIC MOUNT OPTIONS
649
650This 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.
651
652[cols=",",options="header",]
653|===
654|*Filesystem(s)* |*Manual page*
655|btrfs |*btrfs*(5)
656|cifs |*mount.cifs*(8)
657|ext2, ext3, ext4 |*ext4*(5)
658|fuse |*fuse*(8)
659|nfs |*nfs*(5)
660|tmpfs |*tmpfs*(5)
661|xfs |*xfs*(5)
662|===
663
664Note that some of the pages listed above might be available only after you install the respective userland tools.
665
666The following options apply only to certain filesystems. We sort them by filesystem. All options follow the *-o* flag.
667
668What 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_.
669
670=== Mount options for adfs
671
672**uid=**__value__ and **gid=**__value__::
4eab78d3 673Set the owner and group of the files in the filesystem (default: uid=gid=0).
14179682
MB
674
675**ownmask=**__value__ and **othmask=**__value__::
4eab78d3 676Set 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
677
678=== Mount options for affs
679
680**uid=**__value__ and **gid=**__value__::
4eab78d3 681Set 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
682
683**setuid=**__value__ and **setgid=**__value__::
4eab78d3 684Set the owner and group of all files.
14179682
MB
685
686**mode=**__value__::
4eab78d3 687Set 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
688
689*protect*::
4eab78d3 690Do not allow any changes to the protection bits on the filesystem.
14179682
MB
691
692*usemp*::
4eab78d3 693Set 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
694
695*verbose*::
4eab78d3 696Print an informational message for each successful mount.
14179682
MB
697
698**prefix=**__string__::
4eab78d3 699Prefix used before volume name, when following a link.
14179682
MB
700
701**volume=**__string__::
4eab78d3 702Prefix (of length at most 30) used before '/' when following a symbolic link.
14179682
MB
703
704**reserved=**__value__::
4eab78d3 705(Default: 2.) Number of unused blocks at the start of the device.
14179682
MB
706
707**root=**__value__::
4eab78d3 708Give explicitly the location of the root block.
14179682
MB
709
710**bs=**__value__::
4eab78d3 711Give blocksize. Allowed values are 512, 1024, 2048, 4096.
14179682
MB
712
713**grpquota**|**noquota**|**quota**|*usrquota*::
4eab78d3 714These options are accepted but ignored. (However, quota utilities may react to such strings in _/etc/fstab_.)
14179682
MB
715
716=== Mount options for debugfs
717
718The debugfs filesystem is a pseudo filesystem, traditionally mounted on _/sys/kernel/debug_. As of kernel version 3.4, debugfs has the following options:
719
720**uid=**__n__**, gid=**__n__::
4eab78d3 721Set the owner and group of the mountpoint.
14179682
MB
722
723**mode=**__value__::
4eab78d3 724Sets the mode of the mountpoint.
14179682
MB
725
726=== Mount options for devpts
727
728The 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>.
729
730**uid=**__value__ and **gid=**__value__::
4eab78d3 731This 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
732
733**mode=**__value__::
4eab78d3 734Set 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
735
736*newinstance*::
4eab78d3
MB
737Create 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.
738+
739All 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.
740+
741This 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.
742+
743To 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
744
745**ptmxmode=**__value__::
4eab78d3
MB
746Set the mode for the new _ptmx_ device node in the devpts filesystem.
747+
748With 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_).
749+
750For 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.
751+
752This 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
753
754=== Mount options for fat
755
756(Note: _fat_ is not a separate filesystem, but a common part of the _msdos_, _umsdos_ and _vfat_ filesystems.)
757
758*blocksize=*{**512**|**1024**|*2048*}::
4eab78d3 759Set blocksize (default 512). This option is obsolete.
14179682
MB
760
761**uid=**__value__ and **gid=**__value__::
4eab78d3 762Set the owner and group of all files. (Default: the UID and GID of the current process.)
14179682
MB
763
764**umask=**__value__::
4eab78d3 765Set 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
766
767**dmask=**__value__::
4eab78d3 768Set the umask applied to directories only. The default is the umask of the current process. The value is given in octal.
14179682
MB
769
770**fmask=**__value__::
4eab78d3 771Set the umask applied to regular files only. The default is the umask of the current process. The value is given in octal.
14179682
MB
772
773**allow_utime=**__value__::
4eab78d3 774This option controls the permission check of mtime/atime.
9637ed96
MB
775
776*20*;;
4eab78d3 777If current process is in group of file's group ID, you can change timestamp.
9637ed96
MB
778
779*2*;;
4eab78d3 780Other users can change timestamp.
14179682 781
4eab78d3 782The default is set from 'dmask' option. (If the directory is writable, *utime*(2) is also allowed. I.e. ~dmask & 022)
14179682
MB
783
784Normally *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.
785
786**check=**__value__::
4eab78d3 787Three different levels of pickiness can be chosen:
9637ed96
MB
788
789*r*[*elaxed*];;
4eab78d3 790Upper 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
791
792*n*[*ormal*];;
4eab78d3 793Like "relaxed", but many special characters (*, ?, <, spaces, etc.) are rejected. This is the default.
9637ed96
MB
794
795*s*[*trict*];;
4eab78d3 796Like "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
797
798**codepage=**__value__::
4eab78d3 799Sets the codepage for converting to shortname characters on FAT and VFAT filesystems. By default, codepage 437 is used.
14179682
MB
800
801**conv=**__mode__::
4eab78d3 802This option is obsolete and may fail or be ignored.
14179682
MB
803
804**cvf_format=**__module__::
bd67ca44 805Forces 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
806
807**cvf_option=**__option__::
4eab78d3 808Option passed to the CVF module. This option is obsolete.
14179682
MB
809
810*debug*::
4eab78d3 811Turn 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
812
813*discard*::
4eab78d3 814If 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
815
816*dos1xfloppy*::
4eab78d3 817If 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
818
819*errors=*{**panic**|**continue**|*remount-ro*}::
4eab78d3 820Specify FAT behavior on critical errors: panic, continue without doing anything, or remount the partition in read-only mode (default behavior).
14179682
MB
821
822*fat=*{**12**|**16**|*32*}::
4eab78d3 823Specify a 12, 16 or 32 bit fat. This overrides the automatic FAT type detection routine. Use with caution!
14179682
MB
824
825**iocharset=**__value__::
4eab78d3 826Character 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
827
828*nfs=*{**stale_rw**|*nostale_ro*}::
4eab78d3
MB
829Enable this only if you want to export the FAT filesystem over NFS.
830+
831*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.
832+
833*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.
834+
835To maintain backward compatibility, *-o nfs* is also accepted, defaulting to *stale_rw*.
14179682
MB
836
837*tz=UTC*::
4eab78d3 838This 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
839
840**time_offset=**__minutes__::
4eab78d3 841Set 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
842
843*quiet*::
4eab78d3 844Turn on the _quiet_ flag. Attempts to chown or chmod files do not return errors, although they fail. Use with caution!
14179682
MB
845
846*rodir*::
4eab78d3
MB
847FAT 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).
848+
849If you want to use *ATTR_RO* as read-only flag even for the directory, set this option.
14179682
MB
850
851*showexec*::
4eab78d3 852If 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
853
854*sys_immutable*::
4eab78d3 855If set, *ATTR_SYS* attribute on FAT is handled as *IMMUTABLE* flag on Linux. Not set by default.
14179682
MB
856
857*flush*::
4eab78d3 858If set, the filesystem will try to flush to disk more early than normal. Not set by default.
14179682
MB
859
860*usefree*::
4eab78d3 861Use 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
862
863*dots*, *nodots*, *dotsOK=*[**yes**|*no*]::
4eab78d3 864Various misguided attempts to force Unix or DOS conventions onto a FAT filesystem.
14179682
MB
865
866=== Mount options for hfs
867
868**creator=**__cccc__**, type=**__cccc__::
4eab78d3 869Set the creator/type values as shown by the MacOS finder used for creating new files. Default values: '????'.
14179682
MB
870
871**uid=**__n__**, gid=**__n__::
4eab78d3 872Set the owner and group of all files. (Default: the UID and GID of the current process.)
14179682
MB
873
874**dir_umask=**__n__**, file_umask=**__n__**, umask=**__n__::
4eab78d3 875Set the umask used for all directories, all regular files, or all files and directories. Defaults to the umask of the current process.
14179682
MB
876
877**session=**__n__::
4eab78d3 878Select 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
879
880**part=**__n__::
4eab78d3 881Select partition number n from the device. Only makes sense for CDROMs. Defaults to not parsing the partition table at all.
14179682
MB
882
883*quiet*::
4eab78d3 884Don't complain about invalid mount options.
14179682
MB
885
886=== Mount options for hpfs
887
888**uid=**__value__ and **gid=**__value__::
4eab78d3 889Set the owner and group of all files. (Default: the UID and GID of the current process.)
14179682
MB
890
891**umask=**__value__::
4eab78d3 892Set 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
893
894*case=*{**lower**|*asis*}::
4eab78d3 895Convert all files names to lower case, or leave them. (Default: *case=lower*.)
14179682
MB
896
897**conv=**__mode__::
4eab78d3 898This option is obsolete and may fail or being ignored.
14179682
MB
899
900*nocheck*::
4eab78d3 901Do not abort mounting when certain consistency checks fail.
14179682
MB
902
903=== Mount options for iso9660
904
905ISO 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.)
906
907Normal _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.
908
909Rock 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).
910
911*norock*::
4eab78d3 912Disable the use of Rock Ridge extensions, even if available. Cf. *map*.
14179682
MB
913
914*nojoliet*::
4eab78d3 915Disable the use of Microsoft Joliet extensions, even if available. Cf. *map*.
14179682
MB
916
917*check=*{*r*[*elaxed*]|*s*[*trict*]}::
4eab78d3 918With *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
919
920**uid=**__value__ and **gid=**__value__::
4eab78d3 921Give 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
922
923*map=*{*n*[*ormal*]|*o*[*ff*]|*a*[*corn*]}::
4eab78d3 924For 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
925
926**mode=**__value__::
4eab78d3 927For 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
928
929*unhide*::
4eab78d3 930Also 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
931
932*block=*{**512**|**1024**|*2048*}::
4eab78d3 933Set the block size to the indicated value. (Default: *block=1024*.)
14179682
MB
934
935**conv=**__mode__::
4eab78d3 936This option is obsolete and may fail or being ignored.
14179682
MB
937
938*cruft*::
b53360d8 939If 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
940
941**session=**__x__::
4eab78d3 942Select number of session on a multisession CD.
14179682
MB
943
944**sbsector=**__xxx__::
4eab78d3 945Session begins from sector xxx.
14179682
MB
946
947The following options are the same as for vfat and specifying them only makes sense when using discs encoded using Microsoft's Joliet extensions.
948
949**iocharset=**__value__::
4eab78d3 950Character set to use for converting 16 bit Unicode characters on CD to 8 bit characters. The default is iso8859-1.
14179682
MB
951
952*utf8*::
4eab78d3 953Convert 16 bit Unicode characters on CD to UTF-8.
14179682
MB
954
955=== Mount options for jfs
956
957**iocharset=**__name__::
4eab78d3 958Character 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
959
960**resize=**__value__::
4eab78d3 961Resize 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
962
963*nointegrity*::
4eab78d3 964Do 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
965
966*integrity*::
4eab78d3 967Default. 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
968
969*errors=*{**continue**|**remount-ro**|*panic*}::
4eab78d3 970Define 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
971
972**noquota**|**quota**|**usrquota**|*grpquota*::
4eab78d3 973These options are accepted but ignored.
14179682
MB
974
975=== Mount options for msdos
976
977See 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.
978
979=== Mount options for ncpfs
980
bd67ca44 981Just 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
982
983=== Mount options for ntfs
984
985**iocharset=**__name__::
4eab78d3 986Character set to use when returning file names. Unlike VFAT, NTFS suppresses names that contain nonconvertible characters. Deprecated.
14179682
MB
987
988**nls=**__name__::
4eab78d3 989New name for the option earlier called _iocharset_.
14179682
MB
990
991*utf8*::
4eab78d3 992Use UTF-8 for converting file names.
14179682
MB
993
994*uni_xlate=*{**0**|**1**|*2*}::
4eab78d3 995For 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
996
997*posix=[0|1]*::
4eab78d3 998If 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
999
1000**uid=**__value__, **gid=**__value__ and **umask=**__value__::
4eab78d3 1001Set 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
1002
1003=== Mount options for overlay
1004
1005Since Linux 3.18 the overlay pseudo filesystem implements a union mount for other filesystems.
1006
1007An 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.
1008
1009The 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.
1010
1011A 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:
1012
1013____
1014....
1015mount -t overlay overlay \
1016 -olowerdir=/lower,upperdir=/upper,workdir=/work /merged
1017....
1018____
1019
1020**lowerdir=**__directory__::
4eab78d3 1021Any filesystem, does not need to be on a writable filesystem.
14179682
MB
1022
1023**upperdir=**__directory__::
4eab78d3 1024The upperdir is normally on a writable filesystem.
14179682
MB
1025
1026**workdir=**__directory__::
4eab78d3 1027The workdir needs to be an empty directory on the same filesystem as upperdir.
14179682 1028
9fd75ae7
T
1029*userxattr*::
1030Use the "*user.overlay.*" xattr namespace instead of "*trusted.overlay.*". This is useful for unprivileged mounting of overlayfs.
1031
1032*redirect_dir=*{**on**|**off**|**follow**|**nofollow**}::
1033If 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.
1034+
1035*on*;;
1036Redirects are enabled.
1037
1038*off*;;
1039Redirects are not created and only followed if "redirect_always_follow" feature is enabled in the kernel/module config.
1040
1041*follow*;;
1042Redirects are not created, but followed.
1043
1044*nofollow*;;
1045Redirects are not created and not followed (equivalent to "redirect_dir=off" if "redirect_always_follow" feature is not enabled).
1046
1047*index=*{**on**|**off**}::
1048Inode 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.
1049
1050*uuid=*{**on**|**off**}::
1051Can 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.
1052
1053*nfs_export=*{**on**|**off**}::
0197bdb2
KZ
1054When the underlying filesystems supports NFS export and the "nfs_export"
1055feature is enabled, an overlay filesystem may be exported to NFS.
1056+
256e524f 1057With the "nfs_export" feature, on copy_up of any lower object, an index entry
0197bdb2
KZ
1058is created under the index directory. The index entry name is the hexadecimal
1059representation of the copy up origin file handle. For a non-directory object,
1060the index entry is a hard link to the upper inode. For a directory object, the
1061index entry has an extended attribute "{**trusted**|**user**}.overlay.upper"
1062with an encoded file handle of the upper directory inode.
1063+
1064When encoding a file handle from an overlay filesystem object, the following rules apply;;
9fd75ae7 1065
0197bdb2
KZ
1066* For a non-upper object, encode a lower file handle from lower inode
1067* For an indexed object, encode a lower file handle from copy_up origin
1068* For a pure-upper object and for an existing non-indexed upper object, encode an upper file handle from upper inode
9fd75ae7 1069
0197bdb2
KZ
1070+
1071The encoded overlay file handle includes;;
9fd75ae7 1072
0197bdb2
KZ
1073* Header including path type information (e.g. lower/upper)
1074* UUID of the underlying filesystem
1075* Underlying filesystem encoding of underlying inode
9fd75ae7 1076
0197bdb2 1077+
bd67ca44 1078This 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 1079
0197bdb2
KZ
1080* Find underlying layer by UUID and path type information.
1081* Decode the underlying filesystem file handle to underlying dentry.
1082* For a lower file handle, lookup the handle in index directory by name.
256e524f 1083* 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
1084* For a non-directory, instantiate a disconnected overlay dentry from the decoded underlying dentry, the path type and index inode, if found.
1085* For a directory, use the connected underlying decoded dentry, path type and index, to lookup a connected overlay dentry.
9fd75ae7 1086
0197bdb2
KZ
1087+
1088--
1089Decoding a non-directory file handle may return a disconnected dentry. copy_up
1090of that disconnected dentry will create an upper index entry with no upper
1091alias.
1092
1093When overlay filesystem has multiple lower layers, a middle layer directory may
1094have a "redirect" to lower directory. Because middle layer "redirects" are not
1095indexed, a lower file handle that was encoded from the "redirect" origin
1096directory, cannot be used to find the middle or upper layer directory.
1097Similarly, a lower file handle that was encoded from a descendant of the
1098"redirect" origin directory, cannot be used to reconstruct a connected overlay
1099path. To mitigate the cases of directories that cannot be decoded from a lower
1100file handle, these directories are copied up on encode and encoded as an upper
1101file handle. On an overlay filesystem with no upper layer this mitigation
1102cannot be used NFS export in this setup requires turning off redirect follow
1103(e.g. "__redirect_dir=nofollow__").
9fd75ae7
T
1104
1105The 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.
1106
1107When 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.
1108
0197bdb2
KZ
1109Note: the mount options __index=off,nfs_export=on__ are conflicting for a
1110read-write mount and will result in an error.
1111--
9fd75ae7 1112
344b0cd4 1113*xino=*{**on**|**off**|**auto**}::
9fd75ae7 1114The "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 1115+
9fd75ae7
T
1116For a detailed description of the effect of this option please refer to https://www.kernel.org/doc/html/latest/filesystems/overlayfs.html?highlight=overlayfs
1117
1118*metacopy=*{**on**|**off**}::
1119When 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 1120+
9fd75ae7
T
1121In other words, this is delayed data copy up operation and data is copied up when there is a need to actually modify data.
1122
1123*volatile*::
1124Volatile 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 1125+
9fd75ae7 1126The advantage of mounting with the "volatile" option is that all forms of sync calls to the upper filesystem are omitted.
0197bdb2 1127+
9fd75ae7 1128In 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 1129+
9fd75ae7
T
1130When 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.
1131
14179682
MB
1132=== Mount options for reiserfs
1133
1134Reiserfs is a journaling filesystem.
1135
1136*conv*::
4eab78d3 1137Instructs 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
1138
1139*hash=*{**rupasov**|**tea**|**r5**|*detect*}::
4eab78d3
MB
1140Choose which hash function reiserfs will use to find files within directories.
1141+
1142*rupasov*;;
1143A 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.
1144
1145*tea*;;
1146A 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.
1147
1148*r5*;;
1149A 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.
1150
1151*detect*;;
1152Instructs *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
1153
1154*hashed_relocation*::
4eab78d3 1155Tunes the block allocator. This may provide performance improvements in some situations.
14179682
MB
1156
1157*no_unhashed_relocation*::
4eab78d3 1158Tunes the block allocator. This may provide performance improvements in some situations.
14179682
MB
1159
1160*noborder*::
4eab78d3 1161Disable the border allocator algorithm invented by Yury Yu. Rupasov. This may provide performance improvements in some situations.
14179682
MB
1162
1163*nolog*::
4eab78d3 1164Disable 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
1165
1166*notail*::
4eab78d3 1167By 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
1168
1169*replayonly*::
4eab78d3 1170Replay the transactions which are in the journal, but do not actually mount the filesystem. Mainly used by _reiserfsck_.
14179682
MB
1171
1172**resize=**__number__::
4eab78d3 1173A 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
1174
1175*user_xattr*::
4eab78d3 1176Enable Extended User Attributes. See the *attr*(1) manual page.
14179682
MB
1177
1178*acl*::
4eab78d3 1179Enable POSIX Access Control Lists. See the *acl*(5) manual page.
14179682
MB
1180
1181*barrier=none* / *barrier=flush*::
4eab78d3 1182This 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
1183
1184=== Mount options for ubifs
1185
1186UBIFS is a flash filesystem which works on top of UBI volumes. Note that *atime* is not supported and is always turned off.
1187
1188The device name may be specified as
1189
1190____
1191*ubiX_Y*::
1192 UBI device number *X*, volume number *Y*
1193*ubiY*::
1194 UBI device number *0*, volume number *Y*
1195*ubiX:NAME*::
1196 UBI device number *X*, volume with name *NAME*
1197*ubi:NAME*::
1198 UBI device number *0*, volume with name *NAME*
1199____
1200
1201Alternative *!* separator may be used instead of *:*.
1202
1203The following mount options are available:
1204
1205*bulk_read*::
4eab78d3 1206Enable 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
1207
1208*no_bulk_read*::
4eab78d3 1209Do not bulk-read. This is the default.
14179682
MB
1210
1211*chk_data_crc*::
4eab78d3 1212Check data CRC-32 checksums. This is the default.
14179682
MB
1213
1214*no_chk_data_crc*::
4eab78d3 1215Do 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
1216
1217*compr=*{**none**|**lzo**|*zlib*}::
4eab78d3 1218Select 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
1219
1220=== Mount options for udf
1221
1222UDF 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_.
1223
1224*uid=*::
4eab78d3 1225Make 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
1226
1227*gid=*::
4eab78d3 1228Make 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
1229
1230*umask=*::
4eab78d3 1231Mask out the given permissions from all inodes read from the filesystem. The value is given in octal.
14179682
MB
1232
1233*mode=*::
4eab78d3 1234If *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
1235
1236*dmode=*::
4eab78d3 1237If *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
1238
1239*bs=*::
4eab78d3
MB
1240Set 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.
1241+
c83a52f0 1242For other details see the *mkudffs*(8) 2.0+ manpage, see the *COMPATIBILITY* and *BLOCK SIZE* sections.
14179682
MB
1243
1244*unhide*::
4eab78d3 1245Show otherwise hidden files.
14179682
MB
1246
1247*undelete*::
4eab78d3 1248Show deleted files in lists.
14179682
MB
1249
1250*adinicb*::
4eab78d3 1251Embed data in the inode. (default)
14179682
MB
1252
1253*noadinicb*::
4eab78d3 1254Don't embed data in the inode.
14179682
MB
1255
1256*shortad*::
4eab78d3 1257Use short UDF address descriptors.
14179682
MB
1258
1259*longad*::
4eab78d3 1260Use long UDF address descriptors. (default)
14179682
MB
1261
1262*nostrict*::
4eab78d3 1263Unset strict conformance.
14179682
MB
1264
1265*iocharset=*::
4eab78d3 1266Set the NLS character set. This requires kernel compiled with *CONFIG_UDF_NLS* option.
14179682
MB
1267
1268*utf8*::
4eab78d3 1269Set the UTF-8 character set.
14179682
MB
1270
1271=== Mount options for debugging and disaster recovery
1272
1273*novrs*::
4eab78d3 1274Ignore the Volume Recognition Sequence and attempt to mount anyway.
14179682
MB
1275
1276*session=*::
4eab78d3 1277Select the session number for multi-session recorded optical media. (default= last session)
14179682
MB
1278
1279*anchor=*::
4eab78d3 1280Override standard anchor location. (default= 256)
14179682
MB
1281
1282*lastblock=*::
4eab78d3 1283Set the last block of the filesystem.
14179682
MB
1284
1285=== Unused historical mount options that may be encountered and should be removed
1286
1287*uid=ignore*::
4eab78d3 1288Ignored, use uid=<user> instead.
14179682
MB
1289
1290*gid=ignore*::
4eab78d3 1291Ignored, use gid=<group> instead.
14179682
MB
1292
1293*volume=*::
4eab78d3 1294Unimplemented and ignored.
14179682
MB
1295
1296*partition=*::
4eab78d3 1297Unimplemented and ignored.
14179682
MB
1298
1299*fileset=*::
4eab78d3 1300Unimplemented and ignored.
14179682
MB
1301
1302*rootdir=*::
4eab78d3 1303Unimplemented and ignored.
14179682
MB
1304
1305=== Mount options for ufs
1306
1307**ufstype=**__value__::
4eab78d3
MB
1308UFS 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:
1309+
1310*old*;;
1311Old format of ufs, this is the default, read only. (Don't forget to give the *-r* option.)
1312
1313*44bsd*;;
1314For filesystems created by a BSD-like system (NetBSD, FreeBSD, OpenBSD).
1315
1316*ufs2*;;
1317Used in FreeBSD 5.x supported as read-write.
1318
1319*5xbsd*;;
1320Synonym for ufs2.
1321
1322*sun*;;
1323For filesystems created by SunOS or Solaris on Sparc.
1324
1325*sunx86*;;
1326For filesystems created by Solaris on x86.
1327
1328*hp*;;
1329For filesystems created by HP-UX, read-only.
1330
1331*nextstep*;;
1332For filesystems created by NeXTStep (on NeXT station) (currently read only).
1333
1334*nextstep-cd*;;
1335For NextStep CDROMs (block_size == 2048), read-only.
1336
1337*openstep*;;
bd67ca44 1338For filesystems created by OpenStep (currently read only). The same filesystem type is also used by macOS.
14179682
MB
1339
1340**onerror=**__value__::
4eab78d3
MB
1341Set behavior on error:
1342
1343*panic*;;
1344If an error is encountered, cause a kernel panic.
1345
1346[**lock**|**umount**|*repair*];;
1347These mount options don't do anything at present; when an error is encountered only a console message is printed.
14179682
MB
1348
1349=== Mount options for umsdos
1350
1351See mount options for msdos. The *dotsOK* option is explicitly killed by _umsdos_.
1352
1353=== Mount options for vfat
1354
1355First of all, the mount options for _fat_ are recognized. The *dotsOK* option is explicitly killed by _vfat_. Furthermore, there are
1356
1357*uni_xlate*::
4eab78d3 1358Translate 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
1359
1360*posix*::
4eab78d3 1361Allow two files with names that only differ in case. This option is obsolete.
14179682
MB
1362
1363*nonumtail*::
4eab78d3 1364First try to make a short name without sequence number, before trying _name~num.ext_.
14179682
MB
1365
1366*utf8*::
4eab78d3 1367UTF8 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
1368
1369**shortname=**__mode__::
4eab78d3
MB
1370Defines 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:
1371
1372*lower*;;
1373Force the short name to lower case upon display; store a long name when the short name is not all upper case.
1374
1375*win95*;;
1376Force the short name to upper case upon display; store a long name when the short name is not all upper case.
1377
1378*winnt*;;
1379Display the short name as is; store a long name when the short name is not all lower case or all upper case.
1380
1381*mixed*;;
1382Display 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
1383
1384=== Mount options for usbfs
1385
1386**devuid=**__uid__ and **devgid=**__gid__ and **devmode=**__mode__::
4eab78d3 1387Set 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
1388
1389**busuid=**__uid__ and **busgid=**__gid__ and **busmode=**__mode__::
4eab78d3 1390Set 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
1391
1392**listuid=**__uid__ and **listgid=**__gid__ and **listmode=**__mode__::
4eab78d3 1393Set the owner and group and mode of the file _devices_ (default: uid=gid=0, mode=0444). The mode is given in octal.
14179682 1394
d9567bde 1395== DM-VERITY SUPPORT
14179682 1396
bd67ca44 1397The 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
1398
1399**verity.hashdevice=**__path__::
4eab78d3 1400Path to the hash tree device associated with the source volume to pass to dm-verity.
14179682
MB
1401
1402**verity.roothash=**__hex__::
4eab78d3 1403Hex-encoded hash of the root of _verity.hashdevice_. Mutually exclusive with _verity.roothashfile._
14179682
MB
1404
1405**verity.roothashfile=**__path__::
4eab78d3 1406Path to file containing the hex-encoded hash of the root of _verity.hashdevice._ Mutually exclusive with _verity.roothash._
14179682
MB
1407
1408**verity.hashoffset=**__offset__::
4eab78d3 1409If 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
1410
1411**verity.fecdevice=**__path__::
4eab78d3 1412Path 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
1413
1414**verity.fecoffset=**__offset__::
4eab78d3 1415If 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
1416
1417**verity.fecroots=**__value__::
4eab78d3 1418Parity bytes for FEC (default: 2). Optional.
14179682
MB
1419
1420**verity.roothashsig=**__path__::
4eab78d3 1421Path 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 1422
ce02babf
LB
1423**verity.oncorruption=**__ignore__|__restart__|__panic__::
1424Instruct 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.
1425
14179682
MB
1426Supported since util-linux v2.35.
1427
1428For example commands:
1429
1430....
1431mksquashfs /etc /tmp/etc.squashfs
1432dd if=/dev/zero of=/tmp/etc.hash bs=1M count=10
1433veritysetup format /tmp/etc.squashfs /tmp/etc.hash
1434openssl smime -sign -in <hash> -nocerts -inkey private.key \
c9c5933a 1435-signer private.crt -noattr -binary -outform der -out /tmp/etc.roothash.p7s
14179682 1436mount -o verity.hashdevice=/tmp/etc.hash,verity.roothash=<hash>,\
c9c5933a 1437verity.roothashsig=/tmp/etc.roothash.p7s /tmp/etc.squashfs /mnt
14179682
MB
1438....
1439
1440create 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.
1441
1442== LOOP-DEVICE SUPPORT
1443
1444One further possible type is a mount via the loop device. For example, the command
1445
1446____
1447*mount /tmp/disk.img /mnt -t vfat -o loop=/dev/loop3*
1448____
1449
1450will set up the loop device _/dev/loop3_ to correspond to the file _/tmp/disk.img_, and then mount this device on _/mnt_.
1451
4eab78d3 1452If 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
1453
1454____
1455*mount /tmp/disk.img /mnt -o loop*
1456____
1457
1458The *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:
1459
1460____
1461*mount /tmp/disk.img /mnt*
1462
1463*mount -t ext4 /tmp/disk.img /mnt*
1464____
1465
544e64e0 1466This 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
1467
1468Since 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_.
1469
1470You can also free a loop device by hand, using *losetup -d* or *umount -d*.
1471
1472Since 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.
1473
1474== EXIT STATUS
1475
1476*mount* has the following exit status values (the bits can be ORed):
1477
1478*0*::
4eab78d3 1479success
14179682
MB
1480
1481*1*::
4eab78d3 1482incorrect invocation or permissions
14179682
MB
1483
1484*2*::
4eab78d3 1485system error (out of memory, cannot fork, no more loop devices)
14179682
MB
1486
1487*4*::
4eab78d3 1488internal *mount* bug
14179682
MB
1489
1490*8*::
4eab78d3 1491user interrupt
14179682
MB
1492
1493*16*::
4eab78d3 1494problems writing or locking _/etc/mtab_
14179682
MB
1495
1496*32*::
4eab78d3 1497mount failure
14179682
MB
1498
1499*64*::
4eab78d3
MB
1500some mount succeeded
1501+
1502The command *mount -a* returns 0 (all succeeded), 32 (all failed), or 64 (some failed, some succeeded).
14179682
MB
1503
1504== EXTERNAL HELPERS
1505
1506The syntax of external mount helpers is:
1507
1508**/sbin/mount.**__suffix__ _spec dir_ [*-sfnv*] [*-N* _namespace_] [*-o* _options_] [*-t* __type__**.**_subtype_]
1509
1510where 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*).
1511
1512The 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.
1513
1514== ENVIRONMENT
1515
e6743239 1516*LIBMOUNT_FSTAB*=<path>::
4eab78d3 1517overrides the default location of the _fstab_ file (ignored for suid)
14179682 1518
e6743239 1519*LIBMOUNT_DEBUG*=all::
4eab78d3 1520enables libmount debug output
14179682 1521
e6743239 1522*LIBBLKID_DEBUG*=all::
4eab78d3 1523enables libblkid debug output
14179682 1524
e6743239 1525*LOOPDEV_DEBUG*=all::
4eab78d3 1526enables loop device setup debug output
14179682
MB
1527
1528== FILES
1529
1530See also "*The files /etc/fstab, /etc/mtab and /proc/mounts*" section above.
1531
1532_/etc/fstab_::
4eab78d3 1533filesystem table
14179682
MB
1534
1535_/run/mount_::
4eab78d3 1536libmount private runtime directory
14179682
MB
1537
1538_/etc/mtab_::
4eab78d3 1539table of mounted filesystems or symlink to _/proc/mounts_
14179682
MB
1540
1541_/etc/mtab~_::
4eab78d3 1542lock file (unused on systems with _mtab_ symlink)
14179682
MB
1543
1544_/etc/mtab.tmp_::
4eab78d3 1545temporary file (unused on systems with _mtab_ symlink)
14179682
MB
1546
1547_/etc/filesystems_::
4eab78d3 1548a list of filesystem types to try
14179682
MB
1549
1550== HISTORY
1551
1552A *mount* command existed in Version 5 AT&T UNIX.
1553
1554== BUGS
1555
1556It is possible for a corrupted filesystem to cause a crash.
1557
1558Some 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).
1559
1560The *-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_).
1561
1562It 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.
1563
1564Checking 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.
1565
4eab78d3 1566The *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
1567
1568== AUTHORS
1569
1570mailto:kzak@redhat.com[Karel Zak]
1571
1572== SEE ALSO
1573
14179682
MB
1574*mount*(2),
1575*umount*(2),
1576*filesystems*(5),
1577*fstab*(5),
1578*nfs*(5),
1579*xfs*(5),
1580*mount_namespaces*(7),
1581*xattr*(7),
1582*e2label*(8),
1583*findmnt*(8),
1584*losetup*(8),
5723eae7 1585*lsblk*(8),
14179682
MB
1586*mke2fs*(8),
1587*mountd*(8),
1588*nfsd*(8),
1589*swapon*(8),
1590*tune2fs*(8),
1591*umount*(8),
1592*xfs_admin*(8)
1593
625e9c61 1594include::man-common/bugreports.adoc[]
14179682 1595
625e9c61 1596include::man-common/footer.adoc[]
14179682
MB
1597
1598ifdef::translation[]
625e9c61 1599include::man-common/translation.adoc[]
14179682 1600endif::[]