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 593037b40661311a3eb8c31e919d4149d48e07fd..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 "31 May 1999"
+.\" 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,44 +43,153 @@ 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

-.BR rpc.mountd 's
+.B rpc.mountd 's

 UMOUNT procedure. And two, if a client reboots without notifying
 UMOUNT procedure. And two, if a client reboots without notifying

-.BR rpc.mountd ,
+.B rpc.mountd ,

 a stale entry will remain in
 .BR rmtab .
 .SH OPTIONS
 .TP
 a stale entry will remain in
 .BR rmtab .
 .SH OPTIONS
 .TP

-.\" This file isn't touched by mountd at all--even though it
-.\" accepts the option.
-.\" .BR \-f " or " \-\-exports-file
-.\" This option specifies the exports file, listing the clients that this
-.\" server is prepared to serve and parameters to apply to each
-.\" such mount (see
-.\" .BR exports (5)).
-.\" By default, export information is read from
-.\" .IR /etc/exports .
-.TP
-.BR \-N " or " \-\-no-nfs-version
+.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 " \-\-exports-file
+This option specifies the exports file, listing the clients that this
+server is prepared to serve and parameters to apply to each
+such mount (see
+.BR exports (5)).
+By default, export information is read from
+.IR /etc/exports .
+.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
 This option can be used to request that
 .B rpc.mountd

-does not offer certain versions of NFS. The current version of
+do not offer certain versions of NFS. The current version of

 .B rpc.mountd
 can support both NFS version 2 and the newer version 3. If the
 NFS kernel module was compiled without support for NFSv3,
 .B rpc.mountd
 must be invoked with the option
 .B rpc.mountd
 can support both NFS version 2 and the newer version 3. If the
 NFS kernel module was compiled without support for NFSv3,
 .B rpc.mountd
 must be invoked with the option

-.BR "\-\-no-nfs-version 3" .
+.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 " or " \-\-port num
+Force
+.B rpc.mountd
+to bind to the specified port num, instead of using the random port
+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
 .TP

-.BR \-v " or " \-\-version
+.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
+offer certain versions of NFS. The current version of
+.B rpc.mountd
+can support both NFS version 2 and the newer version 3.
+.TP
+.B \-v " or " \-\-version

 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
+.B rpc.mountd
+version is protected by the
+.B tcp_wrapper
+library. You have to give the clients access to
+.B rpc.mountd
+if they should be allowed to use it. To allow connects from clients of
+the .bar.com domain you could use the following line in /etc/hosts.allow:
+
+mountd: .bar.com
+
+You have to use the daemon name 
+.B mountd
+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
+.BR tcpd (8)
+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),


@@ -87,6 +197,6 @@ and exit.
 .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.