xref: /openbsd/sbin/nfsd/nfsd.8 (revision 133306f0)
1.\"   $OpenBSD: nfsd.8,v 1.11 2000/03/05 00:28:50 aaron Exp $
2.\"   $NetBSD: nfsd.8,v 1.7 1996/02/18 11:58:24 fvdl Exp $
3.\"
4.\" Copyright (c) 1989, 1991, 1993
5.\"	The Regents of the University of California.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"	@(#)nfsd.8	8.4 (Berkeley) 3/29/95
36.\"
37.Dd March 29, 1995
38.Dt NFSD 8
39.Os
40.Sh NAME
41.Nm nfsd
42.Nd remote
43.Tn NFS
44server
45.Sh SYNOPSIS
46.Nm nfsd
47.Op Fl rut
48.Op Fl n Ar num_servers
49.Sh DESCRIPTION
50.Nm
51runs on a server machine to service
52.Tn NFS
53requests from client machines.
54At least one
55.Nm
56must be running for a machine to operate as a server.
57.Pp
58Unless otherwise specified, four servers for
59.Tn UDP
60transport are started.
61.Pp
62The options are as follows:
63.Bl -tag -width Ds
64.It Fl r
65Register the
66.Tn NFS
67service with
68.Xr portmap 8
69without creating any servers.
70This option can be used along with the
71.Fl u
72or
73.Fl t
74options to re-register NFS if the portmap server is restarted.
75.It Fl n Ar num_servers
76Specifies how many servers to create (max 20).
77.It Fl t
78Serve
79.Tn TCP NFS
80clients.
81.It Fl u
82Serve
83.Tn UDP NFS
84clients.
85.El
86.Pp
87For example,
88.Dq Li "nfsd -u -t -n 6"
89serves
90.Tn UDP
91and
92.Tn TCP
93transports using six daemons.
94.Pp
95A server should run enough daemons to handle
96the maximum level of concurrency from its clients,
97typically four to six.
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" ,
104RFC1094 and
105.%T "NFS: Network File System Version 3 Protocol Specification" .
106.Pp
107The
108.Nm
109utility exits 0 on success or >0 if an error occurred.
110.Sh SEE ALSO
111.Xr nfsstat 1 ,
112.Xr nfssvc 2 ,
113.Xr mountd 8 ,
114.Xr portmap 8
115.Sh HISTORY
116The
117.Nm
118utility first appeared in
119.Bx 4.4 .
120