xref: /openbsd-src/sbin/nfsd/nfsd.8 (revision 6db3e3d75c144c229ff6f1bc9aade65a2297b7f7)
1*6db3e3d7Sjsg.\"   $OpenBSD: nfsd.8,v 1.20 2022/07/30 07:19:30 jsg Exp $
2be0fe854Sniklas.\"   $NetBSD: nfsd.8,v 1.7 1996/02/18 11:58:24 fvdl Exp $
3df930be7Sderaadt.\"
4df930be7Sderaadt.\" Copyright (c) 1989, 1991, 1993
5df930be7Sderaadt.\"	The Regents of the University of California.  All rights reserved.
6df930be7Sderaadt.\"
7df930be7Sderaadt.\" Redistribution and use in source and binary forms, with or without
8df930be7Sderaadt.\" modification, are permitted provided that the following conditions
9df930be7Sderaadt.\" are met:
10df930be7Sderaadt.\" 1. Redistributions of source code must retain the above copyright
11df930be7Sderaadt.\"    notice, this list of conditions and the following disclaimer.
12df930be7Sderaadt.\" 2. Redistributions in binary form must reproduce the above copyright
13df930be7Sderaadt.\"    notice, this list of conditions and the following disclaimer in the
14df930be7Sderaadt.\"    documentation and/or other materials provided with the distribution.
151ef0d710Smillert.\" 3. Neither the name of the University nor the names of its contributors
16df930be7Sderaadt.\"    may be used to endorse or promote products derived from this software
17df930be7Sderaadt.\"    without specific prior written permission.
18df930be7Sderaadt.\"
19df930be7Sderaadt.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20df930be7Sderaadt.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21df930be7Sderaadt.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22df930be7Sderaadt.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23df930be7Sderaadt.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24df930be7Sderaadt.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25df930be7Sderaadt.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26df930be7Sderaadt.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27df930be7Sderaadt.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28df930be7Sderaadt.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29df930be7Sderaadt.\" SUCH DAMAGE.
30df930be7Sderaadt.\"
31be0fe854Sniklas.\"	@(#)nfsd.8	8.4 (Berkeley) 3/29/95
32df930be7Sderaadt.\"
33*6db3e3d7Sjsg.Dd $Mdocdate: July 30 2022 $
34df930be7Sderaadt.Dt NFSD 8
35df930be7Sderaadt.Os
36df930be7Sderaadt.Sh NAME
37df930be7Sderaadt.Nm nfsd
38e34c0550Sschwarze.Nd remote NFS server
39df930be7Sderaadt.Sh SYNOPSIS
407349792aSaaron.Nm nfsd
41c88d6c44Sjmc.Op Fl rtu
42df930be7Sderaadt.Op Fl n Ar num_servers
43df930be7Sderaadt.Sh DESCRIPTION
4458aefd4bSaaron.Nm
45e34c0550Sschwarzeruns on a server machine to service NFS
46df930be7Sderaadtrequests from client machines.
47df930be7SderaadtAt least one
4858aefd4bSaaron.Nm
49df930be7Sderaadtmust be running for a machine to operate as a server.
50df930be7Sderaadt.Pp
51e34c0550SschwarzeUnless otherwise specified, four servers for UDP
52df930be7Sderaadttransport are started.
53df930be7Sderaadt.Pp
548cf461a5SaaronThe options are as follows:
55df930be7Sderaadt.Bl -tag -width Ds
56c88d6c44Sjmc.It Fl n Ar num_servers
57c88d6c44SjmcSpecifies how many servers to create (max 20).
58df930be7Sderaadt.It Fl r
59e34c0550SschwarzeRegister the NFS service with
60df930be7Sderaadt.Xr portmap 8
61df930be7Sderaadtwithout creating any servers.
62df930be7SderaadtThis option can be used along with the
63df930be7Sderaadt.Fl u
64df930be7Sderaadtor
65df930be7Sderaadt.Fl t
66df930be7Sderaadtoptions to re-register NFS if the portmap server is restarted.
67df930be7Sderaadt.It Fl t
68e34c0550SschwarzeServe TCP NFS clients.
69df930be7Sderaadt.It Fl u
70e34c0550SschwarzeServe UDP NFS clients.
71df930be7Sderaadt.El
72df930be7Sderaadt.Pp
73df930be7SderaadtFor example,
741076c640Smickey.Dq Li "nfsd -u -t -n 6"
75e34c0550Sschwarzeserves UDP and TCP transports using six daemons.
76df930be7Sderaadt.Pp
77df930be7SderaadtA server should run enough daemons to handle
78df930be7Sderaadtthe maximum level of concurrency from its clients,
79df930be7Sderaadttypically four to six.
80df930be7Sderaadt.Pp
8158aefd4bSaaron.Nm
82e34c0550Sschwarzelistens for service requests at the port indicated in the NFS
838492d891Sjmcserver specification; see RFCs 1094 and 1813.
8477a299baSjmc.Sh EXIT STATUS
8549378797Ssobrado.Ex -std nfsd
86df930be7Sderaadt.Sh SEE ALSO
87df930be7Sderaadt.Xr nfsstat 1 ,
88df930be7Sderaadt.Xr nfssvc 2 ,
89df930be7Sderaadt.Xr mountd 8 ,
90df930be7Sderaadt.Xr portmap 8
91df930be7Sderaadt.Sh HISTORY
92df930be7SderaadtThe
9358aefd4bSaaron.Nm
94a873166dSmickeyutility first appeared in
95*6db3e3d7Sjsg.Bx 4.3 Reno .
96