statd: Replace note() with xlog() in rpc.statd

[nfs-utils.git] / utils / nfsd / nfsd.man

diff --git a/utils/nfsd/nfsd.man b/utils/nfsd/nfsd.man
index a890ea6df12c8f8d8e830dcdc73b2d7df64f6370..d8988d2878885d4a35f0b2f048391b5c965f02dd 100644 (file)
--- a/utils/nfsd/nfsd.man
+++ b/utils/nfsd/nfsd.man
@@ -2,19 +2,20 @@
 .\" nfsd(8)
 .\"
 .\" Copyright (C) 1999 Olaf Kirch <okir@monad.swb.de>
 .\" nfsd(8)
 .\"
 .\" Copyright (C) 1999 Olaf Kirch <okir@monad.swb.de>

-.TH rpc.nfsd 8 "31 May 1999"
+.TH rpc.nfsd 8 "7 Aug 2006"

 .SH NAME
 rpc.nfsd \- NFS server process
 .SH SYNOPSIS
 .SH NAME
 rpc.nfsd \- NFS server process
 .SH SYNOPSIS

-.BI "/usr/sbin/rpc.nfsd [-p " port "] " nproc
+.BI "/usr/sbin/rpc.nfsd [" options "]" " "nproc

 .SH DESCRIPTION
 The
 .B rpc.nfsd
 program implements the user level part of the NFS service. The
 main functionality is handled by the
 .SH DESCRIPTION
 The
 .B rpc.nfsd
 program implements the user level part of the NFS service. The
 main functionality is handled by the

-.B nfsd.o
-kernel module; the user space program merely starts the specified
-number of kernel threads.
+.B nfsd
+kernel module. The user space program merely specifies what sort of sockets
+the kernel service should listen on, what NFS versions it should support, and
+how many kernel threads it should use.

 .P
 The
 .B rpc.mountd
 .P
 The
 .B rpc.mountd


@@ -22,11 +23,50 @@ server provides an ancillary service needed to satisfy mount requests
 by NFS clients.
 .SH OPTIONS
 .TP
 by NFS clients.
 .SH OPTIONS
 .TP

-.BI \-p " port"
+.B \-d " or " \-\-debug
+enable logging of debugging messages
+.TP
+.B \-H " or " \-\-host  hostname
+specify a particular hostname (or address) that NFS requests will
+be accepted on. By default,
+.B rpc.nfsd
+will accept NFS requests on all known network addresses.
+Note that
+.B lockd
+(which performs file locking services for NFS) may still accept
+request on all known network addresses.  This may change in future
+releases of the Linux Kernel.
+.TP
+.B \-p " or " \-\-port  port

 specify a diferent port to listen on for NFS requests. By default,
 .B rpc.nfsd
 will listen on port 2049.
 .TP
 specify a diferent port to listen on for NFS requests. By default,
 .B rpc.nfsd
 will listen on port 2049.
 .TP

+.B \-N " or " \-\-no-nfs-version vers
+This option can be used to request that 
+.B rpc.nfsd
+does not offer certain versions of NFS. The current version of
+.B rpc.nfsd
+can support both NFS version 2,3 and the newer version 4.
+.TP
+.B \-s " or " \-\-syslog
+By default,
+.B rpc.nfsd
+logs error messages (and debug messages, if enabled) to stderr. This option makes 
+.B rpc.nfsd
+log these messages to syslog instead. Note that errors encountered during
+option processing will still be logged to stderr regardless of this option.
+.TP
+.B \-T " or " \-\-no-tcp
+Disable 
+.B rpc.nfsd 
+from accepting TCP connections from clients.
+.TP
+.B \-U " or " \-\-no-udp
+Disable
+.B rpc.nfsd
+from accepting UDP connections from clients.
+.TP

 .I nproc
 specify the number of NFS server threads. By default, just one
 thread is started. However, for optimum performance several threads
 .I nproc
 specify the number of NFS server threads. By default, just one
 thread is started. However, for optimum performance several threads


@@ -36,11 +76,30 @@ load created by the NFS clients, but a useful starting point is
 the
 .BR nfsstat (8)
 program.
 the
 .BR nfsstat (8)
 program.

+.P
+Note that if the NFS server is already running, then the options for
+specifying host, port, and protocol will be ignored.  The number of
+processes given will be the only option considered, and the number of
+active
+.B nfsd
+processes will be increased or decreased to match this number.
+In particular
+.B rpc.nfsd 0
+will stop all threads and thus close any open connections.
+
+.SH NOTES
+If the program is built with TI-RPC support, it will enable any protocol and
+address family combinations that are marked visible in the
+.B netconfig
+database.
+

 .SH SEE ALSO
 .BR rpc.mountd (8),
 .SH SEE ALSO
 .BR rpc.mountd (8),

+.BR exports (5),

 .BR exportfs (8),
 .BR rpc.rquotad (8),
 .BR exportfs (8),
 .BR rpc.rquotad (8),

-.BR nfsstat (8).
+.BR nfsstat (8),
+.BR netconfig(5).

 .SH AUTHOR
 Olaf Kirch, Bill Hawes, H. J. Lu, G. Allan Morris III,
 and a host of others.
 .SH AUTHOR
 Olaf Kirch, Bill Hawes, H. J. Lu, G. Allan Morris III,
 and a host of others.