BSD 4_3_Net_2 release

[unix-history] / usr / src / sbin / nfsd / nfsd.8

diff --git a/usr/src/sbin/nfsd/nfsd.8 b/usr/src/sbin/nfsd/nfsd.8
index 5174487..3502150 100644 (file)
--- a/usr/src/sbin/nfsd/nfsd.8
+++ b/usr/src/sbin/nfsd/nfsd.8
@@ -1,151 +1,233 @@
-.\" Copyright (c) 1989 The Regents of the University of California.
+.\" Copyright (c) 1989, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" 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 ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. 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.

 .\"
 .\"

-.\"    @(#)nfsd.8      5.6 (Berkeley) 6/24/90
+.\" 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.

 .\"
 .\"

-.TH NFSD 8 "June 24, 1990"
-.UC 7
-.SH NAME
-nfsd \- remote NFS server
-.SH SYNOPSIS
-.B nfsd
-[
-.B \-u
-.I msk,mtch,numprocs
-]
-[
-.B \-t
-.I msk,mtch,hostadr1,hostadr2,...
-]
-[
-.I numprocs
-]
-.SH DESCRIPTION
-.I Nfsd
+.\"    @(#)nfsd.8      5.9 (Berkeley) 8/5/91
+.\"
+.Dd August 5, 1991
+.Dt NFSD 8
+.Os
+.Sh NAME
+.Nm nfsd
+.Nd remote
+.Tn NFS
+server
+.Sh SYNOPSIS
+.Nm nfsd
+.Op Fl r
+.Bk -words
+.Op Fl t Ar msk,mtch,hostadr1,hostadr2,...
+.Ek
+.Bk -words
+.Op Fl u Ar msk,mtch,numprocs
+.Ek
+.Op Ar numprocs
+.Sh DESCRIPTION
+.Nm Nfsd

 runs on a server machine to service
 runs on a server machine to service

-.SM NFS
+.Tn NFS

 requests from client machines.
 At least one
 requests from client machines.
 At least one

-.I nfsd
+.Nm nfsd

 must be running for a machine to operate as a server.
 The options
 must be running for a machine to operate as a server.
 The options

-.B \-u
+.Fl u

 and
 and

-.B \-t
+.Fl t

 are used to indicate which transport protocols are to be served.
 are used to indicate which transport protocols are to be served.

-.TP
-.B \-u
-Serve UDP NFS clients.
-.TP
-.B \-t
-Serve TCP NFS clients.
-.TP
-.I "msk, mtch"
-These arguments permit restriction of NFS services
+.Pp
+Options available to
+.Nm nfsd :
+.Bl -tag -width Ds
+.It Fl r
+Register the
+.Tn NFS
+service with
+.Xr portmap 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 t
+Serve
+.Tn TCP NFS
+clients.
+.It Fl u
+Serve
+.Tn UDP NFS
+clients.
+.El
+.Pp
+The following arguments to the
+.Fl u
+or
+.Fl t
+options are used to specify parameters for service using the respective
+protocol:
+.Bl -tag -width Ds
+.It Ar msk , mtch
+These arguments permit restriction of
+.Tn NFS
+services

 to a subset of the host addresses. The
 to a subset of the host addresses. The

-.I msk
+.Ar msk

 and
 and

-.I mtch
+.Ar mtch

 are applied to the client host address as follows:
 are applied to the client host address as follows:

-.sp
+.Pp
+.Bd -filled -offset indent -compact

 if ((
 if ((

-.I host_address
-&
-.I msk
+.Ar host_address No \&& Em msk

 ) ==
 ) ==

-.I mtch
+.Ar mtch

 )
 .br
 )
 .br

-   - service the client request
+       \- service the client request

 .br
 else
 .br
 .br
 else
 .br

-   - drop the request
-.TP
-.I hostadr1,...
+       \- drop the request
+.Ed
+.It Ar hostadr1 , ...

 You may also specify zero or more specific host addresses to be accepted
 as well as ones that pass the
 You may also specify zero or more specific host addresses to be accepted
 as well as ones that pass the

-.I msk, mtch
+.Ar msk , mtch

 test above.
 This may only be done for transport protocols that are connection based, such
 test above.
 This may only be done for transport protocols that are connection based, such

-as TCP.
+as
+.Tn TCP .

 For the internet domain,
 For the internet domain,

-.I msk, mtch
+.Ar msk , mtch

 and
 and

-.I hostadrs'
+.Ar hostadrs

 are specified in internet
 are specified in internet

