hammer2 - Retool dmsg mechanics to improve virtual circuit design 2/2
[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_fdesc ,
41 .Nm mount_linprocfs ,
42 .Nm mount_procfs
43 .Nd mount
44 .Dq standard
45 filesystems
46 .Sh SYNOPSIS
47 .Nm mount_ Ns Ar fsname
48 .Op Fl o Ar options
49 .Ar "fs"
50 .Ar mount_point
51 .Sh DESCRIPTION
52 The
53 .Nm
54 command is a generic mechanism for attaching ``standard'' filesystems to
55 the filesystem.  The
56 .Nm
57 command currently supports the following filesystems:
58 .Nm fdesc ,
59 .Nm linprocfs
60 and
61 .Nm procfs .
62 A ``standard'' filesystem is one which:
63 .Bl -enum -offset indent
64 .It
65 accepts only the standard
66 .Fl o
67 options
68 .Dq ro
69 .Pq Dq rdonly ,
70 .Dq rw ,
71 .Dq nodev ,
72 .Dq noexec ,
73 .Dq nosuid ,
74 and
75 .Dq union .
76 .It
77 has a kernel filesystem module name the same as its user-visible name.
78 .It
79 requires no other special processing on the part of the
80 .Nm
81 command.
82 .El
83 .Pp
84 The options are as follows:
85 .Bl -tag -width indent
86 .It Fl o
87 Options are specified with a
88 .Fl o
89 flag followed by a comma separated string of options.
90 See the
91 .Xr mount 8
92 man page for possible options and their meanings.
93 .El
94 .Pp
95 The
96 .Nm
97 command examines its zeroth command-line argument (the name by which
98 it was called) to determine the type of filesystem to be mounted.  If
99 it is called by a name which does not end in
100 .Dq Li _ Ns Ar fsname ,
101 .Nm
102 will assume (for compatibility
103 with
104 .Xr mount 8 )
105 that the zeroth argument contains only the name of the filesystem type.
106 The
107 .Nm
108 command is normally installed with appropriate links to commands for
109 the distributed filesystems which can be mounted in this way;
110 for information on the function of each filesystem, see the manual page
111 for that specific
112 .Nm mount_ Ns Ar fsname
113 command.
114 .Pp
115 Refer to the following manual pages for detailed information
116 on these file system:
117 .Xr fdesc 5 ,
118 .Xr linprocfs 5
119 and
120 .Xr procfs 5 .
121 .Sh DIAGNOSTICS
122 .Bl -diag
123 .It argv[0] must end in _fsname
124 .Nm Mount_std
125 was called with a zeroth argument of
126 .Dq Li mount_std .
127 .It vfsload(%s)
128 .Nm Mount_std
129 was unable to load a kernel module implementing the %s filesystem
130 type.
131 .It %s filesystem not available
132 The specified filesystem type was not present in the kernel and no
133 loadable module for it was found.
134 .El
135 .Sh SEE ALSO
136 .Xr mount 2 ,
137 .Xr unmount 2 ,
138 .Xr getvfsbyname 3 ,
139 .Xr fdesc 5 ,
140 .Xr fstab 5 ,
141 .Xr linprocfs 5 ,
142 .Xr procfs 5 ,
143 .Xr mount 8
144 .Sh HISTORY
145 The
146 .Nm
147 utility first appeared in
148 .Fx 2.2 .
149 Loadable filesystem modules first appeared in
150 .Fx 2.0 .
151 The
152 .Dq fdesc
153 and
154 .Dq procfs
155 filesystem types first appeared in
156 .Fx 2.0 ;
157 the
158 .Dq linprocfs
159 filesystem type first appeared in
160 .Fx 4.0 .
161 .Sh CAVEATS
162 None of the ``standard'' filesystems may be NFS-exported.