From: Andrew Deason <adeason@sinenomine.net>
Date: Thu, 31 Oct 2013 04:27:19 +0000 (-0500)
Subject: doc: volserver manpage fixes
X-Git-Tag: openafs-stable-1_8_0pre1~937
X-Git-Url: https://git.openafs.org/?p=openafs.git;a=commitdiff_plain;h=1aaeafb45f9746e98f61a93d14b94f42e2ed223a

doc: volserver manpage fixes

 - Fix synopsis formatting, so option arguments are on the same line
   as the option name

 - Add missing options -rxmaxmtu, -rxbind, -syslog, and -sleep

Change-Id: I6e6f06d716e7f78be288bfebde97a3701f086924
Reviewed-on: http://gerrit.openafs.org/10394
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Derrick Brashear <shadow@your-file-system.com>
---

diff --git a/doc/man-pages/pod8/fragments/volserver-options.pod b/doc/man-pages/pod8/fragments/volserver-options.pod
index 4bc80e9..acdfc89 100644
--- a/doc/man-pages/pod8/fragments/volserver-options.pod
+++ b/doc/man-pages/pod8/fragments/volserver-options.pod
@@ -100,6 +100,36 @@ service.  In a typical configuration this will be F</usr/afs/etc> - this
 option allows the use of alternative configuration locations for testing
 purposes.
 
+=item B<-rxmaxmtu> <I<bytes>>
+
+Defines the maximum size of an MTU.  The value must be between the
+minimum and maximum packet data sizes for Rx.
+
+=item B<-rxbind>
+
+Bind the Rx socket to the primary interface only. (If not specified, the Rx
+socket will listen on all interfaces.)
+
+=item B<-syslog>[=<I<syslog facility>>]
+
+Specifies that logging output should go to syslog instead of the normal
+log file. B<-syslog>=I<FACILITY> can be used to specify to which facility
+the log message should be sent.
+
+=item B<-sleep> <I<sleep_time>/I<run_time>>
+
+This option only applies to the LWP version of the volserver, and has no effect
+on the pthreaded version of the volserver. Note that OpenAFS no longer ships an
+LWP version of the volserver; the last version series where the LWP volserver
+was even built was the 1.6.x series of OpenAFS.
+
+For the LWP version of the volserver, specifying this option forces the
+volserver to sleep during certain volume operations, so the volserver does not
+become I/O bound. Approximately every I<run_time> seconds, the volserver is
+forced to sleep for I<sleep_time> seconds if any volume transactions are active
+that are performing certain operations. This includes operations involving
+deleting, cloning, moving, releasing, copying, or restoring a volume.
+
 =item B<-help>
 
 Prints the online help for this command. All other valid options are
diff --git a/doc/man-pages/pod8/fragments/volserver-synopsis.pod b/doc/man-pages/pod8/fragments/volserver-synopsis.pod
index 1c10106..ebcee46 100644
--- a/doc/man-pages/pod8/fragments/volserver-synopsis.pod
+++ b/doc/man-pages/pod8/fragments/volserver-synopsis.pod
@@ -1,10 +1,16 @@
 B<volserver>
     [B<-log>] S<<< [B<-p> <I<number of processes>>] >>>
-    S<<< [B<-auditlog> <I<log path>>] >>> [B<-audit-interface> (file | sysvmq)]
-    S<<< [B<-logfile <I<log file>>] >>> S<<< [B<-config <I<configuration path>>] >>>
+    S<<< [B<-auditlog> <I<log path>>] >>>
+    S<<< [B<-audit-interface> (file | sysvmq)] >>>
+    S<<< [B<-logfile <I<log file>>] >>> S<<< [B<-config> <I<configuration path>>] >>>
     S<<< [B<-udpsize> <I<size of socket buffer in bytes>>] >>>
     S<<< [B<-d> <I<debug level>>] >>>
     [B<-nojumbo>] [B<-jumbo>] 
     [B<-enable_peer_stats>] [B<-enable_process_stats>] 
-    [B<-allow-dotted-principals>] [B<-preserve-vol-stats>] [B<-help>]
+    [B<-allow-dotted-principals>] [B<-preserve-vol-stats>]
     [B<-sync> <I<sync behavior>>]
+    [B<-rxmaxmtu> <I<bytes>>]
+    [B<-rxbind>]
+    [B<-syslog>[=<I<FACILITY>]]
+    [B<-sleep> <I<sleep time>/I<run time>>]
+    [B<-help>]