sm-notify - make the manpage a little more up-to-date

diff --git a/utils/statd/sm-notify.8 b/utils/statd/sm-notify.8
index 29726d62929727f77898837b5de1f3239d00ba93..314e2c454ceff9623e0838173c723fd99d705bf2 100644 (file)
--- a/utils/statd/sm-notify.8
+++ b/utils/statd/sm-notify.8
@@ -2,13 +2,13 @@
 .\" sm-notify(8)
 .\"
 .\" Copyright (C) 2004 Olaf Kirch <okir@suse.de>
 .\" sm-notify(8)
 .\"
 .\" Copyright (C) 2004 Olaf Kirch <okir@suse.de>

-.TH sm-notify 8 "8 Mar 2004
+.TH sm-notify 8 "19 Mar 2007

 .SH NAME
 sm-notify \- Send out NSM reboot notifications
 .SH SYNOPSIS
 .SH NAME
 sm-notify \- Send out NSM reboot notifications
 .SH SYNOPSIS

-.BI "/sbin/sm-notify [-d] [-q] [-m " time "]
+.BI "/sbin/sm-notify [-d] [-q] [-m " time "] [-p " port "] [-P " path "] [-v " my_name " ]

 .SH DESCRIPTION
 .SH DESCRIPTION

-File locking over NFS requires a facility to notify peers in
+File locking over NFS (v2 and v3) requires a facility to notify peers in

 case of a reboot, so that clients can reclaim locks after
 a server crash, and/or
 servers can release locks held by the rebooted client.
 case of a reboot, so that clients can reclaim locks after
 a server crash, and/or
 servers can release locks held by the rebooted client.


@@ -20,23 +20,18 @@ notifications need to be sent out during reboot.
 The protocol used for this is called NSM, for
 .IR "Network Status Monitor" .
 .PP
 The protocol used for this is called NSM, for
 .IR "Network Status Monitor" .
 .PP

-Commonly, these two features are provided by the
+This implementation separates these into separate program.

 .B rpc.statd
 .B rpc.statd

-daemon.
-The SuSE Linux Kernel includes a kernel level implementation
-of
-.BR statd ", "
-which keeps track of the hosts that need notifications, and
-accepts reboot notifications.
-.PP
-This is complemented by the
+tracks hosts which need to be notified and this
+.B sm-notify
+performs the notification.  When
+.B rpc.statd
+is started it will typically started

 .B sm-notify
 .B sm-notify

-application, which is responsible for sending out the reboot
-notifications.
+but this is configurable.

 .SS Operation
 For each NFS client or server machine to be monitored,
 .SS Operation
 For each NFS client or server machine to be monitored,

-the kernel level
-.B statd
+.B rpc.statd

 creates a file in
 .BR /var/lib/nfs/sm ", "
 and removes the file if monitoring is no longer required.
 creates a file in
 .BR /var/lib/nfs/sm ", "
 and removes the file if monitoring is no longer required.


@@ -70,13 +65,17 @@ option, you can override this. A value of 0 tells
 sm-notify to retry indefinitely; any other value is
 interpreted as the maximum retry time in minutes.
 .TP
 sm-notify to retry indefinitely; any other value is
 interpreted as the maximum retry time in minutes.
 .TP

-.BI -v " ipaddr
+.BI -v " ipaddr-or-hostname

 This option tells
 .B sm-notify
 to bind to the specified
 .IR ipaddr ,
 This option tells
 .B sm-notify
 to bind to the specified
 .IR ipaddr ,

+(or the ipaddr of the given
+.IR hostname )

 so that all notification packets originate from this address.
 so that all notification packets originate from this address.

-This is useful for NFS failover.
+This is useful for NFS failover.  The given name is also used as the
+.I name
+of this host in the NSM request.

 .TP
 .BI -p " port
 instructs
 .TP
 .BI -p " port
 instructs


@@ -90,6 +89,18 @@ a randomly chosen privileged port below 1024.
 Be quiet. This suppresses all messages except error
 messages while collecting the list of hosts.
 .TP
 Be quiet. This suppresses all messages except error
 messages while collecting the list of hosts.
 .TP

+.BI -P " /path/to/state/directory
+If
+.B sm-notify
+should look in a no-standard place of state file, the path can be
+given here.  The directories
+.B sm
+and
+.B sm.bak
+and the file
+.B state
+must exist in that directory with the standard names.
+.TP

 .B -n
 Do not update the NSM state. This is for testing only.
 .TP
 .B -n
 Do not update the NSM state. This is for testing only.
 .TP