NetBSD/usr.sbin/nfsd/nfsd.8

.\"   $NetBSD: nfsd.8,v 1.24 2016/03/17 15:25:46 christos Exp $
.\"
.\" Copyright (c) 1989, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)nfsd.8	8.4 (Berkeley) 3/29/95
.\"
.Dd March 17, 2016
.Dt NFSD 8
.Os
.Sh NAME
.Nm nfsd
.Nd remote
.Tn NFS
server
.Sh SYNOPSIS
.Nm
.Op Fl 46drut
.Op Fl n Ar num_threads
.Sh DESCRIPTION
.Nm
runs on a server machine to service
.Tn NFS
requests from client machines.
At least one
.Nm
must be running for a machine to operate as a server.
.Pp
Unless otherwise specified, four servers for
.Tn UDP
transport are started.
.Pp
The following options are available:
.Bl -tag -width Ds
.It Fl d
Turn on debugging, don't fork and log to stderr.
.It Fl r
Register the
.Tn NFS
service with
.Xr rpcbind 8
without creating any servers.
This option can be used along with the
.Fl u
or
.Fl t
options to re-register NFS if the portmap server is restarted.
.It Fl n
Specifies how many server threads to create.
The default is 4.
A server should run enough threads to handle
the maximum level of concurrency from its clients.
.It Fl 4
Only listen to IPv4 requests.
By default
.Nm
listens to both IPv6 and IPv4 and tries to register for both.
.It Fl 6
Only listen to IPv6 requests.
.It Fl t
Serve only
.Tn TCP NFS
clients.
By default
.Nm
serves both
.Tn TCP NFS
and
.Tn UDP NFS
clients
.It Fl u
Serve only
.Tn UDP NFS
clients.
.El
.Pp
.Nm
listens for service requests at the port indicated in the
.Tn NFS
server specification; see
.%T "Network File System Protocol Specification" ,
RFC 1094 and
.%T "NFS: Network File System Version 3 Protocol Specification" .
.Sh EXIT STATUS
.Ex -std nfsd
.Sh EXAMPLES
.Dq Li "nfsd -n 6"
serves
.Tn UDP
and
.Tn TCP
transports using six threads.
.Sh SEE ALSO
.Xr nfsstat 1 ,
.Xr nfssvc 2 ,
.Xr mountd 8 ,
.Xr rpcbind 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Bx 4.4 .
Expose debugging 2016-03-17 18:25:46 +03:00			`.\" $NetBSD: nfsd.8,v 1.24 2016/03/17 15:25:46 christos Exp $`
convert to new RCS Id conventions; reduce my headache 1995-03-18 17:54:19 +03:00			`.\"`
Update from 4.4-Lite, with local changes. 1994-06-08 23:27:32 +04:00			`.\" Copyright (c) 1989, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22366, verified by myself. 2003-08-07 15:25:11 +04:00			`.\" 3. Neither the name of the University nor the names of its contributors`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
Bring in NFSv3 code by Rick Macklem (from Lite2). 1996-02-18 14:58:24 +03:00			`.\" @(#)nfsd.8 8.4 (Berkeley) 3/29/95`
added rcs ids to all files 1993-03-22 11:04:00 +03:00			`.\"`
Expose debugging 2016-03-17 18:25:46 +03:00			`.Dd March 17, 2016`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dt NFSD 8`
			`.Os`
			`.Sh NAME`
			`.Nm nfsd`
			`.Nd remote`
			`.Tn NFS`
			`server`
			`.Sh SYNOPSIS`
WARNSify 1997-10-17 15:53:25 +04:00			`.Nm`
Expose debugging 2016-03-17 18:25:46 +03:00			`.Op Fl 46drut`
update. 2008-03-17 12:57:11 +03:00			`.Op Fl n Ar num_threads`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh DESCRIPTION`
WARNSify 1997-10-17 15:53:25 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`runs on a server machine to service`
			`.Tn NFS`
			`requests from client machines.`
			`At least one`
WARNSify 1997-10-17 15:53:25 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`must be running for a machine to operate as a server.`
			`.Pp`
Update from 4.4-Lite, with local changes. 1994-06-08 23:27:32 +04:00			`Unless otherwise specified, four servers for`
			`.Tn UDP`
			`transport are started.`
			`.Pp`
			`The following options are available:`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Bl -tag -width Ds`
Expose debugging 2016-03-17 18:25:46 +03:00			`.It Fl d`
			`Turn on debugging, don't fork and log to stderr.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.It Fl r`
			`Register the`
			`.Tn NFS`
			`service with`
