xref: /openbsd/sbin/nfsd/nfsd.8 (revision 17df1aa7)
1.\"   $OpenBSD: nfsd.8,v 1.16 2009/01/04 11:19:55 sobrado 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. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\"	@(#)nfsd.8	8.4 (Berkeley) 3/29/95
32.\"
33.Dd $Mdocdate: January 4 2009 $
34.Dt NFSD 8
35.Os
36.Sh NAME
37.Nm nfsd
38.Nd remote
39.Tn NFS
40server
41.Sh SYNOPSIS
42.Nm nfsd
43.Op Fl rtu
44.Op Fl n Ar num_servers
45.Sh DESCRIPTION
46.Nm
47runs on a server machine to service
48.Tn NFS
49requests from client machines.
50At least one
51.Nm
52must be running for a machine to operate as a server.
53.Pp
54Unless otherwise specified, four servers for
55.Tn UDP
56transport are started.
57.Pp
58The options are as follows:
59.Bl -tag -width Ds
60.It Fl n Ar num_servers
61Specifies how many servers to create (max 20).
62.It Fl r
63Register the
64.Tn NFS
65service with
66.Xr portmap 8
67without creating any servers.
68This option can be used along with the
69.Fl u
70or
71.Fl t
72options to re-register NFS if the portmap server is restarted.
73.It Fl t
74Serve
75.Tn TCP NFS
76clients.
77.It Fl u
78Serve
79.Tn UDP NFS
80clients.
81.El
82.Pp
83For example,
84.Dq Li "nfsd -u -t -n 6"
85serves
86.Tn UDP
87and
88.Tn TCP
89transports using six daemons.
90.Pp
91A server should run enough daemons to handle
92the maximum level of concurrency from its clients,
93typically four to six.
94.Pp
95.Nm
96listens for service requests at the port indicated in the
97.Tn NFS
98server specification; see
99.%T "Network File System Protocol Specification" ,
100RFC 1094 and
101.%T "NFS: Network File System Version 3 Protocol Specification" .
102.Pp
103.Ex -std nfsd
104.Sh SEE ALSO
105.Xr nfsstat 1 ,
106.Xr nfssvc 2 ,
107.Xr mountd 8 ,
108.Xr portmap 8
109.Sh HISTORY
110The
111.Nm
112utility first appeared in
113.Bx 4.4 .
114