]> git.ipfire.org Git - thirdparty/man-pages.git/blobdiff - man2/mount.2
Changes, ldd.1, chown.2, epoll_wait.2, get_mempolicy.2, ioctl_getfsmap.2, madvise...
[thirdparty/man-pages.git] / man2 / mount.2
index 689df3271d450531bbfc16e2cb9eb250bcce8bde..dd0299567616c972f9bd5f0e545057d70956fbeb 100644 (file)
@@ -1,6 +1,6 @@
 .\" Copyright (C) 1993 Rickard E. Faith <faith@cs.unc.edu>
 .\" and Copyright (C) 1994 Andries E. Brouwer <aeb@cwi.nl>
-.\" and Copyright (C) 2002, 2005 Michael Kerrisk <mtk.manpages@gmail.com>
+.\" and Copyright (C) 2002, 2005, 2016 Michael Kerrisk <mtk.manpages@gmail.com>
 .\"
 .\" %%%LICENSE_START(VERBATIM)
 .\" Permission is granted to make and distribute verbatim copies of this
@@ -37,7 +37,7 @@
 .\" 2008-10-06, mtk: move umount*() material into separate umount.2 page.
 .\" 2008-10-06, mtk: Add discussion of namespaces.
 .\"
-.TH MOUNT 2 2016-03-15 "Linux" "Linux Programmer's Manual"
+.TH MOUNT 2 2017-07-13 "Linux" "Linux Programmer's Manual"
 .SH NAME
 mount \- mount filesystem
 .SH SYNOPSIS
@@ -57,11 +57,11 @@ but can also be the pathname of a directory or file,
 or a dummy string) to the location (a directory or file)
 specified by the pathname in
 .IR target .
-
+.PP
 Appropriate privilege (Linux: the
 .B CAP_SYS_ADMIN
 capability) is required to mount filesystems.
-
+.PP
 Values for the
 .I filesystemtype
 argument supported by the kernel are listed in
@@ -70,7 +70,7 @@ argument supported by the kernel are listed in
 "tmpfs", "cgroup", "proc", "mqueue", "nfs", "cifs", "iso9660").
 Further types may become available when the appropriate modules
 are loaded.
-
+.PP
 The
 .I data
 argument is interpreted by the different filesystems.
@@ -79,13 +79,14 @@ understood by this filesystem.
 See
 .BR mount (8)
 for details of the options available for each filesystem type.
-
+.PP
 A call to
 .BR mount ()
-performs one of a number of general types of operation.
+performs one of a number of general types of operation,
 depending on the bits specified in
 .IR mountflags .
-The choice of operation is determined by testing the bits set in
+The choice of which operation to perform is determined by
+testing the bits set in
 .IR mountflags ,
 with the tests being conducted in the order listed here:
 .IP * 3
@@ -165,7 +166,7 @@ This mount option significantly reduces writes
 needed to update the inode's timestamps, especially mtime and atime.
 However, in the event of a system crash, the atime and mtime fields
 on disk might be out of date by up to 24 hours.
-
+.PP
 Examples of workloads where this option could be of significant benefit
 include frequent random writes to preallocated files,
 as well as cases where the
@@ -190,7 +191,6 @@ Since Linux 4.5,
 this mount option requires the
 .B CAP_SYS_ADMIN
 capability.
-.\" FIXME Describe the MS_MOVE flag in more detail
 .TP
 .B MS_NOATIME
 Do not update access times for (all types of) files on this filesystem.
@@ -221,10 +221,14 @@ when executing programs from this filesystem.
 .TP
 .B MS_RDONLY
 Mount filesystem read-only.
-.\"
-.\" FIXME Document MS_REC, available since 2.4.11.
-.\" This flag has meaning in conjunction with MS_BIND and
-.\" also with the shared subtree flags.
+.TP
+.BR MS_REC " (since Linux 2.4.11)"
+Used in conjunction with
+.BR MS_BIND
+to create a recursive bind mount,
+and in conjunction with the propagation type flags to recursively change
+the propagation type of all of the mounts in a subtree.
+See below for further details.
 .TP
 .BR MS_RELATIME " (since Linux 2.6.20)"
 When a file on this filesystem is accessed,
