xref: /netbsd/usr.sbin/nfsd/nfsd.8 (revision bf9ec67e)
1.\"   $NetBSD: nfsd.8,v 1.16 2002/02/08 01:38:52 ross 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. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"	@(#)nfsd.8	8.4 (Berkeley) 3/29/95
35.\"
36.Dd March 29, 1995
37.Dt NFSD 8
38.Os
39.Sh NAME
40.Nm nfsd
41.Nd remote
42.Tn NFS
43server
44.Sh SYNOPSIS
45.Nm
46.Op Fl 6rut
47.Op Fl n Ar num_servers
48.Sh DESCRIPTION
49.Nm
50runs on a server machine to service
51.Tn NFS
52requests from client machines.
53At least one
54.Nm
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 rpcbind 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 6
77Listen to IPv6 requests as well as IPv4 requests. If IPv6 support is not
78available, nfsd will silently continue and just use IPv4.
79.It Fl t
80Serve
81.Tn TCP NFS
82clients.
83.It Fl u
84Serve
85.Tn UDP NFS
86clients.
87.El
88.Pp
89For example,
90.Dq Li "nfsd -t -u -n 6"
91serves
92.Tn UDP
93and
94.Tn TCP
95transports using six daemons.
96.Pp
97A server should run enough daemons to handle
98the maximum level of concurrency from its clients,
99typically four to six. The maximum number of daemon is 20, the default is 4.
100If the number of servers on the command line exeeds 20, it is reset to
101the default.
102.Pp
103.Nm
104listens for service requests at the port indicated in the
105.Tn NFS
106server specification; see
107.%T "Network File System Protocol Specification" ,
108RFC1094 and
109.%T "NFS: Network File System Version 3 Protocol Specification" .
110.Pp
111The
112.Nm
113utility exits 0 on success, and \*[Gt]0 if an error occurs.
114.Sh SEE ALSO
115.Xr nfsstat 1 ,
116.Xr nfssvc 2 ,
117.Xr mountd 8 ,
118.Xr rpcbind 8
119.Sh HISTORY
120The
121.Nm
122utility first appeared in
123.Bx 4.4 .
124