multiple threads for mountd

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

diff --git a/utils/mountd/mountd.man b/utils/mountd/mountd.man
index 71560abc5535d014617a289d4d8a4556d625e4cc..70166c1283a2aa58dace9149c4562dae6f0029ed 100644 (file)
--- a/utils/mountd/mountd.man
+++ b/utils/mountd/mountd.man
@@ -2,7 +2,8 @@
 .\" mountd(8)
 .\"
 .\" Copyright (C) 1999 Olaf Kirch <okir@monad.swb.de>
 .\" mountd(8)
 .\"
 .\" Copyright (C) 1999 Olaf Kirch <okir@monad.swb.de>

-.TH rpc.mountd 8 "25 Aug 2000"
+.\" Modified by Paul Clements, 2004.
+.TH rpc.mountd 8 "31 Aug 2004"

 .SH NAME
 rpc.mountd \- NFS mount daemon
 .SH SYNOPSIS
 .SH NAME
 rpc.mountd \- NFS mount daemon
 .SH SYNOPSIS


@@ -44,7 +45,6 @@ For every mount request received from an NFS client,
 adds an entry to the
 .B /var/lib/nfs/rmtab
 file. When receiving an unmount request, that entry is removed.
 adds an entry to the
 .B /var/lib/nfs/rmtab
 file. When receiving an unmount request, that entry is removed.

-user level part of the NFS service.

 .P
 However, this file is mostly ornamental. One, the client can continue
 to use the file handle even after calling
 .P
 However, this file is mostly ornamental. One, the client can continue
 to use the file handle even after calling


@@ -56,7 +56,7 @@ a stale entry will remain in
 .SH OPTIONS
 .TP
 .B \-d kind " or " \-\-debug kind
 .SH OPTIONS
 .TP
 .B \-d kind " or " \-\-debug kind

-Turn on debugging for kind.
+Turn on debugging. Valid kinds are: all, auth, call, general and parse.

 .TP
 .B \-F " or " \-\-foreground
 Run in foreground (do not daemonize)
 .TP
 .B \-F " or " \-\-foreground
 Run in foreground (do not daemonize)


@@ -74,7 +74,7 @@ Display usage message.
 .TP
 .B \-o num " or " \-\-descriptors num
 Set the limit of the number of open file descriptors to num. The
 .TP
 .B \-o num " or " \-\-descriptors num
 Set the limit of the number of open file descriptors to num. The

-default is 256.
+default is to leave the limit unchanged.

 .TP
 .B \-N " or " \-\-no-nfs-version
 This option can be used to request that
 .TP
 .B \-N " or " \-\-no-nfs-version
 This option can be used to request that


@@ -93,12 +93,45 @@ Don't advertise TCP for mount.
 .B \-P
 Ignored (compatibility with unfsd??).
 .TP
 .B \-P
 Ignored (compatibility with unfsd??).
 .TP

-.B \-p " or " \-\-port
+.B \-p " or " \-\-port num

 Force
 .B rpc.mountd
 Force
 .B rpc.mountd

-to bind to the specified port, instead of using the random port
+to bind to the specified port num, instead of using the random port

 number assigned by the portmapper.
 .TP
 number assigned by the portmapper.
 .TP

+.B \-H " or " \-\-ha-callout prog
+Specify a high availability callout program, which will receive callouts
+for all client mount and unmount requests. This allows 
+.B rpc.mountd
+to be used in a High Availability NFS (HA-NFS) environment. This callout is not
+needed (and should not be used) with 2.6 and later kernels (instead,
+mount the nfsd filesystem on
+.B /proc/fs/nfsd
+).
+The program will be called with 4 arguments.
+The first will be
+.B mount
+or
+.B unmount
+depending on the reason for the callout.
+The second will be the name of the client performing the mount.
+The third will be the path that the client is mounting.
+The last is the number of concurrent mounts that we believe the client
+has of that path.
+.TP
+.BI "\-P," "" " \-\-state\-directory\-path "  directory
+specify a directory in which to place statd state information.
+If this option is not specified the default of
+.BR /var/lib/nfs
+is used.
+.TP
+.BR "\-t N" " or " "\-\-num\-threads=N"
+This option specifies the number of worker threads that rpc.mountd
+spawns.  The default is 1 thread, which is probably enough.  More
+threads are usually only needed for NFS servers which need to handle
+mount storms of hundreds of NFS mounts in a few seconds, or when
+your DNS server is slow or unreliable.
+.TP

 .B \-V " or " \-\-nfs-version
 This option can be used to request that
 .B rpc.mountd
 .B \-V " or " \-\-nfs-version
 This option can be used to request that
 .B rpc.mountd


@@ -125,13 +158,10 @@ mountd: .bar.com
 
 You have to use the daemon name 
 .B mountd
 
 You have to use the daemon name 
 .B mountd

-for the daemon name (even if the binary has a different name). For the
-client names you can only use the keyword ALL or IP addresses (NOT
-host or domain names).
+for the daemon name (even if the binary has a different name).

 
 For further information please have a look at the
 
 For further information please have a look at the

-.BR tcpd (8),
-.BR hosts_allow (5)
+.BR tcpd (8)

 and
 .BR hosts_access (5)
 manual pages.
 and
 .BR hosts_access (5)
 manual pages.