@@ -284,6 +288,12 @@ are also settable on a per-mount-point basis.
 The
 .B MS_RELATIME
 flag is also settable on a per-mount-point basis.
+Since Linux 2.6.16,
+.B MS_RDONLY
+can be set or cleared on a per-mount-point basis as well as on
+the underlying filesystem.
+The mounted filesystem will be writable only if neither the filesystem
+nor the mountpoint are flagged as read-only.
 .\"
 .SS Remounting an existing mount
 An existing mount may be remounted by specifying
@@ -299,13 +309,13 @@ of an existing mount without having to unmount and remount the filesystem.
 should be the same value specified in the initial
 .BR mount ()
 call.
-
+.PP
 The
 .I source
 and
 .I filesystemtype
 arguments are ignored.
-
+.PP
 The
 .I mountflags
 and
@@ -313,24 +323,30 @@ and
 arguments should match the values used in the original
 .BR mount ()
 call, except for those parameters that are being deliberately changed.
-
+Another exception is that
+.B MS_BIND
+has a different meaning for remount, and it should be included only if
+explicitly desired.
+.PP
 The following
 .I mountflags
 can be changed:
-.BR MS_RDONLY ,
-.BR MS_SYNCHRONOUS ,
-and
-.BR MS_MANDLOCK ;
-before kernel 2.6.16, the following could also be changed:
-.B MS_NOATIME
-and
-.BR MS_NODIRATIME ;
-and, additionally, before kernel 2.4.10, the following could also be changed:
-.BR MS_NOSUID ,
+.BR MS_LAZYTIME ,
+.BR MS_MANDLOCK ,
+.BR MS_NOATIME ,
 .BR MS_NODEV ,
+.BR MS_NODIRATIME ,
+.BR MS_NOEXEC ,
+.BR MS_NOSUID ,
+.BR MS_RELATIME ,
+.BR MS_RDONLY ,
 and
-.BR MS_NOEXEC .
-
+.BR MS_SYNCHRONOUS .
+Attempts to change the setting of the
+.\" See the definition of MS_RMT_MASK in include/uapi/linux/fs.h
+.BR MS_DIRSYNC
+flag during a remount are silently ignored.
+.PP
 Since Linux 3.17,
 .\" commit ffbc6f0ead47fa5a1dc9642b0331cb75c20a640e
 if none of
@@ -344,18 +360,21 @@ is specified in
 then the remount operation preserves the existing values of these flags
 (rather than defaulting to
 .BR MS_RELATIME ).
-
-Since Linux 2.6.26, this flag can also be used to make
+.PP
+Since Linux 2.6.26, this flag can be used with
+.B MS_BIND
+to modify only the per-mount-point flags.
 .\" See https://lwn.net/Articles/281157/
-an existing bind mount read-only by specifying
+This is particularly useful for setting or clearing the "read-only"
+flag on a mount point without changing the underlying filesystem.
+Specifying
 .IR mountflags
 as:
-
+.PP
     MS_REMOUNT | MS_BIND | MS_RDONLY
-
-Note that only the
-.BR MS_RDONLY
-setting of the bind mount can be changed in this manner.
+.PP
+will make access through this mountpoint read-only, without affecting
+other mount points.
 .\"
 .SS Creating a bind mount
 If
@@ -370,13 +389,13 @@ another point within the single directory hierarchy.
 Bind mounts may cross filesystem boundaries and span
 .BR chroot (2)
 jails.
-
+.PP
 The
 .IR filesystemtype
 and
 .IR data
 arguments are ignored.
-
+.PP
 The remaining bits in the
 .I mountflags
 argument are also ignored, with the exception of
