doc: fileserver manpage fixes
authorAndrew Deason <adeason@sinenomine.net>
Fri, 14 Jun 2013 21:54:01 +0000 (16:54 -0500)
committerDerrick Brashear <shadow@your-file-system.com>
Mon, 4 Nov 2013 12:04:10 +0000 (04:04 -0800)
 - Fix typo in -syslog option formatting

 - Add missing -nobusy

 - Add missing -vlrudisable

 - Add missing -sync in synopsis

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

doc/man-pages/pod8/dafileserver.pod.in
doc/man-pages/pod8/fragments/dafileserver-synopsis.pod
doc/man-pages/pod8/fragments/fileserver-options.pod

index ff74ad6..fe30f6d 100644 (file)
@@ -63,6 +63,12 @@ be specified is 6 (64 hash buckets). In OpenAFS 1.5.77 and earlier, the
 maximum that can be specified is 14 (16384 buckets). After 1.5.77, the
 maximum that can be specified is 28 (268435456 buckets).
 
+=item B<-vlrudisable>
+
+This option completely disables the VLRU mechanism, which means volumes will
+never "soft detach". The use of this option is only intended for debugging use
+or if you find a serious bug in the VLRU mechanism you wish to work around.
+
 =item B<-vlruthresh <I<minutes>>
 
 The number of minutes of inactivity before a volume is eligible for soft
index 3a5aa3c..5a3bdc6 100644 (file)
@@ -56,4 +56,5 @@ B<dafileserver>
     S<<< [B<-unsafe-nosalvage>] >>>
     S<<< [B<-offline-timeout> <I<timeout in seconds>>] >>>
     S<<< [B<-offline-shutdown-timeout> <I<timeout in seconds>>] >>>
+    S<<< [B<-sync> <I<sync behavior>>] >>>
     S<<< [B<-logfile <I<log file>>] >>> S<<< [B<-config <I<configuration path>>] >>>
index d2059ea..2028e52 100644 (file)
@@ -94,6 +94,25 @@ hold on a volume that the File Server is reattaching after the volume was
 offline (as a result of the B<vos restore> command, for example). Use of
 this flag is strongly discouraged.
 
+=item B<-nobusy>
+
+This option slightly changes the error codes reported to clients when an
+unattached volume is accessed by a client during fileserver startup.
+
+Normally, non-DAFS fileservers start accepting requests immediately on startup,
+but attachment of volumes can take a while. So if a client tries to access a
+volume that is not attached simply because the fileserver hasn't attached it
+yet, that client will get an error. With the B<-nobusy> option present, the
+fileserver will immediately respond with an error code that indicates the
+server is starting up. However, some older clients (before OpenAFS 1.0) don't
+understand this error code, and may not function optimally. So the default
+behavior, without the B<-nobusy> option, is to at first respond with a
+different error code that is understood by more clients, but is
+indistinguishable from other scenarios where the volume is busy and not
+attached for other reasons.
+
+There is usually no reason to use this option under normal operation.
+
 =item B<-implicit> <I<admin mode bits>>
 
 Defines the set of permissions granted by default to the
@@ -241,7 +260,7 @@ GetStatus, and so on) sent or received, aggregated over all connections to
 other machines. To display or otherwise access the records, use the Rx
 Monitoring API.
 
-=item B<-syslog [<loglevel>]
+=item B<-syslog> [<loglevel>]
 
 Use syslog instead of the normal logging location for the fileserver
 process.  If provided, log messages are at <loglevel> instead of the