xref: /freebsd/sbin/mount/mount.8 (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
1.\" Copyright (c) 1980, 1989, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd November 19, 2024
29.Dt MOUNT 8
30.Os
31.Sh NAME
32.Nm mount
33.Nd mount file systems
34.Sh SYNOPSIS
35.Nm
36.Op Fl -libxo
37.Op Fl adflpruvw
38.Op Fl F Ar fstab
39.Op Fl o Ar options
40.Op Fl t Oo Cm no Oc Ns Cm Ar type Ns Op Cm , Ns Ar type ...
41.Nm
42.Op Fl -libxo
43.Op Fl dfpruvw
44.Ar special | node
45.Nm
46.Op Fl -libxo
47.Op Fl dfpruvw
48.Op Fl o Ar options
49.Op Fl t Oo Cm no Oc Ns Cm Ar type Ns Op Cm , Ns Ar type ...
50.Ar special node
51.Sh DESCRIPTION
52The
53.Nm
54utility calls the
55.Xr nmount 2
56system call to prepare and graft a
57.Ar special
58device or the remote node (rhost:path) on to the file system tree at the point
59.Ar node .
60If either
61.Ar special
62or
63.Ar node
64are not provided, the appropriate information is taken from the
65.Xr fstab 5
66file.
67.Pp
68The system maintains a list of currently mounted file systems.
69If no arguments are given to
70.Nm ,
71this list is printed.
72.Pp
73The options are as follows:
74.Bl -tag -width indent
75.It Fl -libxo
76Generate output via
77.Xr libxo 3
78in a selection of different human and machine readable formats.
79See
80.Xr xo_parse_args 3
81for details on command line arguments.
82.It Fl a
83All the file systems described in
84.Xr fstab 5
85are mounted.
86Exceptions are those marked as
87.Dq Li noauto ,
88those marked as
89.Dq Li late
90(unless the
91.Fl l
92option was specified),
93those excluded by the
94.Fl t
95flag (see below), or if they are already mounted (except the
96root file system which is always remounted to preserve
97traditional single user mode behavior).
98.It Fl d
99Causes everything to be done except for the actual system call.
100This option is useful in conjunction with the
101.Fl v
102flag to
103determine what the
104.Nm
105command is trying to do.
106.It Fl F Ar fstab
107Specify the
108.Pa fstab
109file to use.
110.It Fl f
111Forces the revocation of write access when trying to downgrade
112a file system mount status from read-write to read-only.
113Also
114forces the R/W mount of an unclean file system (dangerous; use with
115caution).
116.It Fl L
117When used in conjunction with the
118.Fl a
119option, mount
120.Em only
121those file systems which are marked as
122.Dq Li late .
123.It Fl l
124When used in conjunction with the
125.Fl a
126option, also mount those file systems which are marked as
127.Dq Li late .
128.It Fl n
129For compatibility with some other implementations, this flag is
130currently a no-op.
131.It Fl o
132Options are specified with a
133.Fl o
134flag followed by a comma separated string of options.
135In case of conflicting options being specified, the rightmost option
136takes effect.
137The following options are available:
138.Bl -tag -width indent
139.It Cm acls
140Enable POSIX.1e Access Control Lists, or ACLs, which can be customized via the
141.Xr setfacl 1
142and
143.Xr getfacl 1
144commands.
145This flag is mutually exclusive with
146.Cm nfsv4acls
147flag.
148.It Cm async
149All I/O to the file system should be done asynchronously.
150This is a
151.Em dangerous
152flag to set, since it does not guarantee that the file system structure
153on the disk will remain consistent.
154For this reason, the
155.Cm async
156flag should be used sparingly, and only when some data recovery
157mechanism is present.
158.It Cm atime
159Update the file access time when reading from a file.
160This is the default.
161.It Cm automounted
162This flag indicates that the file system was mounted by
163.Xr automountd 8 .
164Automounted file systems are automatically unmounted by
165.Xr autounmountd 8 .
166.It Cm autoro
167Mount the file system read-write.
168If that fails with an error that suggests that the media could be read-only,
169then automatically try to mount the file system read-only.
170.It Cm current
171When used with the
172.Fl u
173flag, this is the same as specifying the options currently in effect for
174the mounted file system.
175.It Cm emptydir
176Require that the mount point directory be empty.
177.It Cm force
178The same as
179.Fl f ;
180forces the revocation of write access when trying to downgrade
181a file system mount status from read-write to read-only.
182Also
183forces the R/W mount of an unclean file system (dangerous; use with caution).
184.It Cm fstab
185When used with the
186.Fl u
187flag, this is the same as specifying all the options listed in the
188.Xr fstab 5
189file for the file system.
190.It Cm late
191This file system should be skipped when
192.Nm
193is run with the
194.Fl a
195flag but without the
196.Fl l
197flag.
198.It Cm mountprog Ns = Ns Aq Ar program
199Force
200.Nm
201to use the specified program to mount the file system, instead of calling
202.Xr nmount 2
203directly.
204For example:
205.Bd -literal
206mount -t foofs -o mountprog=/mydir/fooprog /dev/cd0 /mnt
207.Ed
208.It Cm multilabel
209Enable multi-label Mandatory Access Control, or MAC, on the specified file
210system.
211If the file system supports multilabel operation, individual labels will
212be maintained for each object in the file system, rather than using a
213single label for all objects.
214An alternative to the
215.Fl l
216flag in
217.Xr tunefs 8 .
218See
219.Xr mac 4
220for more information, which cause the multilabel mount flag to be set
221automatically at mount-time.
222.It Cm nfsv4acls
223Enable NFSv4 ACLs, which can be customized via the
224.Xr setfacl 1
225and
226.Xr getfacl 1
227commands.
228This flag is mutually exclusive with
229.Cm acls
230flag.
231.It Cm noasync
232Metadata I/O should be done synchronously, while data I/O should be done
233asynchronously.
234This is the default.
235.It Cm noatime
236Do not update the file access time when reading from a file.
237This option
238is useful on file systems where there are large numbers of files and
239performance is more critical than updating the file access time (which is
240rarely ever important).
241This option is currently only supported on local file systems.
242.It Cm noauto
243This file system should be skipped when
244.Nm
245is run with the
246.Fl a
247flag.
248.It Cm noclusterr
249Disable read clustering.
250.It Cm noclusterw
251Disable write clustering.
252.It Cm nocover
253Do not mount if the requested mount point is already
254the root of a mount point.
255.It Cm noexec
256Do not allow execution of any binaries on the mounted file system.
257This option is useful for a server that has file systems containing
258binaries for architectures other than its own.
259Note: This option was not designed as a security feature and no
260guarantee is made that it will prevent malicious code execution; for
261example, it is still possible to execute scripts which reside on a
262.Cm noexec
263mounted partition.
264.It Cm nosuid
265Do not allow set-user-identifier or set-group-identifier bits to take effect.
266Note: this option is worthless if a public available suid or sgid
267wrapper is installed on your system.
268It is set automatically when the user does not have super-user privileges.
269.It Cm nosymfollow
270Do not follow symlinks
271on the mounted file system.
272.It Cm ro
273The same as
274.Fl r ;
275mount the file system read-only (even the super-user may not write it).
276.It Cm snapshot
277Take a snapshot of the specified filesystem.
278When this option is used, all other options are ignored.
279The
280.Fl u
281flag is required with this option.
282.Pp
283Snapshot files must be created in the file system that is being
284snapshotted.
285You may create up to 20 snapshots per file system.
286Active snapshots are recorded in the superblock, so they persist across unmount
287and remount operations and across system reboots.
288When you are done with a snapshot, it can be removed with the
289.Xr rm 1
290command.
291Snapshots may be removed in any order, however you may not get back all the
292space contained in the snapshot as another snapshot may claim some of the blocks
293that it is releasing.
294Note that the schg flag is set on snapshots to ensure that not even the root
295user can write to them.
296The unlink command makes an exception for snapshot files in that it allows them
297to be removed even though they have the schg flag set, so it is not necessary to
298clear the schg flag before removing a snapshot file.
299.Pp
300Once you have taken a snapshot, there are three interesting things that you can
301do with it:
302.Pp
303.Bl -enum -compact
304.It
305Run
306.Xr fsck 8
307on the snapshot file.
308Assuming that the file system was clean when it was mounted, you should always
309get a clean (and unchanging) result from running fsck on the snapshot.
310This is essentially what the background fsck process does.
311.Pp
312.It
313Run
314.Xr dump 8
315on the snapshot.
316You will get a dump that is consistent with the file system as of the timestamp
317of the snapshot.
318.Pp
319.It
320Mount the snapshot as a frozen image of the file system.
321To mount the snapshot
322.Pa /var/snapshot/snap1 :
323.Bd -literal
324mdconfig -a -t vnode -f /var/snapshot/snap1 -u 4
325mount -r /dev/md4 /mnt
326.Ed
327.Pp
328You can now cruise around your frozen
329.Pa /var
330file system at
331.Pa /mnt .
332Everything will be in the same state that it was at the time the snapshot was
333taken.
334The one exception is that any earlier snapshots will appear as zero length
335files.
336When you are done with the mounted snapshot:
337.Bd -literal
338umount /mnt
339mdconfig -d -u 4
340.Ed
341.El
342.It Cm suiddir
343A directory on the mounted file system will respond to the SUID bit
344being set, by setting the owner of any new files to be the same
345as the owner of the directory.
346New directories will inherit the bit from their parents.
347Execute bits are removed from
348the file, and it will not be given to root.
349.Pp
350This feature is designed for use on fileservers serving PC users via
351ftp, SAMBA, or netatalk.
352It provides security holes for shell users and as
353such should not be used on shell machines, especially on home directories.
354This option requires the SUIDDIR
355option in the kernel to work.
356Only UFS file systems support this option.
357See
358.Xr chmod 2
359for more information.
360.It Cm sync
361All I/O to the file system should be done synchronously.
362.It Cm update
363The same as
364.Fl u ;
365indicate that the status of an already mounted file system should be changed.
366.It Cm union
367Causes the namespace at the mount point to appear as the union
368of the mounted file system root and the existing directory.
369Lookups will be done in the mounted file system first.
370If those operations fail due to a non-existent file the underlying
371directory is then accessed.
372All creates are done in the mounted file system.
373.It Cm untrusted
374The file system is untrusted and the kernel should use more
375extensive checks on the file-system's metadata before using it.
376This option is intended to be used when mounting file systems
377from untrusted media such as USB memory sticks or other
378externally-provided media.
379.El
380.Pp
381Any additional options specific to a file system type that is not
382one of the internally known types (see the
383.Fl t
384option) may be passed as a comma separated list; these options are
385distinguished by a leading
386.Dq \&-
387(dash).
388For example, the
389.Nm
390command:
391.Bd -literal -offset indent
392mount -t cd9660 -o -e /dev/cd0 /cdrom
393.Ed
394.Pp
395causes
396.Nm
397to execute the equivalent of:
398.Bd -literal -offset indent
399/sbin/mount_cd9660 -e /dev/cd0 /cdrom
400.Ed
401.Pp
402Options that take a value are specified using the -option=value syntax:
403.Bd -literal -offset indent
404mount -t msdosfs -o -u=fred,-g=wheel /dev/da0s1 /mnt
405.Ed
406.Pp
407is equivalent to
408.Bd -literal -offset indent
409/sbin/mount_msdosfs -u fred -g wheel /dev/da0s1 /mnt
410.Ed
411.Pp
412Additional options specific to file system types
413which are not internally known
414(see the description of the
415.Fl t
416option below)
417may be described in the manual pages for the associated
418.Pa /sbin/mount_ Ns Sy XXX
419utilities.
420.It Fl p
421Print mount information in
422.Xr fstab 5
423format.
424Implies also the
425.Fl v
426option.
427.It Fl r
428The file system is to be mounted read-only.
429Mount the file system read-only (even the super-user may not write it).
430The same as the
431.Cm ro
432argument to the
433.Fl o
434option.
435.It Fl t Oo Cm no Oc Ns Cm Ar type Ns Op Cm , Ns Ar type ...
436The argument following the
437.Fl t
438is used to indicate the file system type.
439The type
440.Cm ufs
441is the default.
442The
443.Fl t
444option can be used
445to indicate that the actions should only be taken on
446file systems of the specified type.
447More than one type may be specified in a comma separated list.
448The list of file system types can be prefixed with
449.Cm no
450to specify the file system types for which action should
451.Em not
452be taken.
453For example, the
454.Nm
455command:
456.Bd -literal -offset indent
457mount -a -t nonfs,nullfs
458.Ed
459.Pp
460mounts all file systems except those of type NFS and NULLFS.
461.Pp
462The default behavior of
463.Nm
464is to pass the
465.Fl t
466option directly to the
467.Xr nmount 2
468system call in the
469.Li fstype
470option.
471.Pp
472However, for the following file system types:
473.Cm cd9660 ,
474.Cm mfs ,
475.Cm msdosfs ,
476.Cm nfs ,
477.Cm nullfs ,
478.Cm smbfs ,
479.Cm udf ,
480and
481.Cm unionfs
482.Nm
483will not call
484.Xr nmount 2
485directly and will instead attempt to execute a program in
486.Pa /sbin/mount_ Ns Ar type
487where
488.Ar type
489is replaced by the file system type name.
490For example,
491.Cm nfs
492file systems are mounted by the program
493.Pa /sbin/mount_nfs .
494.Pp
495Most file systems will be dynamically loaded by the kernel
496if not already present, and if the kernel module is available.
497.It Fl u
498The
499.Fl u
500flag indicates that the status of an already mounted file
501system should be changed.
502Any of the options discussed above (the
503.Fl o
504option)
505may be changed;
506also a file system can be changed from read-only to read-write
507or vice versa.
508An attempt to change from read-write to read-only will fail if any
509files on the file system are currently open for writing unless the
510.Fl f
511flag is also specified.
512The set of options is determined by applying the options specified
513in the argument to
514.Fl o
515and finally applying the
516.Fl r
517or
518.Fl w
519option.
520.It Fl v
521Verbose mode.
522If the
523.Fl v
524is used alone, show all file systems, including those that were mounted with the
525.Dv MNT_IGNORE
526flag and show additional information about each file system (including fsid
527when run by root).
528.It Fl w
529The file system object is to be read and write.
530.El
531.Sh ENVIRONMENT
532.Bl -tag -width ".Ev PATH_FSTAB"
533.It Ev PATH_FSTAB
534If the environment variable
535.Ev PATH_FSTAB
536is set, all operations are performed against the specified file.
537.Ev PATH_FSTAB
538will not be honored if the process environment or memory address space is
539considered
540.Dq tainted .
541(See
542.Xr issetugid 2
543for more information.)
544.El
545.Sh FILES
546.Bl -tag -width /etc/fstab -compact
547.It Pa /etc/fstab
548file system table
549.El
550.Sh DIAGNOSTICS
551Various, most of them are self-explanatory.
552.Pp
553.Dl XXXXX file system is not available
554.Pp
555The kernel does not support the respective file system type.
556Note that
557support for a particular file system might be provided either on a static
558(kernel compile-time), or dynamic basis (loaded as a kernel module by
559.Xr kldload 8 ) .
560.Sh SEE ALSO
561.Xr getfacl 1 ,
562.Xr setfacl 1 ,
563.Xr nmount 2 ,
564.Xr acl 3 ,
565.Xr getmntinfo 3 ,
566.Xr libxo 3 ,
567.Xr xo_parse_args 3 ,
568.Xr cd9660 4 ,
569.Xr devfs 4 ,
570.Xr ext2fs 4 ,
571.Xr ffs 4 ,
572.Xr mac 4 ,
573.Xr procfs 4 ,
574.Xr tarfs 4 ,
575.Xr tmpfs 4 ,
576.Xr fstab 5 ,
577.Xr automount 8 ,
578.Xr fstyp 8 ,
579.Xr kldload 8 ,
580.Xr mount_cd9660 8 ,
581.Xr mount_msdosfs 8 ,
582.Xr mount_nfs 8 ,
583.Xr mount_nullfs 8 ,
584.Xr mount_smbfs 8 ,
585.Xr mount_udf 8 ,
586.Xr mount_unionfs 8 ,
587.Xr quotacheck 8 ,
588.Xr umount 8 ,
589.Xr zfs 8 ,
590.Xr zpool 8
591.Sh HISTORY
592A
593.Nm
594utility appeared in
595.At v1 .
596.Sh CAVEATS
597After a successful
598.Nm ,
599the permissions on the original mount point determine if
600.Pa ..\&
601is accessible from the mounted file system.
602The minimum permissions for
603the mount point for traversal across the mount point in both
604directions to be possible for all users is 0111 (execute for all).
605.Pp
606Use of the
607.Nm
608is preferred over the use of the file system specific
609.Pa mount_ Ns Sy XXX
610commands.
611In particular,
612.Xr mountd 8
613gets a
614.Dv SIGHUP
615signal (that causes an update of the export list)
616only when the file system is mounted via
617.Nm .
618.Sh BUGS
619It is possible for a corrupted file system to cause a crash.
620.Pp
621The
622.Fl p
623option will not list
624.Cm userquota
625or
626.Cm groupquota
627items from
628.Xr fstab 5
629because they are not true mount options and are not information returned by
630.Xr getmntinfo 3 .
631At boot
632.Xr quotacheck 8 ,
633processes these items.
634