LWP fileserver is no more
[openafs.git] / doc / man-pages / pod8 / fragments / fileserver-options.pod
index a35faa0..378f630 100644 (file)
@@ -28,7 +28,7 @@ and C<125>. The default value of C<0> produces only a few messages.
 
 =item B<-p> <I<number of processes>>
 
-Sets the number of threads (or LWPs) to run. Provide a positive integer. 
+Sets the number of threads to run. Provide a positive integer.
 The File Server creates and uses five threads for special purposes, 
 in addition to the number specified (but if this argument specifies 
 the maximum possible number, the File Server automatically uses five 
@@ -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
@@ -251,6 +265,12 @@ default LOG_USER.
 
 Use MR-AFS (Multi-Resident) style logging.  This option is deprecated.
 
+=item B<-transarc-logs>
+
+Use Transarc style logging features. Rename the existing log file
+F</usr/afs/logs/FileLog> to F</usr/afs/logs/FileLog.old> when the fileserver is
+restarted.  This option is provided for compatibility with older versions.
+
 =item B<-saneacls>
 
 Offer the SANEACLS capability for the fileserver.  This option is
@@ -317,8 +337,6 @@ Setting this option to C<0> means to interrupt clients immediately if a
 volume is waiting to go offline. Setting this option to C<-1> means to
 wait forever for client requests to finish. The default value is C<-1>.
 
-For the LWP fileserver, the only valid value for this option is C<-1>.
-
 =item B<-offline-shutdown-timeout> <I<timeout in seconds>>
 
 This option behaves similarly to B<-offline-timeout> but applies to
@@ -336,8 +354,6 @@ If B<-offline-timeout> is specified, the default value of
 B<-offline-shutdown-timeout> is the value specified for
 B<-offline-timeout>. Otherwise, the default value is C<-1>.
 
-For the LWP fileserver, the only valid value for this option is C<-1>.
-
 =item B<-sync> <always | onclose | none>
 
 This option changes how hard the fileserver tries to ensure that data written
@@ -426,3 +442,26 @@ 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<-vhashsize <I<size>>
+
+The log(2) of the number of volume hash buckets.  Default is 8 (i.e., by
+default, there are 2^8 = 256 volume hash buckets). The minimum that can
+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<-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.