xref: /freebsd/sbin/mount/mount.8 (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
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. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)mount.8	8.8 (Berkeley) 6/16/94
33.\" $FreeBSD$
34.\"
35.Dd June 16, 1994
36.Dt MOUNT 8
37.Os BSD 4
38.Sh NAME
39.Nm mount
40.Nd mount file systems
41.Sh SYNOPSIS
42.Nm mount
43.Op Fl adfpruvw
44.Op Fl t Ar ufs | lfs | external_type
45.Nm mount
46.Op Fl dfpruvw
47.Ar special | node
48.Nm mount
49.Op Fl dfpruvw
50.Op Fl o Ar options
51.Op Fl t Ar ufs | lfs | external_type
52.Ar special node
53.Sh DESCRIPTION
54The
55.Nm
56command
57calls the
58.Xr mount 2
59system call to prepare and graft a
60.Ar "special device"
61or the remote node (rhost:path) on to the file system tree at the point
62.Ar node .
63If either
64.Ar special
65or
66.Ar node
67are not provided, the appropriate information is taken from the
68.Xr fstab 5
69file.
70.Pp
71The system maintains a list of currently mounted file systems.
72If no arguments are given to
73.Nm mount ,
74this list is printed.
75.Pp
76The options are as follows:
77.Bl -tag -width indent
78.It Fl a
79All the filesystems described in
80.Xr fstab 5
81are mounted.
82Exceptions are those marked as ``noauto'', excluded by the
83.Fl t
84flag (see below), or if they are already mounted (except the
85root filesystem which is always remounted to preserve
86traditional single user mode behavior).
87.It Fl d
88Causes everything to be done except for the actual system call.
89This option is useful in conjunction with the
90.Fl v
91flag to
92determine what the
93.Nm
94command is trying to do.
95.It Fl f
96Forces the revocation of write access when trying to downgrade
97a filesystem mount status from read-write to read-only. Also
98forces the R/W mount of an unclean filesystem (dangerous; use with
99caution).
100.It Fl o
101Options are specified with a
102.Fl o
103flag followed by a comma separated string of options.
104In case of conflicting options being specified, the rightmost option
105takes effect.
106The following options are available:
107.Bl -tag -width indent
108.It async
109All
110.Tn I/O
111to the file system should be done asynchronously.
112This is a
113.Em dangerous
114flag to set,
115and should not be used unless you are prepared to recreate the file
116system should your system crash.
117.It current
118When used with the
119.Fl u
120flag, this is the same as specifying the options currently in effect for
121the mounted filesystem.
122.It force
123The same as
124.Fl f ;
125forces the revocation of write access when trying to downgrade
126a filesystem mount status from read-write to read-only. Also
127forces the R/W mount of an unclean filesystem (dangerous; use with caution).
128.It fstab
129When used with the
130.Fl u
131flag, this is the same as specifying all the options listed in the
132.Xr fstab 5
133file for the filesystem.
134.It noasync
135Metadata I/O should be done synchronously, while data I/O should be done
136asynchronously.  This is the default.
137.It noatime
138Do not update the file access time when reading from a file. This option
139is useful on filesystems where there are large numbers of files and
140performance is more critical than updating the file access time (which is
141rarely ever important). This option is currently only supported on local
142filesystems.
143.It noauto
144This filesystem should be skipped when mount is run with the
145.Fl a
146flag.
147.It noclusterr
148Disable read clustering.
149.It noclusterw
150Disable write clustering.
151.It nodev
152Do not interpret character or block special devices on the file system.
153This option is useful for a server that has file systems containing
154special devices for architectures other than its own.
155.It noexec
156Do not allow execution of any binaries on the mounted file system.
157This option is useful for a server that has file systems containing
158binaries for architectures other than its own.
159.It nosuid
160Do not allow set-user-identifier or set-group-identifier bits to take effect.
161Note: this option is worthless if a public available suid or sgid
162wrapper like
163.Xr suidperl 1
164is installed on your system.
165.It nosymfollow
166Do not follow symlinks
167on the mounted file system.
168.It rdonly
169The same as
170.Fl r ;
171mount the file system read-only (even the super-user may not write it).
172.It sync
173All
174.Tn I/O
175to the file system should be done synchronously.
176.It suiddir
177A directory on the mounted filesystem will respond to the SUID bit
178being set, by setting the owner of any new files to be the same
179as the owner of the directory.
180New directories will inherit the bit from their parents.
181Execute bits are removed from
182the file, and it will not be given to root.
183.Pp
184This feature is designed for use on fileservers serving PC users via
185ftp, SAMBA, or netatalk. It provides security holes for shell users and as
186such should not be used on shell machines, especially on home directories.
187This option requires the SUIDDIR
188option in the kernel to work. Only UFS filesystems support this option.
189See
190.Xr chmod 2
191for more information.
192.It update
193The same as
194.Fl u ;
195indicate that the status of an already mounted file system should be changed.
196.It union
197Causes the namespace at the mount point to appear as the union
198of the mounted filesystem root and the existing directory.
199Lookups will be done in the mounted filesystem first.
200If those operations fail due to a non-existent file the underlying
201directory is then accessed.
202All creates are done in the mounted filesystem.
203.El
204.Pp
205Any additional options specific to a filesystem type that is not
206one of the internally known types (see the
207.Fl t
208option) may be passed as a comma separated list; these options are
209distinguished by a leading
210.Dq \&-
211(dash).
212Options that take a value are specified using the syntax -option=value.
213For example, the
214.Nm
215command:
216.Bd -literal -offset indent
217mount -t mfs -o nosuid,-N,-s=4000 /dev/dk0b /tmp
218.Ed
219.Pp
220causes
221.Nm
222to execute the equivalent of:
223.Bd -literal -offset indent
224/sbin/mount_mfs -o nosuid -N -s 4000 /dev/dk0b /tmp
225.Ed
226.It Fl p
227Print mount information in fstab format. Implies also the
228.Fl v
229option.
230.It Fl r
231The file system is to be mounted read-only.
232Mount the file system read-only (even the super-user may not write it).
233The same as the
234.Dq rdonly
235argument to the
236.Fl o
237option.
238.It Fl t Ar "ufs \\*(Ba lfs \\*(Ba external type"
239The argument following the
240.Fl t
241is used to indicate the file system type.
242The type
243.Ar ufs
244is the default.
245The
246.Fl t
247option can be used
248to indicate that the actions should only be taken on
249filesystems of the specified type.
250More than one type may be specified in a comma separated list.
251The list of filesystem types can be prefixed with
252.Dq no
253to specify the filesystem types for which action should
254.Em not
255be taken.
256For example, the
257.Nm
258command:
259.Bd -literal -offset indent
260mount -a -t nonfs,mfs
261.Ed
262.Pp
263mounts all filesystems except those of type
264.Tn NFS
265and
266.Tn MFS .
267.Pp
268If the type is not one of the internally known types,
269.Nm
270will attempt to execute a program in
271.Pa /sbin/mount_ Ns Em XXX
272where
273.Em XXX
274is replaced by the type name.
275For example, nfs filesystems are mounted by the program
276.Pa /sbin/mount_nfs .
277.Pp
278Most filesystems will be dynamically loaded by their mount programs
279if not already present in the kernel, using the
280.Xr vfsload 3
281subroutine.  Because this mechanism requires writable temporary space,
282the filesystem type containing
283.Pa /tmp
284must be compiled into the kernel, and the filesystems containing
285.Pa /tmp
286and
287.Pa /usr/bin/ld
288must be listed in
289.Pa /etc/fstab
290before any filesystems which might be dynamically loaded.
291.It Fl u
292The
293.Fl u
294flag indicates that the status of an already mounted file
295system should be changed.
296Any of the options discussed above (the
297.Fl o
298option)
299may be changed;
300also a file system can be changed from read-only to read-write
301or vice versa.
302An attempt to change from read-write to read-only will fail if any
303files on the filesystem are currently open for writing unless the
304.Fl f
305flag is also specified.
306The set of options is determined by applying the options specified
307in the argument to
308.Fl o
309and finally applying the
310.Fl r
311or
312.Fl w
313option.
314.It Fl v
315Verbose mode.
316.It Fl w
317The file system object is to be read and write.
318.Pp
319The options specific to NFS filesystems are described in the
320.Xr mount_nfs 8
321manual page.
322.Sh DIAGNOSTICS
323Various, most of them are self-explanatory.
324.Pp
325.Dl XXXXX filesystem is not available
326.Pp
327The kernel doesn't support the respective filesystem type.  Note that
328support for a particular filesystem might be provided either on a static
329(kernel compile-time), or dynamic basis (loaded as a kernel module by
330.Xr kldload 8 ).
331Normally,
332.Nm
333or its subprocesses attempt to dynamically load a filesystem module if
334it hasn't been configured statically, using
335.Xr vfsload 3 .
336In this case, the above error message can also mean that you didn't
337have permission to load the module.
338.Sh FILES
339.Bl -tag -width /etc/fstab -compact
340.It Pa /etc/fstab
341file system table
342.El
343.Sh SEE ALSO
344.Xr mount 2 ,
345.Xr vfsload 3 ,
346.Xr fstab 5 ,
347.Xr kldload 8 ,
348.Xr mount_cd9660 8 ,
349.Xr mount_devfs 8 ,
350.Xr mount_fdesc 8 ,
351.Xr mount_kernfs 8 ,
352.Xr mount_lfs 8 ,
353.Xr mount_mfs 8 ,
354.Xr mount_msdos 8 ,
355.Xr mount_nfs 8 ,
356.Xr mount_null 8 ,
357.Xr mount_portal 8 ,
358.Xr mount_procfs 8 ,
359.Xr mount_umap 8 ,
360.Xr mount_union 8 ,
361.Xr umount 8
362.Sh BUGS
363It is possible for a corrupted file system to cause a crash.
364.Sh CAVEATS
365After a successful mount, the permissions on the original mount point
366determine if
367.Pa ".."
368is accessible from the mounted file system.  The minimum permissions for
369the mount point for traversal across the mount point in both
370directions to be possible for all users is 0111 (execute for all).
371.Sh HISTORY
372A
373.Nm
374command appeared in
375.At v1 .
376