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