Bring in a transport-independent RPC (TI-RPC).
[dragonfly.git] / sbin / nfsd / nfsd.8
CommitLineData
984263bc
MD
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.
984263bc
MD
12.\" 4. Neither the name of the University nor the names of its contributors
13.\" may be used to endorse or promote products derived from this software
14.\" without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\" @(#)nfsd.8 8.4 (Berkeley) 3/29/95
ce0e08e2 29.\" $FreeBSD: src/usr.sbin/nfsd/nfsd.8,v 1.24 2005/01/17 07:44:42 ru Exp $
cabeba47 30.\" $DragonFly: src/sbin/nfsd/nfsd.8,v 1.4 2007/11/23 23:16:36 swildner Exp $
984263bc
MD
31.\"
32.Dd March 29, 1995
33.Dt NFSD 8
34.Os
35.Sh NAME
36.Nm nfsd
37.Nd remote
38.Tn NFS
39server
40.Sh SYNOPSIS
41.Nm
ce0e08e2 42.Op Fl ardut
984263bc
MD
43.Op Fl n Ar num_servers
44.Op Fl h Ar bindip
45.Sh DESCRIPTION
ce0e08e2
PA
46The
47.Nm
48utility runs on a server machine to service
984263bc
MD
49.Tn NFS
50requests from client machines.
51At least one
52.Nm
53must be running for a machine to operate as a server.
54.Pp
55Unless otherwise specified, four servers for
56.Tn UDP
57transport are started.
58.Pp
59The following options are available:
60.Bl -tag -width Ds
61.It Fl r
62Register the
63.Tn NFS
64service with
ce0e08e2 65.Xr rpcbind 8
984263bc
MD
66without creating any servers.
67This option can be used along with the
68.Fl u
69or
70.Fl t
ce0e08e2
PA
71options to re-register NFS if the rpcbind server is restarted.
72.It Fl d
73Unregister the
74.Tn NFS
75service with
76.Xr rpcbind 8
77without creating any servers.
984263bc
MD
78.It Fl n
79Specifies how many servers to create.
80.It Fl h Ar bindip
81Specifies which IP address or hostname to bind to on the local host.
82This option is recommended when a host has multiple interfaces.
83Multiple
84.Fl h
85options may be specified.
86.It Fl a
87Specifies that nfsd should bind to the wildcard IP address.
88This is the default if no
89.Fl h
ce0e08e2
PA
90options are given.
91It may also be specified in addition to any
984263bc 92.Fl h
ce0e08e2
PA
93options given.
94Note that NFS/UDP does not operate properly when
984263bc
MD
95bound to the wildcard IP address whether you use -a or do not use -h.
96.It Fl t
97Serve
98.Tn TCP NFS
99clients.
100.It Fl u
101Serve
102.Tn UDP NFS
103clients.
104.El
105.Pp
106For example,
107.Dq Li "nfsd -u -t -n 6"
108serves
109.Tn UDP
110and
111.Tn TCP
112transports using six daemons.
113.Pp
114A server should run enough daemons to handle
115the maximum level of concurrency from its clients,
116typically four to six.
117.Pp
ce0e08e2
PA
118The
119.Nm
120utility listens for service requests at the port indicated in the
984263bc
MD
121.Tn NFS
122server specification; see
123.%T "Network File System Protocol Specification" ,
cabeba47 124RFC 1094 and
984263bc
MD
125.%T "NFS: Network File System Version 3 Protocol Specification" .
126.Pp
127If
128.Nm
129detects that
130.Tn NFS
131is not loaded in the running kernel, it will attempt
132to load a loadable kernel module containing
133.Tn NFS
134support using
ce0e08e2 135.Xr kldload 2 .
984263bc
MD
136If this fails, or no
137.Tn NFS
138KLD is available,
139.Nm
140will exit with an error.
141.Pp
142If
143.Nm
144is to be run on a host with multiple interfaces or interface aliases, use
145of the
146.Fl h
ce0e08e2
PA
147option is recommended.
148If you do not use the option NFS may not respond to
149UDP packets from the same IP address they were sent to.
150Use of this option
984263bc
MD
151is also recommended when securing NFS exports on a firewalling machine such
152that the NFS sockets can only be accessed by the inside interface.
ce0e08e2
PA
153The
154.Nm ipfw
155utility
984263bc
MD
156would then be used to block nfs-related packets that come in on the outside
157interface.
158.Pp
ce0e08e2 159The
984263bc 160.Nm
ce0e08e2 161utility has to be terminated with
984263bc
MD
162.Dv SIGUSR1
163and cannot be killed with
164.Dv SIGTERM
165or
166.Dv SIGQUIT .
ce0e08e2 167The
984263bc 168.Nm
ce0e08e2 169utility needs to ignore these signals in order to stay alive as long
984263bc
MD
170as possible during a shutdown, otherwise loopback mounts will
171not be able to unmount.
172If you have to kill
173.Nm
174just do a
175.Dq Li "kill -USR1 <PID of master nfsd>"
ce0e08e2
PA
176.Sh EXIT STATUS
177.Ex -std
984263bc
MD
178.Sh SEE ALSO
179.Xr nfsstat 1 ,
ce0e08e2 180.Xr kldload 2 ,
984263bc 181.Xr nfssvc 2 ,
ce0e08e2 182.Xr exports 5 ,
375d1659 183.Xr ipfw 8 ,
984263bc
MD
184.Xr mountd 8 ,
185.Xr nfsiod 8 ,
ce0e08e2 186.Xr rpcbind 8
984263bc
MD
187.Sh HISTORY
188The
189.Nm
190utility first appeared in
191.Bx 4.4 .