From 0e91773fd769f2c5ce69eef1e795993f963ab3ee Mon Sep 17 00:00:00 2001 From: Steven Jenkins Date: Wed, 12 Mar 2008 01:28:00 +0000 Subject: [PATCH] man-page-fileserver-update-20080311 LICENSE IPL10 Update the fileserver documentation for demand-attach and add documentation of other missing options and notes where some options are only applicable with particular builds. --- doc/man-pages/pod8/fileserver.pod | 237 +++++++++++++++++++++++++++++--------- 1 file changed, 183 insertions(+), 54 deletions(-) diff --git a/doc/man-pages/pod8/fileserver.pod b/doc/man-pages/pod8/fileserver.pod index 50f3463..b3813ec 100644 --- a/doc/man-pages/pod8/fileserver.pod +++ b/doc/man-pages/pod8/fileserver.pod @@ -11,25 +11,51 @@ B S<<< [B<-auditlog> >] >>> S<<< [B<-d> >] >>> S<<< [B<-p> >] >>> S<<< [B<-spare> >] >>> - S<<< [B<-pctspare> >] >>> S<<< [B<-b> >] >>> - S<<< [B<-l> >] >>> S<<< [B<-s> >] >>> - S<<< [B<-vc> >] >>> S<<< [B<-w> >] >>> - S<<< [B<-cb> >] >>> [B<-banner>] [B<-novbc>] - S<<< [B<-implicit> >] >>> [B<-readonly>] + S<<< [B<-pctspare> >] >>> + S<<< [B<-b> >] >>> + S<<< [B<-l> >] >>> + S<<< [B<-s> >] >>> + S<<< [B<-vc> >] >>> + S<<< [B<-w> >] >>> + S<<< [B<-cb> >] >>> + S<<< [B<-banner>] >>> + S<<< [B<-novbc>] >>> + S<<< [B<-implicit> >] >>> + S<<< [B<-readonly>] >>> S<<< [B<-hr> >] >>> S<<< [B<-busyat> n >>>] >>> - [B<-nobusy>] S<<< [B<-rxpck> >] >>> - [B<-rxdbg>] [B<-rxdbge>] S<<< [B<-rxmaxmtu> >] >>> - [B<-allow-dotted-principal>] - S<<< [B<-rxbind> >] >>> - S<<< [B<-vattachpar> >] >>> - S<<< [B<-m> >] >>> - [B<-lock>] [B<-L>] [B<-S>] S<<< [B<-k> >] >>> + S<<< [B<-nobusy>] >>> + S<<< [B<-rxpck> >] >>> + S<<< [B<-rxdbg>] >>> + S<<< [B<-rxdbge>] >>> + S<<< [B<-rxmaxmtu> >] >>> + S<<< [B<-nojumbo> >>> + S<<< [B<-rxbind> >>> + S<<< [B<-allow-dotted-principals>] >>> + S<<< [B<-L>] >>> + S<<< [B<-S>] >>> + S<<< [B<-k> >] >>> S<<< [B<-realm> >] >>> S<<< [B<-udpsize> >] >>> S<<< [B<-sendsize> >] >>> S<<< [B<-abortthreshold> >] >>> - [B<-enable_peer_stats>] [B<-enable_process_stats>] [B<-help>] + S<<< [B<-enable_peer_stats>] >>> + S<<< [B<-enable_process_stats>] >>> + S<<< [B<-syslog> [>]] >>> + S<<< [B<-mrafslogs>] >>> + S<<< [B<-saneacls>] >>> + S<<< [B<-help>] >>> + S<<< [B<-fs-state-dont-save>] >>> + S<<< [B<-fs-state-dont-restore>] >>> + S<<< [B<-fs-state-verify>] (none | save | restore | both)] >>> + S<<< [B<-vhashsize> >] >>> + S<<< [B<-vlrudisable>] >>> + S<<< [B<-vlruthresh> >] >>> + S<<< [B<-vlruinterval> >] >>> + S<<< [B<-vlrumax> >] >>> + S<<< [B<-vattachpar> >] >>> + S<<< [B<-m> >] >>> + S<<< [B<-lock>] >>> =for html @@ -66,9 +92,10 @@ machine sizes. =item * -The maximum number of lightweight processes (LWPs) the File Server uses to -handle requests for data; corresponds to the B<-p> argument. The File -Server always uses a minimum of 32 KB of memory for these processes. +The maximum number of lightweight processes (LWPs) or pthreads +the File Server uses to handle requests for data; corresponds to the +B<-p> argument. The File Server always uses a minimum of 32 KB of +memory for these processes. =item * @@ -204,13 +231,13 @@ and B<-lock> options, appear in the output generated by the B<-help> option only on the relevant system type. Currently, the maximum size of a volume is 2 terabytes (2^31 bytes) -and the maximum size of a /vicepX partition on a fileserver is also 2 -terabytes. The fileserver will not report an error when it has access -to a partition larger than 2 terabytes, but it will probably fail if -the administrator attempts to use more than 2 terabytes of space. In +and the maximum size of a /vicepX partition on a fileserver is 2^64 +kilobytes. The fileserver will not report an error when it has access +to a partition larger than 2^64 kilobytes, but it will probably fail if +the administrator attempts to use more than 2^64 kilobytes of space. In addition, there are reports of erroneous disk usage numbers when B or other OpenAFS disk reporting tools are used with -partitions larger than 2 terabytes. +partitions larger than 2^64 kilobytes. The maximum number of directory entries is 64,000 if all of the entries have names that are 15 characters or less in length. A name @@ -241,11 +268,11 @@ and C<125>. The default value of C<0> produces only a few messages. =item B<-p> > -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 of the threads for its own -purposes). +Sets the number of threads (or LWPs) 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 +of the threads for its own purposes). The maximum number of threads can differ in each release of AFS. Consult the I for the current release. @@ -317,6 +344,10 @@ permission letters (C) and auxiliary permission letters (C, C, C, and C). To review the meaning of the permissions, see the B reference page. +=item B<-readonly> + +Don't allow writes to this fileserver. + =item B<-hr> > Specifies how often the File Server refreshes its knowledge of the @@ -347,11 +378,24 @@ integer. Writes a trace of the File Server's operations on Rx packets to the file F. -=item F<-rxdbge> +=item B<-rxdbge> Writes a trace of the File Server's operations on Rx events (such as retransmissions) to the file F. +=item B<-rxmaxmtu> > + +Defines the maximum size of an MTU. The value must be between the +minimum and maximum packet data sizes for Rx. + +=item B<-nojumbo> + +Do not send, and do not accept, jumbograms. + +=item B<-rxbind> + +Force the fileserver to only bind to one IP address. + =item B<-allow-dotted-principal> By default, the RXKAD security layer will disallow access by Kerberos @@ -361,19 +405,6 @@ user.admin PTS entry. Sites whose Kerberos realms don't have these collisions between principal names may disable this check by starting the server with this option. -=item F<-m> > - -Specifies the percentage of each AFS server partition that the AIX version -of the File Server creates as a reserve. Specify an integer value between -C<0> and C<30>; the default is 8%. A value of C<0> means that the -partition can become completely full, which can have serious negative -consequences. - -=item B<-lock> - -Prevents any portion of the fileserver binary from being paged (swapped) -out of memory on a file server machine running the IRIX operating system. - =item B<-L> Sets values for many arguments in a manner suitable for a large file @@ -404,21 +435,9 @@ listed in the local F file. Sets the size of the UDP buffer, which is 64 KB by default. Provide a positive integer, preferably larger than the default. -=item B<-enable_peer_stats> - -Activates the collection of Rx statistics and allocates memory for their -storage. For each connection with a specific UDP port on another machine, -a separate record is kept for each type of RPC (FetchFile, GetStatus, and -so on) sent or received. To display or otherwise access the records, use -the Rx Monitoring API. - -=item B<-enable_process_stats> +=item B<-sendsize> > -Activates the collection of Rx statistics and allocates memory for their -storage. A separate record is kept for each type of RPC (FetchFile, -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. +Sets the size of the send buffer, which is 16384 bytes by default. =item B<-abortthreshold> > @@ -438,11 +457,121 @@ time instead of in bulk like the Unix Open AFS client. Setting the threshold to 0 disables the throttling behavior. This option is available in OpenAFS versions 1.4.1 and later. +=item B<-enable_peer_stats> + +Activates the collection of Rx statistics and allocates memory for their +storage. For each connection with a specific UDP port on another machine, +a separate record is kept for each type of RPC (FetchFile, GetStatus, and +so on) sent or received. To display or otherwise access the records, use +the Rx Monitoring API. + +=item B<-enable_process_stats> + +Activates the collection of Rx statistics and allocates memory for their +storage. A separate record is kept for each type of RPC (FetchFile, +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 [] + +Use syslog instead of the normal logging location for the fileserver +process. If provided, log messages are at instead of the +default LOG_USER. + +=item B<-mrafslogs> + +Use MR-AFS (Multi-Resident) style logging. This option is deprecated. + +=item B<-saneacls> + +Offer the SANEACLS capability for the fileserver. This option is +currently unimplemented. + =item B<-help> Prints the online help for this command. All other valid options are ignored. +=item B<-fs-state-dont-save> + +When present, fileserver state will not be saved during shutdown. Default +is to save state. + +This option is only supported by the demand-attach file server. + +=item B<-fs-state-dont-restore> + +When present, fileserver state will not be restored during startup. +Default is to restore state on startup. + +This option is only supported by the demand-attach file server. + +=item B<-fs-state-verify> (none | save | restore | both) + +This argument controls the behavior of the state verification mechanism. +A value of C turns off all verification. A value of C only +performs the verification steps prior to saving state to disk. A value +of C only performs the verification steps after restoring state +from disk. A value of C performs all verifications steps both +prior to save and following a restore. + +The default is C. + +This option is only supported by the demand-attach file server. + +=item B<-vhashsize > + +The log(2) number of of volume hash buckets. Default is 8 (i.e., by +default, there are 2^8 = 256 volume hash buckets). + +This option is only supported by the demand-attach file server. + +=item B<-vlruthresh > + +The number of minutes of inactivity before a volume is eligible for soft +detachment. Default is 120 minutes. + +This option is only supported by the demand-attach file server. + +=item B<-vlruinterval > + +The number of seconds between VLRU candidate queue scan default is 120 s. +The second s. + +This option is only supported by the demand-attach file server. + +=item B<-vlrumax > + +The maximum number of volumes which can be soft detached in a single pass +of the scanner. Default is 8 volumes. + +This option is only supported by the demand-attach file server. + +=item B<-vattachpar> > + +The number of threads assigned to attach and detach volumes. The default +is 1. Warning: many of the I/O parallism features of Demand-Attach +Fileserver are turned off when the number of volume attach threads is only +1. + +This option is only meaningful for a file server built with pthreads +support. + +=item B<-m> > + +Specifies the percentage of each AFS server partition that the AIX version +of the File Server creates as a reserve. Specify an integer value between +C<0> and C<30>; the default is 8%. A value of C<0> means that the +partition can become completely full, which can have serious negative +consequences. This option is not supported on platforms other than AIX. + +=item B<-lock> + +Prevents any portion of the fileserver binary from being paged (swapped) +out of memory on a file server machine running the IRIX operating system. +This option is not supported on platforms other than IRIX. + =back =head1 EXAMPLES -- 1.9.4