xref: /freebsd/usr.sbin/nfsd/nfsd.8 (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
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.\"	@(#)nfsd.8	8.4 (Berkeley) 3/29/95
33.\" $FreeBSD$
34.\"
35.Dd March 29, 1995
36.Dt NFSD 8
37.Os
38.Sh NAME
39.Nm nfsd
40.Nd remote
41.Tn NFS
42server
43.Sh SYNOPSIS
44.Nm nfsd
45.Op Fl arut
46.Op Fl n Ar num_servers
47.Op Fl h Ar bindip
48.Sh DESCRIPTION
49.Nm Nfsd
50runs on a server machine to service
51.Tn NFS
52requests from client machines.
53At least one
54.Nm nfsd
55must be running for a machine to operate as a server.
56.Pp
57Unless otherwise specified, four servers for
58.Tn UDP
59transport are started.
60.Pp
61The following options are available:
62.Bl -tag -width Ds
63.It Fl r
64Register the
65.Tn NFS
66service with
67.Xr portmap 8
68without creating any servers.
69This option can be used along with the
70.Fl u
71or
72.Fl t
73options to re-register NFS if the portmap server is restarted.
74.It Fl n
75Specifies how many servers to create.
76.It Fl h Ar bindip
77Specifies which IP address or hostname to bind to on the local host.
78This option is recommended when a host has multiple interfaces. Multiple
79.Fl h
80options may be specified.
81.It Fl a
82Specifies that nfsd should bind to the wildcard IP address.
83This is the default if no
84.Fl h
85options are given.  It may also be specified in addition to any
86.Fl h
87options given.  Note that NFS/UDP does not operate properly when
88bound to the wildcard IP address whether you use -a or do not use -h.
89.It Fl t
90Serve
91.Tn TCP NFS
92clients.
93.It Fl u
94Serve
95.Tn UDP NFS
96clients.
97.El
98.Pp
99For example,
100.Dq Li "nfsd -u -t -n 6"
101serves
102.Tn UDP
103and
104.Tn TCP
105transports using six daemons.
106.Pp
107A server should run enough daemons to handle
108the maximum level of concurrency from its clients,
109typically four to six.
110.Pp
111.Nm Nfsd
112listens for service requests at the port indicated in the
113.Tn NFS
114server specification; see
115.%T "Network File System Protocol Specification" ,
116RFC1094 and
117.%T "NFS: Network File System Version 3 Protocol Specification" .
118.Pp
119If
120.Nm nfsd
121detects that
122.Tn NFS
123is not loaded in the running kernel, it will attempt
124to load a loadable kernel module containing
125.Tn NFS
126support using
127.Xr kldload 8
128by way of
129.Xr vfsload 3 .
130If this fails, or no
131.Tn NFS
132KLD is available,
133.Nm nfsd
134will exit with an error.
135.Pp
136If
137.Nm nfsd
138is to be run on a host with multiple interfaces or interface aliases, use
139of the
140.Fl h
141option is recommended.  If you do not use the option NFS may not respond to
142UDP packets from the same IP address they were sent to.  Use of this option
143is also recommended when securing NFS exports on a firewalling machine such
144that the NFS sockets can only be accessed by the inside interface.
145.Nm Ipfw
146would then be used to block nfs-related packets that come in on the outside
147interface.
148.Pp
149The
150.Nm nfsd
151utility exits 0 on success, and >0 if an error occurs.
152.Sh SEE ALSO
153.Xr nfsstat 1 ,
154.Xr nfssvc 2 ,
155.Xr kldload 8 ,
156.Xr mountd 8 ,
157.Xr nfsiod 8 ,
158.Xr portmap 8 ,
159.Xr ipfw 8
160.Sh HISTORY
161The
162.Nm nfsd
163utility first appeared in
164.Bx 4.4 .
165