xref: /netbsd-src/usr.sbin/nfsd/nfsd.8 (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1.\"   $NetBSD: nfsd.8,v 1.19 2003/09/07 16:22:26 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 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
42.Op Fl 6rut
43.Op Fl n Ar num_servers
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 servers to create.
72.It Fl 6
73Listen to IPv6 requests as well as IPv4 requests. If IPv6 support is not
74available, nfsd will silently continue and just use IPv4.
75.It Fl t
76Serve
77.Tn TCP NFS
78clients.
79.It Fl u
80Serve
81.Tn UDP NFS
82clients.
83.El
84.Pp
85For example,
86.Dq Li "nfsd -t -u -n 6"
87serves
88.Tn UDP
89and
90.Tn TCP
91transports using six daemons.
92.Pp
93A server should run enough daemons to handle
94the maximum level of concurrency from its clients,
95typically four to six. The maximum number of daemon is 20, the default is 4.
96If the number of servers on the command line exceeds 20, it is reset to
97the default.
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.Pp
107The
108.Nm
109utility exits 0 on success, and \*[Gt]0 if an error occurs.
110.Sh SEE ALSO
111.Xr nfsstat 1 ,
112.Xr nfssvc 2 ,
113.Xr mountd 8 ,
114.Xr rpcbind 8
115.Sh HISTORY
116The
117.Nm
118utility first appeared in
119.Bx 4.4 .
120