xref: /freebsd/sbin/mount/mount.8 (revision a3cf0ef5a295c885c895fabfd56470c0d1db322d)
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.\" 4. 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.\"     @(#)mount.8	8.8 (Berkeley) 6/16/94
29.\" $FreeBSD$
30.\"
31.Dd February 10, 2010
32.Dt MOUNT 8
33.Os
34.Sh NAME
35.Nm mount
36.Nd mount file systems
37.Sh SYNOPSIS
38.Nm
39.Op Fl adflpruvw
40.Op Fl F Ar fstab
41.Op Fl o Ar options
42.Op Fl t Cm ufs | Ar external_type
43.Nm
44.Op Fl dfpruvw
45.Ar special | node
46.Nm
47.Op Fl dfpruvw
48.Op Fl o Ar options
49.Op Fl t Cm ufs | Ar external_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 a
76All the file systems described in
77.Xr fstab 5
78are mounted.
79Exceptions are those marked as
80.Dq Li noauto ,
81those marked as
82.Dq Li late
83(unless the
84.Fl l
85option was specified),
86those excluded by the
87.Fl t
88flag (see below), or if they are already mounted (except the
89root file system which is always remounted to preserve
90traditional single user mode behavior).
91.It Fl d
92Causes everything to be done except for the actual system call.
93This option is useful in conjunction with the
94.Fl v
95flag to
96determine what the
97.Nm
98command is trying to do.
99.It Fl F Ar fstab
100Specify the
101.Pa fstab
102file to use.
103.It Fl f
104Forces the revocation of write access when trying to downgrade
105a file system mount status from read-write to read-only.
106Also
107forces the R/W mount of an unclean file system (dangerous; use with
108caution).
109.It Fl l
110When used in conjunction with the
111.Fl a
112option, also mount those file systems which are marked as
113.Dq Li late .
114.It Fl o
115Options are specified with a
116.Fl o
117flag followed by a comma separated string of options.
118In case of conflicting options being specified, the rightmost option
119takes effect.
120The following options are available:
121.Bl -tag -width indent
122.It Cm acls
123Enable POSIX.1e Access Control Lists, or ACLs, which can be customized via the
124.Xr setfacl 1
125and
126.Xr getfacl 1
127commands.
128This flag is mutually exclusive with
129.Cm nfsv4acls
130flag.
131.It Cm async
132All
133.Tn I/O
134to the file system should be done asynchronously.
135This is a
136.Em dangerous
137flag to set, since it does not guarantee that the file system structure
138on the disk will remain consistent.
139For this reason, the
140.Cm async
141flag should be used sparingly, and only when some data recovery
142mechanism is present.
143.It Cm current
144When used with the
145.Fl u
146flag, this is the same as specifying the options currently in effect for
147the mounted file system.
148.It Cm force
149The same as
150.Fl f ;
151forces the revocation of write access when trying to downgrade
152a file system mount status from read-write to read-only.
153Also
154forces the R/W mount of an unclean file system (dangerous; use with caution).
155.It Cm fstab
156When used with the
157.Fl u
158flag, this is the same as specifying all the options listed in the
159.Xr fstab 5
160file for the file system.
161.It Cm late
162This file system should be skipped when
163.Nm
164is run with the
165.Fl a
166flag but without the
167.Fl l
168flag.
169.It Cm mountprog Ns = Ns Aq Ar program
170Force
171.Nm
172to use the specified program to mount the file system, instead of calling
173.Xr nmount 2
174directly.  For example:
175.Bd -literal
176mount -t foofs -o mountprog=/mydir/fooprog /dev/acd0 /mnt
177.Ed
178.It Cm multilabel
179Enable multi-label Mandatory Access Control, or MAC, on the specified file
180system.
181If the file system supports multilabel operation, individual labels will
182be maintained for each object in the file system, rather than using a
183single label for all objects.
184An alternative to the
185.Fl l
186flag in
187.Xr tunefs 8 .
188See
189.Xr mac 4
190for more information, which cause the multilabel mount flag to be set
191automatically at mount-time.
192.It Cm nfsv4acls
193Enable NFSv4 ACLs, which can be customized via the
194.Xr setfacl 1
195and
196.Xr getfacl 1
197commands.
198This flag is mutually exclusive with
199.Cm acls
200flag.
201.It Cm noasync
202Metadata I/O should be done synchronously, while data I/O should be done
203asynchronously.
204This is the default.
205.It Cm noatime
206Do not update the file access time when reading from a file.
207This option
208is useful on file systems where there are large numbers of files and
209performance is more critical than updating the file access time (which is
210rarely ever important).
211This option is currently only supported on local file systems.
212.It Cm noauto
213This file system should be skipped when
214.Nm
215is run with the
216.Fl a
217flag.
218.It Cm noclusterr
219Disable read clustering.
220.It Cm noclusterw
221Disable write clustering.
222.It Cm noexec
223Do not allow execution of any binaries on the mounted file system.
224This option is useful for a server that has file systems containing
225binaries for architectures other than its own.
226Note: This option was not designed as a security feature and no
227guarantee is made that it will prevent malicious code execution; for
228example, it is still possible to execute scripts which reside on a
229.Cm noexec
230mounted partition.
231.It Cm nosuid
232Do not allow set-user-identifier or set-group-identifier bits to take effect.
233Note: this option is worthless if a public available suid or sgid
234wrapper like
235.Xr suidperl 1
236is installed on your system.
237It is set automatically when the user does not have super-user privileges.
238.It Cm nosymfollow
239Do not follow symlinks
240on the mounted file system.
241.It Cm ro
242The same as
243.Fl r ;
244mount the file system read-only (even the super-user may not write it).
245.It Cm snapshot
246This option allows a snapshot of the specified file system to be taken.
247The
248.Fl u
249flag is required with this option.
250Note that snapshot files must be created in the file system that is being
251snapshotted.
252You may create up to 20 snapshots per file system.
253Active snapshots are recorded in the superblock, so they persist across unmount
254and remount operations and across system reboots.
255When you are done with a snapshot, it can be removed with the
256.Xr rm 1
257command.
258Snapshots may be removed in any order, however you may not get back all the
259space contained in the snapshot as another snapshot may claim some of the blocks
260that it is releasing.
261Note that the schg flag is set on snapshots to ensure that not even the root
262user can write to them.
263The unlink command makes an exception for snapshot files in that it allows them
264to be removed even though they have the schg flag set, so it is not necessary to
265clear the schg flag before removing a snapshot file.
266.Pp
267Once you have taken a snapshot, there are three interesting things that you can
268do with it:
269.Pp
270.Bl -enum -compact
271.It
272Run
273.Xr fsck 8
274on the snapshot file.
275Assuming that the file system was clean when it was mounted, you should always
276get a clean (and unchanging) result from running fsck on the snapshot.
277This is essentially what the background fsck process does.
278.Pp
279.It
280Run
281.Xr dump 8
282on the snapshot.
283You will get a dump that is consistent with the file system as of the timestamp
284of the snapshot.
285.Pp
286.It
287Mount the snapshot as a frozen image of the file system.
288To mount the snapshot
289.Pa /var/snapshot/snap1 :
290.Bd -literal
291mdconfig -a -t vnode -f /var/snapshot/snap1 -u 4
292mount -r /dev/md4 /mnt
293.Ed
294.Pp
295You can now cruise around your frozen
296.Pa /var
297file system at
298.Pa /mnt .
299Everything will be in the same state that it was at the time the snapshot was
300taken.
301The one exception is that any earlier snapshots will appear as zero length
302files.
303When you are done with the mounted snapshot:
304.Bd -literal
305umount /mnt
306mdconfig -d -u 4
307.Ed
308.Pp
309Further details can be found in the file at
310.Pa /usr/src/sys/ufs/ffs/README.snapshot .
311.El
312.It Cm suiddir
313A directory on the mounted file system will respond to the SUID bit
314being set, by setting the owner of any new files to be the same
315as the owner of the directory.
316New directories will inherit the bit from their parents.
317Execute bits are removed from
318the file, and it will not be given to root.
319.Pp
320This feature is designed for use on fileservers serving PC users via
321ftp, SAMBA, or netatalk.
322It provides security holes for shell users and as
323such should not be used on shell machines, especially on home directories.
324This option requires the SUIDDIR
325option in the kernel to work.
326Only UFS file systems support this option.
327See
328.Xr chmod 2
329for more information.
330.It Cm sync
331All
332.Tn I/O
333to the file system should be done synchronously.
334.It Cm update
335The same as
336.Fl u ;
337indicate that the status of an already mounted file system should be changed.
338.It Cm union
339Causes the namespace at the mount point to appear as the union
340of the mounted file system root and the existing directory.
341Lookups will be done in the mounted file system first.
342If those operations fail due to a non-existent file the underlying
343directory is then accessed.
344All creates are done in the mounted file system.
345.El
346.Pp
347Any additional options specific to a file system type that is not
348one of the internally known types (see the
349.Fl t
350option) may be passed as a comma separated list; these options are
351distinguished by a leading
352.Dq \&-
353(dash).
354Options that take a value are specified using the syntax -option=value.
355For example, the
356.Nm
357command:
358.Bd -literal -offset indent
359mount -t cd9660 -o -e /dev/cd0 /cdrom
360.Ed
361.Pp
362causes
363.Nm
364to execute the equivalent of:
365.Bd -literal -offset indent
366/sbin/mount_cd9660 -e /dev/cd0 /cdrom
367.Ed
368.Pp
369Additional options specific to file system types
370which are not internally known
371(see the description of the
372.Fl t
373option below)
374may be described in the manual pages for the associated
375.Pa /sbin/mount_ Ns Sy XXX
376utilities.
377.It Fl p
378Print mount information in
379.Xr fstab 5
380format.
381Implies also the
382.Fl v
383option.
384.It Fl r
385The file system is to be mounted read-only.
386Mount the file system read-only (even the super-user may not write it).
387The same as the
388.Cm ro
389argument to the
390.Fl o
391option.
392.It Fl t Cm ufs | Ar external_type
393The argument following the
394.Fl t
395is used to indicate the file system type.
396The type
397.Cm ufs
398is the default.
399The
400.Fl t
401option can be used
402to indicate that the actions should only be taken on
403file systems of the specified type.
404More than one type may be specified in a comma separated list.
405The list of file system types can be prefixed with
406.Dq Li no
407to specify the file system types for which action should
408.Em not
409be taken.
410For example, the
411.Nm
412command:
413.Bd -literal -offset indent
414mount -a -t nonfs,nullfs
415.Ed
416.Pp
417mounts all file systems except those of type
418.Tn NFS
419and
420.Tn NULLFS .
421.Pp
422The default behavior of
423.Nm
424is to pass the
425.Fl t
426option directly to the
427.Xr nmount 2
428system call in the
429.Li fstype
430option.
431.Pp
432However, for the following file system types:
433.Cm cd9660 ,
434.Cm mfs ,
435.Cm msdosfs ,
436.Cm newnfs ,
437.Cm nfs ,
438.Cm ntfs ,
439.Cm nwfs ,
440.Cm nullfs ,
441.Cm portalfs ,
442.Cm smbfs ,
443.Cm udf ,
444and
445.Cm unionfs ,
446.Nm
447will not call
448.Xr nmount 2
449directly and will instead attempt to execute a program in
450.Pa /sbin/mount_ Ns Sy XXX
451where
452.Sy XXX
453is replaced by the file system type name.
454For example, nfs file systems are mounted by the program
455.Pa /sbin/mount_nfs .
456.Pp
457Most file systems will be dynamically loaded by the kernel
458if not already present, and if the kernel module is available.
459.It Fl u
460The
461.Fl u
462flag indicates that the status of an already mounted file
463system should be changed.
464Any of the options discussed above (the
465.Fl o
466option)
467may be changed;
468also a file system can be changed from read-only to read-write
469or vice versa.
470An attempt to change from read-write to read-only will fail if any
471files on the file system are currently open for writing unless the
472.Fl f
473flag is also specified.
474The set of options is determined by applying the options specified
475in the argument to
476.Fl o
477and finally applying the
478.Fl r
479or
480.Fl w
481option.
482.It Fl v
483Verbose mode.
484If the
485.Fl v
486is used alone, show all file systems, including those that were mounted with the
487.Dv MNT_IGNORE
488flag and show additional information about each file system (including fsid
489when run by root).
490.It Fl w
491The file system object is to be read and write.
492.El
493.Sh ENVIRONMENT
494.Bl -tag -width ".Ev PATH_FSTAB"
495.It Ev PATH_FSTAB
496If the environment variable
497.Ev PATH_FSTAB
498is set, all operations are performed against the specified file.
499.Ev PATH_FSTAB
500will not be honored if the process environment or memory address space is
501considered
502.Dq tainted .
503(See
504.Xr issetugid 2
505for more information.)
506.El
507.Sh FILES
508.Bl -tag -width /etc/fstab -compact
509.It Pa /etc/fstab
510file system table
511.El
512.Sh DIAGNOSTICS
513Various, most of them are self-explanatory.
514.Pp
515.Dl XXXXX file system is not available
516.Pp
517The kernel does not support the respective file system type.
518Note that
519support for a particular file system might be provided either on a static
520(kernel compile-time), or dynamic basis (loaded as a kernel module by
521.Xr kldload 8 ) .
522.Sh SEE ALSO
523.Xr getfacl 1 ,
524.Xr setfacl 1 ,
525.Xr nmount 2 ,
526.Xr acl 3 ,
527.Xr mac 4 ,
528.Xr devfs 5 ,
529.Xr ext2fs 5 ,
530.Xr fstab 5 ,
531.Xr procfs 5 ,
532.Xr kldload 8 ,
533.Xr mount_cd9660 8 ,
534.Xr mount_msdosfs 8 ,
535.Xr mount_nfs 8 ,
536.Xr mount_ntfs 8 ,
537.Xr mount_nullfs 8 ,
538.Xr mount_nwfs 8 ,
539.Xr mount_portalfs 8 ,
540.Xr mount_smbfs 8 ,
541.Xr mount_udf 8 ,
542.Xr mount_unionfs 8 ,
543.Xr umount 8 ,
544.Xr zfs 8 ,
545.Xr zpool 8
546.Sh HISTORY
547A
548.Nm
549utility appeared in
550.At v1 .
551.Sh CAVEATS
552After a successful
553.Nm ,
554the permissions on the original mount point determine if
555.Pa ..\&
556is accessible from the mounted file system.
557The minimum permissions for
558the mount point for traversal across the mount point in both
559directions to be possible for all users is 0111 (execute for all).
560.Pp
561Use of the
562.Nm
563is preferred over the use of the file system specific
564.Pa mount_ Ns Sy XXX
565commands.
566In particular,
567.Xr mountd 8
568gets a
569.Dv SIGHUP
570signal (that causes an update of the export list)
571only when the file system is mounted via
572.Nm .
573.Sh BUGS
574It is possible for a corrupted file system to cause a crash.
575