xref: /freebsd/usr.sbin/nfsd/nfsd.8 (revision a1a4f1a0d87b594d3f17a97dc0127eec1417e6f6)
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.4 (Berkeley) 3/29/95
33.\" $FreeBSD$
34.\"
35.Dd March 29, 1995
36.Dt NFSD 8
37.Os
38.Sh NAME
39.Nm nfsd
40.Nd remote
41.Tn NFS
42server
43.Sh SYNOPSIS
44.Nm nfsd
45.Op Fl rut
46.Op Fl n Ar num_servers
47.Sh DESCRIPTION
48.Nm Nfsd
49runs on a server machine to service
50.Tn NFS
51requests from client machines.
52At least one
53.Nm nfsd
54must be running for a machine to operate as a server.
55.Pp
56Unless otherwise specified, four servers for
57.Tn UDP
58transport are started.
59.Pp
60The following options are available:
61.Bl -tag -width Ds
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 n
74Specifies how many servers to create.
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 -u -t -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.
96.Pp
97.Nm Nfsd
98listens for service requests at the port indicated in the
99.Tn NFS
100server specification; see
101.%T "Network File System Protocol Specification" ,
102RFC1094 and
103.%T "NFS: Network File System Version 3 Protocol Specification" .
104.Pp
105If
106.Nm nfsd
107detects that
108.Tn NFS
109is not loaded in the running kernel, it will attempt
110to load a loadable kernel module containing
111.Tn NFS
112support using
113.Xr kldload 8
114by way of
115.Xr vfsload 3 .
116If this fails, or no
117.Tn NFS
118KLD is available,
119.Nm nfsd
120will exit with an error.
121.Pp
122The
123.Nm nfsd
124utility exits 0 on success, and >0 if an error occurs.
125.Sh SEE ALSO
126.Xr nfsstat 1 ,
127.Xr nfssvc 2 ,
128.Xr kldload 8 ,
129.Xr mountd 8 ,
130.Xr portmap 8
131.Sh HISTORY
132The
133.Nm nfsd
134utility first appeared in
135.Bx 4.4 .
136