Merge from vendor branch HOSTAPD:
[dragonfly.git] / sbin / mountd / mountd.8
1 .\" Copyright (c) 1989, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)mountd.8    8.4 (Berkeley) 4/28/95
33 .\" $FreeBSD: src/sbin/mountd/mountd.8,v 1.16.2.2 2000/12/08 14:04:02 ru Exp $
34 .\" $DragonFly: src/sbin/mountd/mountd.8,v 1.2 2003/06/17 04:27:34 dillon Exp $
35 .\"
36 .Dd April 28, 1995
37 .Dt MOUNTD 8
38 .Os
39 .Sh NAME
40 .Nm mountd
41 .Nd service remote
42 .Tn NFS
43 mount requests
44 .Sh SYNOPSIS
45 .Nm
46 .Op Fl 2dlnr
47 .Op Ar exportsfile
48 .Sh DESCRIPTION
49 .Nm Mountd
50 is the server for
51 .Tn NFS
52 mount requests from other client machines.
53 It listens for service requests at the port indicated in the
54 .Tn NFS
55 server specification; see
56 .%T "Network File System Protocol Specification" ,
57 RFC1094, Appendix A and
58 .%T "NFS: Network File System Version 3 Protocol Specification" ,
59 Appendix I.
60 .Pp
61 The following options are available:
62 .Bl -tag -width indent
63 .It Fl 2
64 Allow the administrator to force clients to use only the
65 version 2
66 .Tn NFS
67 protocol to mount filesystems from this server.
68 .It Fl d
69 Output debugging information.
70 .It Fl l
71 Cause all succeeded
72 .Nm
73 requests to be logged.
74 .It Fl n
75 Allow non-root mount requests to be served.
76 This should only be specified if there are clients such as PC's,
77 that require it.
78 It will automatically clear the vfs.nfs.nfs_privport sysctl flag, which
79 controls if the kernel will accept NFS requests from reserved ports only.
80 .It Fl r
81 Allow mount RPCs requests for regular files to be served.
82 Although this seems to violate the mount protocol specification,
83 some diskless workstations do mount requests for
84 their swapfiles and expect them to be regular files.
85 Since a regular file cannot be specified in
86 .Pa /etc/exports ,
87 the entire file system in which the swapfiles resides
88 will have to be exported with the
89 .Fl alldirs
90 flag.
91 .It Ar exportsfile
92 Specify an alternate location
93 for the exports file.
94 .El
95 .Pp
96 When
97 .Nm
98 is started,
99 it loads the export host addresses and options into the kernel
100 using the
101 .Xr mount 2
102 system call.
103 After changing the exports file,
104 a hangup signal should be sent to the
105 .Nm
106 daemon
107 to get it to reload the export information.
108 After sending the SIGHUP
109 (kill \-s HUP `cat /var/run/mountd.pid`),
110 check the syslog output to see if
111 .Nm
112 logged any parsing
113 errors in the exports file.
114 .Pp
115 If
116 .Nm
117 detects that the running kernel does not include
118 .Tn NFS
119 support, it will attempt to load a loadable kernel module containing
120 .Tn NFS
121 code, using
122 .Xr kldload 8
123 by way of
124 .Xr vfsload 3 .
125 If this fails, or no
126 .Tn NFS
127 KLD was available,
128 .Nm
129 exits with an error.
130 .Sh FILES
131 .Bl -tag -width /var/run/mountd.pid -compact
132 .It Pa /etc/exports
133 the list of exported filesystems
134 .It Pa /var/run/mountd.pid
135 the pid of the currently running mountd
136 .It Pa /var/db/mountdtab
137 the current list of remote mounted filesystems
138 .El
139 .Sh SEE ALSO
140 .Xr nfsstat 1 ,
141 .Xr exports 5 ,
142 .Xr kldload 8 ,
143 .Xr nfsd 8 ,
144 .Xr portmap 8 ,
145 .Xr showmount 8
146 .Sh HISTORY
147 The
148 .Nm
149 utility first appeared in
150 .Bx 4.4 .