@@ -385,6 +404,20 @@ argument are also ignored, with the exception of
 the underlying mount point.)
 However, see the discussion of remounting above,
 for a method of making an existing bind mount read-only.
+.PP
+By default, when a directory is bind mounted,
+only that directory is mounted;
+if there are any submounts under the directory tree,
+they are not bind mounted.
+If the
+.BR MS_REC
+flag is also specified, then a recursive bind mount operation is performed:
+all submounts under the
+.I source
+subtree (other than unbindable mounts)
+are also bind mounted at the corresponding location in the
+.I target
+subtree.
 .\"
 .SS Changing the propagation type of an existing mount
 If
@@ -398,19 +431,19 @@ or
 (all available since Linux 2.6.15),
 then the propagation type of an existing mount is changed.
 If more than one of these flags is specified, an error results.
-
+.PP
 The only flags that can be used with changing the propagation type are
 .BR MS_REC
 and
 .BR MS_SILENT .
-
+.PP
 The
 .IR source ,
 .IR filesystemtype ,
 and
 .IR data
 arguments are ignored.
-
+.PP
 The meanings of the propagation type flags are as follows:
 .TP
 .BR MS_SHARED
@@ -425,7 +458,6 @@ peer mount points will propagate to this mount point.
 .BR MS_PRIVATE
 Make this mount point private.
 Mount and unmount events do not propagate into or out of this mount point.
-This is the default propagation type for newly created mount points.
 .TP
 .BR MS_SLAVE
 If this is a shared mount point that is a member of a peer group
@@ -433,12 +465,12 @@ that contains other members, convert it to a slave mount.
 If this is a shared mount point that is a member of a peer group
 that contains no other members, convert it to a private mount.
 Otherwise, the propagation type of the mount point is left unchanged.
-
+.PP
 When a mount point is a slave,
 mount and unmount events propagate into this mount point from
 the (master) shared peer group of which it was formerly a member.
 Mount and unmount events under this mount point do not propagate to any peer.
-
+.PP
 A mount point can be the slave of another peer group
 while at the same time sharing mount and unmount events
 with a peer group of which it is a member.
@@ -448,7 +480,7 @@ Make this mount unbindable.
 This is like a private mount,
 and in addition this mount can't be bind mounted.
 When a recursive bind mount
