man-page-fileserver-fix-block-size-20081111
[openafs.git] / doc / man-pages / pod8 / fileserver.pod
index 19e5f5c..36a2d00 100644 (file)
@@ -30,6 +30,7 @@ B<fileserver> S<<< [B<-auditlog> <I<path to log file>>] >>>
     S<<< [B<-rxdbge>] >>>
     S<<< [B<-rxmaxmtu> <I<bytes>>] >>>
     S<<< [B<-nojumbo> >>>
+    S<<< [B<-jumbo> >>>
     S<<< [B<-rxbind> >>>
     S<<< [B<-allow-dotted-principals>] >>>
     S<<< [B<-L>] >>>
@@ -50,7 +51,7 @@ B<fileserver> S<<< [B<-auditlog> <I<path to log file>>] >>>
     S<<< [B<-fs-state-verify>] (none | save | restore | both)] >>>
     S<<< [B<-vhashsize> <I<log(2) of number of volume hash buckets>>] >>>
     S<<< [B<-vlrudisable>] >>>
-    S<<< [B<-vlruthresh> <I<minutes before unused volumes become eligible for soft detach>>] >>>
+    S<<< [B<-vlruthresh> <I<minutes before eligibility for soft detach>>] >>>
     S<<< [B<-vlruinterval> <I<seconds between VLRU scans>>] >>>
     S<<< [B<-vlrumax> <I<max volumes to soft detach in one VLRU scan>>] >>>
     S<<< [B<-vattachpar> <I<number of volume attach threads>>] >>>
@@ -197,13 +198,13 @@ effective. To change this frequency, use the B<-hr> argument.
 
 The File Server stores volumes in partitions. A partition is a
 filesystem or directory on the server machine that is named C</vicepX>
-or C</vicepXX> where XX is "a" through "z" or "aa" though "zz". The
-File Server expects that the /vicepXX directories are each on a
-dedicated filesystem. The File Server will only use a /vicepXX if it's
-a mountpoint for another filesystem, unless the file
-C</vicepXX/AlwaysAttach> exists. The data in the partition is a
-special format that can only be access using OpenAFS commands or an
-OpenAFS client.
+or C</vicepXX> where XX is "a" through "z" or "aa" though "iv". Up to
+255 partitions are allowed. The File Server expects that the /vicepXX
+directories are each on a dedicated filesystem. The File Server will
+only use a /vicepXX if it's a mountpoint for another filesystem,
+unless the file C</vicepXX/AlwaysAttach> exists. The data in the
+partition is a special format that can only be access using OpenAFS
+commands or an OpenAFS client.
 
 The File Server generates the following message when a partition is nearly
 full:
@@ -231,21 +232,18 @@ 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 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<vos partinfo> or other OpenAFS disk reporting tools are used with
-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
-that is 15 characters long requires the use of only one block in the
-directory. Additional sequential blocks are required to store entries
-with names that are longer than 15 characters. Each additional block
-provides an additional length of 32 characters for the name of the
-entry.
+and the maximum size of a /vicepX partition on a fileserver is 2^64
+kilobytes. The maximum partition size in releases 1.4.7 and earlier is
+2 terabytes (2^31 bytes). The maximum partition size for 1.5.x
+releases 1.5.34 and earlier is 2 terabytes as well.
+
+The maximum number of directory entries is 64,000 if all of the entries
+have names that are 15 octets or less in length. A name that is 15 octets
+long requires the use of only one block in the directory. Additional
+sequential blocks are required to store entries with names that are longer
+than 15 octets. Each additional block provides an additional length of 32
+octets for the name of the entry. Note that if file names use an encoding
+like UTF-8, a single character may be encoded into multiple octets.
 
 In real world use, the maximum number of objects in an AFS directory
 is usually between 16,000 and 25,000, depending on the average name
@@ -274,8 +272,8 @@ 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<IBM AFS Release Notes> for the current release.
+The maximum number of threads can differ in each release of OpenAFS.
+Consult the I<OpenAFS Release Notes> for the current release.
 
 =item B<-spare> <I<number of spare blocks>>
 
@@ -388,9 +386,17 @@ retransmissions) to the file F</usr/afs/logs/rx_dbg>.
 Defines the maximum size of an MTU.  The value must be between the
 minimum and maximum packet data sizes for Rx.
 
+=item B<-jumbo>
+
+Allows the server to send and receive jumbograms. A jumbogram is
+a large-size packet composed of 2 to 4 normal Rx data packets that share
+the same header. The fileserver does not use jumbograms by default, as some
+routers are not capable of properly breaking the jumbogram into smaller
+packets and reassembling them.
+
 =item B<-nojumbo>
 
-Do not send, and do not accept, jumbograms.
+Deprecated; jumbograms are disabled by default.
 
 =item B<-rxbind>