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

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

diff --git a/utils/mountd/mountd.man b/utils/mountd/mountd.man
index 9dff681cd6511cb0d9ee6ba5c34bd6b413ef7aa6..bfa06e08eec72d6e737d14bc0b10aad74290fd79 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


@@ -42,9 +43,8 @@ syntax.
 For every mount request received from an NFS client,
 .B rpc.mountd
 adds an entry to the
 For every mount request received from an NFS client,
 .B rpc.mountd
 adds an entry to the

-.B /var/state/nfs/rmtab
+.B /var/lib/nfs/rmtab

 file. When receiving an unmount request, that entry is removed.
 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


@@ -55,8 +55,8 @@ a stale entry will remain in
 .BR rmtab .
 .SH OPTIONS
 .TP
 .BR rmtab .
 .SH OPTIONS
 .TP

-.B \-d " or " \-\-debug
-Turn on debugging.
+.B \-d kind " or " \-\-debug 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)


@@ -72,6 +72,10 @@ By default, export information is read from
 .B \-h " or " \-\-help
 Display usage message.
 .TP
 .B \-h " or " \-\-help
 Display usage message.
 .TP

+.B \-o num " or " \-\-descriptors num
+Set the limit of the number of open file descriptors to num. The
+default is to leave the limit unchanged.
+.TP

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


@@ -83,15 +87,58 @@ NFS kernel module was compiled without support for NFSv3,
 must be invoked with the option
 .B "\-\-no-nfs-version 3" .
 .TP
 must be invoked with the option
 .B "\-\-no-nfs-version 3" .
 .TP

+.B \-n " or " \-\-no-tcp
+Don't advertise TCP for mount.
+.TP

 .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 "\-s," "" " \-\-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
+.BI "\-r," "" " \-\-reverse\-lookup"
+mountd tracks IP addresses in the rmtab, and when a DUMP request is made (by
+someone running showmount -a, for instance), it returns IP addresses instead
+of hostnames by default. This option causes mountd to do a reverse
+lookup on each IP address and return that hostname instead. Enabling this can
+have a substantial negative effect on performance in some situations.
+.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


@@ -103,6 +150,21 @@ can support both NFS version 2 and the newer version 3.
 Print the version of
 .B rpc.mountd
 and exit.
 Print the version of
 .B rpc.mountd
 and exit.

+.TP
+.B \-g " or " \-\-manage-gids
+Accept requests from the kernel to map user id numbers into  lists of
+group id numbers for use in access control.  An NFS request will
+normally (except when using Kerberos or other cryptographic
+authentication) contains a user-id and a list of group-ids.  Due to a
+limitation in the NFS protocol, at most 16 groups ids can be listed.
+If you use the
+.B \-g
+flag, then the list of group ids received from the client will be
+replaced by a list of group ids determined by an appropriate lookup on
+the server. Note that the 'primary' group id is not affected so a
+.I newgroup
+command on the client will still be effective.  This function requires
+a Linux Kernel with version at least 2.6.21.

 
 .SH TCP_WRAPPERS SUPPORT
 This
 
 .SH TCP_WRAPPERS SUPPORT
 This


@@ -118,17 +180,16 @@ 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).
+.B Note:
+hostnames used in either access file will be ignored when
+they can not be resolved into IP addresses.

 
 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.

-

 .SH SEE ALSO
 .BR rpc.nfsd (8),
 .BR exportfs (8),
 .SH SEE ALSO
 .BR rpc.nfsd (8),
 .BR exportfs (8),


@@ -136,6 +197,6 @@ manual pages.
 .BR rpc.rquotad (8).
 .SH FILES
 .BR /etc/exports ,
 .BR rpc.rquotad (8).
 .SH FILES
 .BR /etc/exports ,

-.BR /var/state/nfs/xtab .
+.BR /var/lib/nfs/xtab .

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