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