-.I dot
+.Em dot

 notation.
 notation.

-.TP
-.I numprocs
+.It Ar numprocs

 Specifies how many servers to fork off. This may only be specified for
 Specifies how many servers to fork off. This may only be specified for

-non-connection based protocols such as UDP.
-.LP
+non-connection based protocols such as
+.Tn UDP .
+.El
+.Pp

 If neither
 If neither

-.I \-u
+.Fl u

 or
 or

-.I \-t
+.Fl t

 are specified,
 are specified,

-.I numprocs
-servers for UDP accepting requests from all clients are started.
+.Ar numprocs
+servers for
+.Tn UDP
+accepting requests from all clients are started.

 If
 If

-.I numprocs
+.Ar numprocs

 is not specified, it defaults to 1.
 is not specified, it defaults to 1.

-.LP
+.Pp

 For example:
 For example:

-.sp
-nfsd \-u 255.255.255.0,131.104.48.0,4 \-t 255.255.0.0,131.104.0.0,131.102.31.2
-.IP "- "
-Serves UDP and TCP transports. For UDP,
+.Bd -literal
+nfsd \-u 255.255.255.0,131.104.48.0,4 \-t \e
+       255.255.0.0,131.104.0.0,131.102.31.2
+.Ed
+.Bl -item -offset indent
+.It
+Serves
+.Tn UDP
+and
+.Tn TCP
+transports. For
+.Tn UDP ,

 it runs 4 daemons that accept requests
 from any client on subnet 131.104.48.
 it runs 4 daemons that accept requests
 from any client on subnet 131.104.48.

-For TCP, it accepts connections from any client on network 131.104
+For
+.Tn TCP ,
+it accepts connections from any client on network 131.104

 plus the client with the address 131.102.31.2.
 plus the client with the address 131.102.31.2.

-.LP
+.El
+.Bd -literal

 nfsd \-u 255.255.240.0,131.104.0.0,6 \-t 0,0
 nfsd \-u 255.255.240.0,131.104.0.0,6 \-t 0,0

-.IP "- "
-Serves UDP and TCP transports.
-For UDP, it runs 6 daemons that accept requests from clients with
+.Ed
+.Bl -item -offset indent
+.It
+Serves
+.Tn UDP
+and
+.Tn TCP
+transports.
+For
+.Tn UDP ,
+it runs 6 daemons that accept requests from clients with

 addresses in the range 131.104.0.x - 131.104.15.x.
 addresses in the range 131.104.0.x - 131.104.15.x.

-For TCP, it accepts connections from any client.
-.LP
-nfsd \-u 0,0,4
-.IP "- "
-Serves any UDP client with 4 servers, only.
-.LP
-nfsd 4
-.IP "- "
-Serves any UDP client with 4 servers, only. (Compatibility)
-.LP
+For
+.Tn TCP ,
+it accepts connections from any client.
+.El
+.Pp
+.Li nfsd \-u 0,0,4
+.Bl -item -offset indent
+.It
+Serves any
+.Tn UDP
+client with 4 servers, only.
+.El
+.Pp
+.Li nfsd 4
+.Bl -item -offset indent
+.It
+Serves any
+.Tn UDP
+client with 4 servers, only. (Compatibility)
+.El
+.Pp

 A server should typically run enough daemons to handle
 the maximum level of concurrency from its clients,
 typically four to six.
 A server should typically run enough daemons to handle
 the maximum level of concurrency from its clients,
 typically four to six.

-.PP
-.I Nfsd
+.Pp
+.Nm Nfsd

 listens for service requests at the port indicated in the
 listens for service requests at the port indicated in the

-.SM NFS
+.Tn NFS

 server specification; see
 server specification; see

-``Network File System Protocol Specification, RFC1094''
-.SH SEE ALSO
-.IR nfsstat (1),
-.IR nfssvc (2),
-.IR mountd (8),
-.IR portmap (8)
-.SH BUGS
+.%T "Network File System Protocol Specification" ,
+RFC1094.
+.Sh SEE ALSO
+.Xr nfsstat 1 ,
+.Xr nfssvc 2 ,
+.Xr mountd 8 ,
+.Xr portmap 8
+.Sh BUGS

 The client host address restrictions specified here are unrelated to
 The client host address restrictions specified here are unrelated to

-the mount restrictions specified in /etc/exports for
-.IR mountd (8).
+the mount restrictions specified in
+.Pa /etc/exports
+for
+.Xr mountd 8 .
+.Sh HISTORY
+The
+.Nm
+command is
+.Ud .