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