884d805cf46c7426903422784f39d8f91d35d3fc
[dragonfly.git] / sbin / mount_std / mount_std.8
1 .\"
2 .\" Copyright (c) 1992, 1993, 1994
3 .\"     The Regents of the University of California.  All rights reserved.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software donated to Berkeley by
7 .\" Jan-Simon Pendry.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\" 3. Neither the name of the University nor the names of its contributors
18 .\"    may be used to endorse or promote products derived from this software
19 .\"    without specific prior written permission.
20 .\"
21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" SUCH DAMAGE.
32 .\"
33 .\" $FreeBSD: src/sbin/mount_std/mount_std.8,v 1.9.2.7 2003/02/10 12:21:07 des Exp $
34 .\"
35 .Dd July 5, 2012
36 .Dt MOUNT_STD 8
37 .Os
38 .Sh NAME
39 .Nm mount_std ,
40 .Nm mount_linprocfs ,
41 .Nm mount_procfs
42 .Nd mount
43 .Dq standard
44 filesystems
45 .Sh SYNOPSIS
46 .Nm mount_ Ns Ar fsname
47 .Op Fl o Ar options
48 .Ar "fs"
49 .Ar mount_point
50 .Sh DESCRIPTION
51 The
52 .Nm
53 command is a generic mechanism for attaching ``standard'' filesystems to
54 the filesystem.  The
55 .Nm
56 command currently supports the following filesystems:
57 .Nm linprocfs
58 and
59 .Nm procfs .
60 A ``standard'' filesystem is one which:
61 .Bl -enum -offset indent
62 .It
63 accepts only the standard
64 .Fl o
65 options
66 .Dq ro
67 .Pq Dq rdonly ,
68 .Dq rw ,
69 .Dq nodev ,
70 .Dq noexec ,
71 .Dq nosuid ,
72 and
73 .Dq union .
74 .It
75 has a kernel filesystem module name the same as its user-visible name.
76 .It
77 requires no other special processing on the part of the
78 .Nm
79 command.
80 .El
81 .Pp
82 The options are as follows:
83 .Bl -tag -width indent
84 .It Fl o
85 Options are specified with a
86 .Fl o
87 flag followed by a comma separated string of options.
88 See the
89 .Xr mount 8
90 man page for possible options and their meanings.
91 .El
92 .Pp
93 The
94 .Nm
95 command examines its zeroth command-line argument (the name by which
96 it was called) to determine the type of filesystem to be mounted.  If
97 it is called by a name which does not end in
98 .Dq Li _ Ns Ar fsname ,
99 .Nm
100 will assume (for compatibility
101 with
102 .Xr mount 8 )
103 that the zeroth argument contains only the name of the filesystem type.
104 The
105 .Nm
106 command is normally installed with appropriate links to commands for
107 the distributed filesystems which can be mounted in this way;
108 for information on the function of each filesystem, see the manual page
109 for that specific
110 .Nm mount_ Ns Ar fsname
111 command.
112 .Pp
113 Refer to the following manual pages for detailed information
114 on these file system:
115 .Xr linprocfs 5
116 and
117 .Xr procfs 5 .
118 .Sh DIAGNOSTICS
119 .Bl -diag
120 .It argv[0] must end in _fsname
121 .Nm Mount_std
122 was called with a zeroth argument of
123 .Dq Li mount_std .
124 .It vfsload(%s)
125 .Nm Mount_std
126 was unable to load a kernel module implementing the %s filesystem
127 type.
128 .It %s filesystem not available
129 The specified filesystem type was not present in the kernel and no
130 loadable module for it was found.
131 .El
132 .Sh SEE ALSO
133 .Xr mount 2 ,
134 .Xr unmount 2 ,
135 .Xr getvfsbyname 3 ,
136 .Xr fstab 5 ,
137 .Xr linprocfs 5 ,
138 .Xr procfs 5 ,
139 .Xr mount 8
140 .Sh HISTORY
141 The
142 .Nm
143 utility first appeared in
144 .Fx 2.2 .
145 Loadable filesystem modules first appeared in
146 .Fx 2.0 .
147 The
148 .Dq procfs
149 filesystem type first appeared in
150 .Fx 2.0 ;
151 the
152 .Dq linprocfs
153 filesystem type first appeared in
154 .Fx 4.0 .
155 .Sh CAVEATS
156 None of the ``standard'' filesystems may be NFS-exported.