-.RB ( mount (2)
+.RB ( mount ()
 with the
 .BR MS_BIND
 and
@@ -457,6 +489,21 @@ flags) is performed on a directory subtree,
 any bind mounts within the subtree are automatically pruned
 (i.e., not replicated)
 when replicating that subtree to produce the target subtree.
+.PP
+By default, changing the propagation type affects only the
+.I target
+mount point.
+If the
+.B MS_REC
+flag is also specified in
+.IR mountflags ,
+then the propagation type of all mount points under
+.IR target
+is also changed.
+.PP
+For further details regarding mount propagation types
+(including the default propagation type assigned to new mounts), see
+.BR mount_namespaces (7).
 .\"
 .SS Moving a mount
 If
@@ -470,7 +517,7 @@ specifies an existing mount point and
 .I target
 specifies the new location to which that mount point is to be relocated.
 The move is atomic: at no point is the subtree unmounted.
-
+.PP
 The remaining bits in the
 .IR mountflags
 argument are ignored, as are the
@@ -498,7 +545,7 @@ performs its default action: creating a new mount point.
 specifies the source for the new mount point, and
 .IR target
 specifies the directory at which to create the mount point.
-
+.PP
 The
 .I filesystemtype
 and
@@ -523,10 +570,14 @@ See the Linux kernel source code for details.
 A component of a path was not searchable.
 (See also
 .BR path_resolution (7).)
-Or, mounting a read-only filesystem was attempted without giving the
+.TP
+.B EACCES
+Mounting a read-only filesystem was attempted without giving the
 .B MS_RDONLY
 flag.
-Or, the block device
+.TP
+.B EACCES
+The block device
 .I source
 is located on a filesystem mounted with the
 .B MS_NODEV
@@ -537,9 +588,15 @@ option.
 .B EBUSY
 .I source
 is already mounted.
-Or, it cannot be remounted read-only,
+.TP
+.B EBUSY
+.I source
+cannot be remounted read-only,
 because it still holds files open for writing.
-Or, it cannot be mounted on
+.TP
+.B EBUSY
+.I source
+cannot be mounted on
 .I target
 because
 .I target
@@ -552,13 +609,17 @@ One of the pointer arguments points outside the user address space.
 .B EINVAL
 .I source
 had an invalid superblock.
-Or, a remount
+.TP
+.B EINVAL
+A remount operation
 .RB ( MS_REMOUNT )
 was attempted, but
 .I source
 was not already mounted on
 .IR target .
-Or, a move
+.TP
+.B EINVAL
+A move operation
 .RB ( MS_MOVE )
 was attempted, but
 .I source
@@ -591,7 +652,9 @@ An attempt was made to bind mount an unbindable mount.
 .TP
 .B ELOOP
 Too many links encountered during pathname resolution.
-Or, a move was attempted, while
+.TP
+.B ELOOP
+A move operation was attempted, and
 .I target
 is a descendant of
 .IR source .
@@ -639,7 +702,7 @@ The definitions of
 .BR MS_REC ,
 .BR MS_RELATIME ,
 .BR MS_SHARED ,
-.BR MS_SLAVED ,
+.BR MS_SLAVE ,
 .BR MS_STRICTATIME
 and
 .BR MS_UNBINDABLE
@@ -653,7 +716,7 @@ Since Linux 2.4 a single filesystem can be mounted at
 multiple mount points, and multiple mounts can be stacked
 on the same mount point.
 .\" Multiple mounts on same mount point: since 2.3.99pre7.
-
+.PP
 The
 .I mountflags
 argument may have the magic number 0xC0ED (\fBMS_MGC_VAL\fP)
@@ -665,7 +728,7 @@ Specifying
 .BR MS_MGC_VAL
 was required in kernel versions prior to 2.4,
 but since Linux 2.4 is no longer required and is ignored if specified.
-
+.PP
 The original
 .B MS_SYNC
 flag was renamed
@@ -684,7 +747,6 @@ Since Linux 2.4 the set-user-ID and set-group-ID bits are
 just silently ignored in this case.
 .\" The change is in patch-2.4.0-prerelease.
 .\"
-
 .SS Per-process namespaces
 Starting with kernel 2.4.19, Linux provides
 per-process mount namespaces.
@@ -696,13 +758,13 @@ and changes to the namespace (i.e., mounts and unmounts) by one process
 are visible to all other processes sharing the same namespace.
 (The pre-2.4.19 Linux situation can be considered as one in which
 a single namespace was shared by every process on the system.)
-
+.PP
 A child process created by
 .BR fork (2)
 shares its parent's mount namespace;
 the mount namespace is preserved across an
 .BR execve (2).
-
+.PP
 A process can obtain a private mount namespace if:
 it was created using the
 .BR clone (2)
@@ -722,18 +784,19 @@ of the namespace that it was previously sharing with other processes,
 so that future mounts and unmounts by the caller are invisible
 to other processes (except child processes that the caller
 subsequently creates) and vice versa.
-
+.PP
 The Linux-specific
-.I /proc/PID/mounts
+.I /proc/[pid]/mounts
 file exposes the list of mount points in the mount
 namespace of the process with the specified ID; see
 .BR proc (5)
 for details.
 .SH SEE ALSO
+.BR mountpoint (1),
 .BR umount (2),
-.BR namespaces (7),
+.BR mount_namespaces (7),
 .BR path_resolution (7),
-.BR lsblk (8),
 .BR findmnt (8),
+.BR lsblk (8),
 .BR mount (8),
 .BR umount (8)