X-Git-Url: https://git.decadent.org.uk/gitweb/?p=nfs-utils.git;a=blobdiff_plain;f=utils%2Fstatd%2Fstatd.man;h=0d40abbae6504f30d459b4096afeadda9d7f92fd;hp=8a7bd8cda301798a10929b64eb17306697c3dc9e;hb=2179c112b9a386ca3d51d0e19390ddfadd745030;hpb=c806d033d9350f743103535bd9d565b921db6dcb

diff --git a/utils/statd/statd.man b/utils/statd/statd.man
index 8a7bd8c..0d40abb 100644
--- a/utils/statd/statd.man
+++ b/utils/statd/statd.man
@@ -2,18 +2,19 @@
 .\" statd(8)
 .\"
 .\" Copyright (C) 1999 Olaf Kirch <okir@monad.swb.de>
-.\" Modified by Jeffrey A. Uphoff, 1999.
+.\" Modified by Jeffrey A. Uphoff, 1999, 2002, 2005.
 .\" Modified by Lon Hohberger, 2000.
-.TH rpc.statd 8 "05 Oct 2000"
+.\" Modified by Paul Clements, 2004.
+.TH rpc.statd 8 "31 Aug 2004"
 .SH NAME
 rpc.statd \- NSM status monitor
 .SH SYNOPSIS
-.B "/usr/sbin/rpc.statd [-F] [-d] [-?] [-V]
+.B "/sbin/rpc.statd [-F] [-d] [-?] [-n " name "] [-o " port "] [-p " port "] [-H " prog "] [-V]"
 .SH DESCRIPTION
 The
 .B rpc.statd
 server implements the NSM (Network Status Monitor) RPC protocol.
-This service is somewhat misnomed, since it doesn't actually provide
+This service is somewhat misnamed, since it doesn't actually provide
 active monitoring as one might suspect; instead, NSM implements a
 reboot notification service. It is used by the NFS file locking service,
 .BR rpc.lockd ,
@@ -52,6 +53,68 @@ 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
+.BI "\-H, " "" " \-\-ha-callout " prog
+Specify a high availability callout program, which will receive callouts
+for all client monitor and unmonitor requests. This allows
+.B rpc.statd
+to be used in a High Availability NFS (HA-NFS) environment. The
+program will be run with 3 arguments:  The first is either
+.B add-client
+or
+.B del-client
+depending on the reason for the callout.
+The second will be the name of the client.
+The third will be the name of the server as known to the client.
+.TP
 .B -?
 Causes
 .B rpc.statd
@@ -78,17 +141,23 @@ 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 SIGNALS
+.BR SIGUSR1
+causes
+.B rpc.statd
+to re-read the notify list from disk
+and send notifications to clients. This can be used in High Availability NFS
+(HA-NFS) environments to notify clients to reacquire file locks upon takeover
+of an NFS export from another server.
+
 .SH FILES
 .BR /var/lib/nfs/state
 .br
@@ -96,13 +165,16 @@ manual pages.
 .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@users.sourceforge.net>
 .br
 Olaf Kirch <okir@monad.swb.de>
 .br
 H.J. Lu <hjl@gnu.org>
 .br
 Lon Hohberger <hohberger@missioncriticallinux.com>
+.br
+Paul Clements <paul.clements@steeleye.com>