Substitute the cross reference to portmap(8) with rpcbind(8). 2000-07-03 14:06:24 +04:00			`.Xr rpcbind 8`
Update from 4.4-Lite, with local changes. 1994-06-08 23:27:32 +04:00			`without creating any servers.`
			`This option can be used along with the`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Fl u`
			`or`
			`.Fl t`
			`options to re-register NFS if the portmap server is restarted.`
Update from 4.4-Lite, with local changes. 1994-06-08 23:27:32 +04:00			`.It Fl n`
update. 2008-03-17 12:57:11 +03:00			`Specifies how many server threads to create.`
			`The default is 4.`
			`A server should run enough threads to handle`
			`the maximum level of concurrency from its clients.`
Sort descriptions. Fix macro. Move example to new EXAMPLES section. Add EXIT STATUS section 2012-08-13 12:39:28 +04:00			`.It Fl 4`
			`Only listen to IPv4 requests.`
Let nfsd behave like all other programs: tries to use both inet4 and inet6 by default and both udp and tcp: -4 uses only inet4, -6 uses only inet6, -t uses only tcp, -u uses only udp. For compatibility, we detect old option usage, we warn, and DTRT. 2012-08-13 12:19:11 +04:00			`By default`
			`.Nm`
			`listens to both IPv6 and IPv4 and tries to register for both.`
Sort descriptions. Fix macro. Move example to new EXAMPLES section. Add EXIT STATUS section 2012-08-13 12:39:28 +04:00			`.It Fl 6`
			`Only listen to IPv6 requests.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.It Fl t`
Let nfsd behave like all other programs: tries to use both inet4 and inet6 by default and both udp and tcp: -4 uses only inet4, -6 uses only inet6, -t uses only tcp, -u uses only udp. For compatibility, we detect old option usage, we warn, and DTRT. 2012-08-13 12:19:11 +04:00			`Serve only`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Tn TCP NFS`
			`clients.`
Let nfsd behave like all other programs: tries to use both inet4 and inet6 by default and both udp and tcp: -4 uses only inet4, -6 uses only inet6, -t uses only tcp, -u uses only udp. For compatibility, we detect old option usage, we warn, and DTRT. 2012-08-13 12:19:11 +04:00			`By default`
			`.Nm`
Sort descriptions. Fix macro. Move example to new EXAMPLES section. Add EXIT STATUS section 2012-08-13 12:39:28 +04:00			`serves both`
Let nfsd behave like all other programs: tries to use both inet4 and inet6 by default and both udp and tcp: -4 uses only inet4, -6 uses only inet6, -t uses only tcp, -u uses only udp. For compatibility, we detect old option usage, we warn, and DTRT. 2012-08-13 12:19:11 +04:00			`.Tn TCP NFS`
			`and`
Sort descriptions. Fix macro. Move example to new EXAMPLES section. Add EXIT STATUS section 2012-08-13 12:39:28 +04:00			`.Tn UDP NFS`
Let nfsd behave like all other programs: tries to use both inet4 and inet6 by default and both udp and tcp: -4 uses only inet4, -6 uses only inet6, -t uses only tcp, -u uses only udp. For compatibility, we detect old option usage, we warn, and DTRT. 2012-08-13 12:19:11 +04:00			`clients`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.It Fl u`
Let nfsd behave like all other programs: tries to use both inet4 and inet6 by default and both udp and tcp: -4 uses only inet4, -6 uses only inet6, -t uses only tcp, -u uses only udp. For compatibility, we detect old option usage, we warn, and DTRT. 2012-08-13 12:19:11 +04:00			`Serve only`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Tn UDP NFS`
			`clients.`
			`.El`
			`.Pp`
WARNSify 1997-10-17 15:53:25 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`listens for service requests at the port indicated in the`
			`.Tn NFS`
			`server specification; see`
			`.%T "Network File System Protocol Specification" ,`
Consistently use 'RFC 1234' instead of 'RFC1234' or 'RFC-1234'. From jmc@openbsd. 2003-09-07 20:22:20 +04:00			`RFC 1094 and`
Bring in NFSv3 code by Rick Macklem (from Lite2). 1996-02-18 14:58:24 +03:00			`.%T "NFS: Network File System Version 3 Protocol Specification" .`
Sort descriptions. Fix macro. Move example to new EXAMPLES section. Add EXIT STATUS section 2012-08-13 12:39:28 +04:00			`.Sh EXIT STATUS`
			`.Ex -std nfsd`
			`.Sh EXAMPLES`
			`.Dq Li "nfsd -n 6"`
			`serves`
			`.Tn UDP`
			`and`
			`.Tn TCP`
			`transports using six threads.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh SEE ALSO`
			`.Xr nfsstat 1 ,`
			`.Xr nfssvc 2 ,`
			`.Xr mountd 8 ,`
Substitute the cross reference to portmap(8) with rpcbind(8). 2000-07-03 14:06:24 +04:00			`.Xr rpcbind 8`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh HISTORY`
			`The`
WARNSify 1997-10-17 15:53:25 +04:00			`.Nm`
macroize BSD, NetBSD, FreeBSD and misc cleanup 1998-02-06 08:54:12 +03:00			`utility first appeared in`
			`.Bx 4.4 .`