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