Remove unused -k argument to fileserver
[openafs.git] / doc / man-pages / pod8 / fragments / fileserver-options.pod
index a35faa0..67b754e 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
@@ -187,11 +206,6 @@ server machine. Combine this flag with any option except the B<-L> flag;
 omit both flags to set values suitable for a medium-sized file server
 machine.
 
-=item B<-k> <I<stack size>>
-
-Sets the LWP stack size in units of 1 kilobyte. Do not use this argument,
-and in particular do not specify a value less than the default of C<24>.
-
 =item B<-realm> <I<Kerberos realm name>>
 
 Defines the Kerberos realm name for the File Server to use. If this
@@ -241,7 +255,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
@@ -426,3 +440,18 @@ any other option, whereas others argue that choosing anything besides the
 C<always> option allows for an unacceptable risk of data loss. This may
 depend on your usage patterns, your platform and filesystem, and who you talk
 to about this topic.
+
+=item B<-logfile> <I<log file>>
+
+Sets the file to use for server logging.  If logfile is not specified and
+no other logging options are supplied, this will be F</usr/afs/logs/FileLog>.
+Note that this option is intended for debugging and testing purposes.
+Changing the location of the log file from the command line may result
+in undesirable interactions with tools such as B<bos>.
+
+=item B<-config> <I<configuration directory>>
+
+Set the location of the configuration directory used to configure this
+service.  In a typical configuration this will be F</usr/afs/etc> - this
+option allows the use of alternative configuration locations for testing
+purposes.