xref: /netbsd-src/usr.sbin/nfsd/nfsd.8 (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1.\"   $NetBSD: nfsd.8,v 1.23 2012/08/13 08:39:28 wiz 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 August 12, 2012
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 46rut
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 r
60Register the
61.Tn NFS
62service with
63.Xr rpcbind 8
64without creating any servers.
65This option can be used along with the
66.Fl u
67or
68.Fl t
69options to re-register NFS if the portmap server is restarted.
70.It Fl n
71Specifies how many server threads to create.
72The default is 4.
73A server should run enough threads to handle
74the maximum level of concurrency from its clients.
75.It Fl 4
76Only listen to IPv4 requests.
77By default
78.Nm
79listens to both IPv6 and IPv4 and tries to register for both.
80.It Fl 6
81Only listen to IPv6 requests.
82.It Fl t
83Serve only
84.Tn TCP NFS
85clients.
86By default
87.Nm
88serves both
89.Tn TCP NFS
90and
91.Tn UDP NFS
92clients
93.It Fl u
94Serve only
95.Tn UDP NFS
96clients.
97.El
98.Pp
99.Nm
100listens for service requests at the port indicated in the
101.Tn NFS
102server specification; see
103.%T "Network File System Protocol Specification" ,
104RFC 1094 and
105.%T "NFS: Network File System Version 3 Protocol Specification" .
106.Sh EXIT STATUS
107.Ex -std nfsd
108.Sh EXAMPLES
109.Dq Li "nfsd -n 6"
110serves
111.Tn UDP
112and
113.Tn TCP
114transports using six threads.
115.Sh SEE ALSO
116.Xr nfsstat 1 ,
117.Xr nfssvc 2 ,
118.Xr mountd 8 ,
119.Xr rpcbind 8
120.Sh HISTORY
121The
122.Nm
123utility first appeared in
124.Bx 4.4 .
125