Haircut.

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

diff --git a/utils/statd/statd.man b/utils/statd/statd.man
index 38db9c5c041d830e1d52b58602f36ecd95cbed86..f35b6c9c015d8a99233e1144d9a2d80b21372970 100644 (file)
--- a/utils/statd/statd.man
+++ b/utils/statd/statd.man
@@ -2,12 +2,13 @@
 .\" statd(8)
 .\"
 .\" Copyright (C) 1999 Olaf Kirch <okir@monad.swb.de>
-.\" Modified by Jeffrey A. Uphoff, 1999.
-.TH rpc.statd 8 "20 Aug 2000"
+.\" Modified by Jeffrey A. Uphoff, 1999, 2002.
+.\" Modified by Lon Hohberger, 2000.
+.TH rpc.statd 8 "16 Sep 2002"
 .SH NAME
 rpc.statd \- NSM status monitor
 .SH SYNOPSIS
-.B "/usr/sbin/rpc.statd [-F]
+.B "/sbin/rpc.statd [-F] [-d] [-?] [-n " name "] [-o " port "] [-p " port "] [-V]"
 .SH DESCRIPTION
 The
 .B rpc.statd
@@ -36,6 +37,81 @@ forks and puts itself in the background when started. The
 .B -F
 argument tells it to remain in the foreground. This option is
 mainly for debugging purposes.
+.TP
+.B -d
+By default,
+.B rpc.statd
+sends logging messages via
+.BR syslog (3)
+to system log.  The
+.B -d
+argument forces it to log verbose output to
+.B stderr
+instead. This option is mainly for debugging purposes, and may only
+be used in conjunction with the
+.B -F
+parameter.
+.TP
+.BI "\-n," "" " \-\-name " name 
+specify a name for
+.B rpc.statd
+to use as the local hostname. By default,
+.BR rpc.statd
+will call
+.BR gethostname (2)
+to get the local hostname. Specifying
+a local hostname may be useful for machines with more than one
+interfaces.
+.TP
+.BI "\-o," "" " \-\-outgoing\-port "  port
+specify a port for
+.B rpc.statd
+to send outgoing status requests from.  By default,
+.BR rpc.statd
+will ask
+.BR portmap (8)
+to assign it a port number.  As of this writing, there is not
+a standard port number that
+.BR portmap
+always or usually assigns.  Specifying
+a port may be useful when implementing a firewall.
+.TP
+.BI "\-p," "" " \-\-port " port
+specify a port for
+.B rpc.statd
+to listen on.  By default,
+.BR rpc.statd
+will ask
+.BR portmap (8)
+to assign it a port number.  As of this writing, there is not
+a standard port number that
+.BR portmap
+always or usually assigns.  Specifying
+a port may be useful when implementing a firewall.
+.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
+.B -N
+Causes statd to run in the notify-only mode. When started in this mode, the
+statd program will check its state directory, send notifications to any
+monitored nodes, and exit once the notifications have been sent. This mode is
+used to enable Highly Available NFS implementations (i.e. HA-NFS).
+.TP
+.B -?
+Causes
+.B rpc.statd
+to print out command-line help and exit.
+.TP
+.B -V
+Causes
+.B rpc.statd
+to print out version information and exit.
+
+
 
 .SH TCP_WRAPPERS SUPPORT
 This
@@ -51,29 +127,29 @@ statd: .bar.com
 
 You have to use the daemon name 
 .B statd
-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
-.BR tcpd (8),
-.BR hosts_allow (5)
+.BR tcpd (8)
 and
 .BR hosts_access (5)
 manual pages.
 
 .SH FILES
-.BR /var/lib/nfs/sm/state
+.BR /var/lib/nfs/state
 .br
 .BR /var/lib/nfs/sm/*
 .br
 .BR /var/lib/nfs/sm.bak/*
 .SH SEE ALSO
-.BR rpc.nfsd(8)
+.BR rpc.nfsd(8),
+.BR portmap(8)
 .SH AUTHORS
 .br
-Jeff Uphoff <juphoff@transmeta.com>
+Jeff Uphoff <juphoff@nrao.edu>
 .br
 Olaf Kirch <okir@monad.swb.de>
 .br
 H.J. Lu <hjl@gnu.org>
+.br
+Lon Hohberger <hohberger@missioncriticallinux.com>