xref: /netbsd-src/usr.sbin/nfsd/nfsd.8 (revision 5cbe00119b70061002b2d99836eff17da1b9158b)
1.\"   $NetBSD: nfsd.8,v 1.24 2016/03/17 15:25:46 christos Exp $
2.\"
3.\" Copyright (c) 1989, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"	@(#)nfsd.8	8.4 (Berkeley) 3/29/95
31.\"
32.Dd March 17, 2016
33.Dt NFSD 8
34.Os
35.Sh NAME
36.Nm nfsd
37.Nd remote
38.Tn NFS
39server
40.Sh SYNOPSIS
41.Nm
42.Op Fl 46drut
43.Op Fl n Ar num_threads
44.Sh DESCRIPTION
45.Nm
46runs on a server machine to service
47.Tn NFS
48requests from client machines.
49At least one
50.Nm
51must be running for a machine to operate as a server.
52.Pp
53Unless otherwise specified, four servers for
54.Tn UDP
55transport are started.
56.Pp
57The following options are available:
58.Bl -tag -width Ds
59.It Fl d
60Turn on debugging, don't fork and log to stderr.
61.It Fl r
62Register the
63.Tn NFS
64service with
65.Xr rpcbind 8
66without creating any servers.
67This option can be used along with the
68.Fl u
69or
70.Fl t
71options to re-register NFS if the portmap server is restarted.
72.It Fl n
73Specifies how many server threads to create.
74The default is 4.
75A server should run enough threads to handle
76the maximum level of concurrency from its clients.
77.It Fl 4
78Only listen to IPv4 requests.
79By default
80.Nm
81listens to both IPv6 and IPv4 and tries to register for both.
82.It Fl 6
83Only listen to IPv6 requests.
84.It Fl t
85Serve only
86.Tn TCP NFS
87clients.
88By default
89.Nm
90serves both
91.Tn TCP NFS
92and
93.Tn UDP NFS
94clients
95.It Fl u
96Serve only
97.Tn UDP NFS
98clients.
99.El
100.Pp
101.Nm
102listens for service requests at the port indicated in the
103.Tn NFS
104server specification; see
105.%T "Network File System Protocol Specification" ,
106RFC 1094 and
107.%T "NFS: Network File System Version 3 Protocol Specification" .
108.Sh EXIT STATUS
109.Ex -std nfsd
110.Sh EXAMPLES
111.Dq Li "nfsd -n 6"
112serves
113.Tn UDP
114and
115.Tn TCP
116transports using six threads.
117.Sh SEE ALSO
118.Xr nfsstat 1 ,
119.Xr nfssvc 2 ,
120.Xr mountd 8 ,
121.Xr rpcbind 8
122.Sh HISTORY
123The
124.Nm
125utility first appeared in
126.Bx 4.4 .
127