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