Allow rpc.statd to *not* run sm-notify.

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

diff --git a/utils/statd/statd.man b/utils/statd/statd.man
index 0579273026c7fa368646f5ecac9237e263565f05..e8be9f3b4fb12d1035f3898050eb7710c321617b 100644 (file)
--- a/utils/statd/statd.man
+++ b/utils/statd/statd.man
@@ -9,12 +9,12 @@
 .SH NAME
 rpc.statd \- NSM status monitor
 .SH SYNOPSIS
-.B "/sbin/rpc.statd [-F] [-d] [-?] [-n " name "] [-o " port "] [-p " port "] [-H " prog "] [-V]"
+.B "rpc.statd [-FNL] [-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 ,
@@ -25,7 +25,9 @@ For each NFS client or server machine to be monitored,
 .B rpc.statd
 creates a file in
 .BR /var/lib/nfs/sm .
-When starting, it iterates through these files and notifies the
+When starting, it normally runs
+.B sm-notify
+to iterate through these files and notify the
 peer
 .B rpc.statd
 on those machines.
@@ -101,6 +103,21 @@ 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).
+This mode is deprecated \-
+.B sm-notify
+should be used directly instead.
+.TP
+.BR -L , " --no-notify
+Inhibits the running of
+.BR sm-notify .
+If
+.B sm-notify
+is run by some other script at boot time, there is no need for
+.B statd
+to start sm-notify itself.  This can be appropriate if starting of
+statd needs to be delayed until it is actually need.  In such cases
+.B sm-notify
+should still be run at boot time.
 .TP
 .BI "\-H, " "" " \-\-ha-callout " prog
 Specify a high availability callout program, which will receive callouts