Document human-readable size suffixes

Document that the quotas passed to fs setquota, vos create, and vos
setfields and the size passed to fs setcachesize may take a suffix
indicating the unit.  This documents the change in behavior implemented by
54c0a3f3e6575fa5af39ddd797d5381c36b48001.

Fix a copy/paste error in the vos create -maxquota option definition.

Reviewed-on: http://gerrit.openafs.org/212
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>

diff --git a/doc/man-pages/pod1/fs_setcachesize.pod b/doc/man-pages/pod1/fs_setcachesize.pod
index b0aafd7fc9a12da45fae9ea5d415fcf5ac701c83..da061a9bbcfa150cd074c33b9184feb48faac853 100644 (file)
--- a/doc/man-pages/pod1/fs_setcachesize.pod
+++ b/doc/man-pages/pod1/fs_setcachesize.pod
@@ -7,17 +7,13 @@ fs_setcachesize - Sets the size of the disk cache
 =for html
 <div class="synopsis">
 
-B<fs setcachesize> [B<-blocks> <I<size in 1K byte blocks (0 => reset)>>]
-    [B<-reset>] [B<-help>]
+B<fs setcachesize> [B<-blocks> <I<size (0 => reset)>>] [B<-reset>] [B<-help>]
 
-B<fs setca> [B<-b> <I<size in 1K byte blocks (0 => reset)>>]
-    [B<-r>] [B<-h>]
+B<fs setca> [B<-b> <I<size (0 => reset)>>] [B<-r>] [B<-h>]
 
-B<fs cachesize> [B<-b> <I<size in 1K byte blocks (0 => reset)>>]
-    [B<-r>] [B<-h>]
+B<fs cachesize> [B<-b> <I<size (0 => reset)>>] [B<-r>] [B<-h>]
 
-B<fs ca> [B<-b> <I<size in 1K byte blocks (0 => reset)>>]
-    [B<-r>] [B<-h>]
+B<fs ca> [B<-b> <I<size (0 => reset)>>] [B<-r>] [B<-h>]
 
 =for html
 </div>
@@ -57,11 +53,14 @@ implementation itself requires a small amount of space on the partition.
 
 =over 4
 
-=item B<-blocks> <I<size in 1K byte blocks>>
+=item B<-blocks> <I<size>>
 
-Specifies the number of one-kilobyte blocks of disk space available for
-the Cache Manager to devote to the cache. Provide a value of C<0> to set
-cache size to the default specified in the F<cacheinfo> file.
+Specifies the amount of disk space available for the Cache Manager to
+devote to the cache.  The size should be a positive integer followed by an
+optional suffix: C<K> for kibibytes (1024 bytes, the default), C<M> for
+mebibytes (1024 kibibytes), C<G> for gibibytes (1024 mebibytes), and C<T>
+for tebibytes (1024 gibibytes).  Provide a value of C<0> to set cache size
+to the default specified in the F<cacheinfo> file.
 
 =item B<-reset>
 

diff --git a/doc/man-pages/pod1/fs_setquota.pod b/doc/man-pages/pod1/fs_setquota.pod
index 2a2af3e6415dfd529f853dfcdbbdccd35c3c1f1e..e79deee1feaadbca2b89c7ddaedc4f96fedcc9d6 100644 (file)
--- a/doc/man-pages/pod1/fs_setquota.pod
+++ b/doc/man-pages/pod1/fs_setquota.pod
@@ -10,9 +10,9 @@ fs_setquota - Sets the quota for the volume containing a file or directory
 B<fs setquota> S<<< [B<-path> <I<dir/file path>>] >>>
     S<<< B<-max> <I<max quota in kbytes>> >>> [B<-help>]
 
-B<fs setq> S<<< [B<-p> <I<dir/file path>>] >>> S<<< B<-m> <I<max quota in kbytes>> >>> [B<-h>]
+B<fs setq> S<<< [B<-p> <I<dir/file path>>] >>> S<<< B<-m> <I<max quota>> >>> [B<-h>]
 
-B<fs sq> S<<< [B<-p> <I<dir/file path>>] >>> S<<< B<-m> <I<max quota in kbytes>> >>> [B<-h>]
+B<fs sq> S<<< [B<-p> <I<dir/file path>>] >>> S<<< B<-m> <I<max quota>> >>> [B<-h>]
 
 =for html
 </div>
@@ -50,11 +50,13 @@ at the pathname's second level (for example, F</afs/.abc.com>). For
 further discussion of the concept of read/write and read-only paths
 through the filespace, see the B<fs mkmount> reference page.
 
-=item B<-max> <I<max quota in kbytes>>
+=item B<-max> <I<max quota>>
 
-Sets the maximum amount of file server disk space the volume can
-occupy. Specify the number of one-kilobyte blocks as a positive integer
-(C<1024> is one megabyte). A value of C<0> sets an unlimited quota, but
+Sets the maximum amount of file server disk space the volume can occupy.
+The quota value should be a positive integer followed by an optional
+suffix: C<K> for kibibytes (1024 bytes, the default), C<M> for mebibytes
+(1024 kibibytes), C<G> for gibibytes (1024 mebibytes), and C<T> for
+tebibytes (1024 gibibytes).  A value of C<0> sets an unlimited quota, but
 the size of the disk partition that houses the volume places an absolute
 limit on the volume's size.
 

diff --git a/doc/man-pages/pod1/vos_create.pod b/doc/man-pages/pod1/vos_create.pod
index e7b6b3dda8a40d138872bde53066623e3195e760..0c329ada7aa498d082bf93453425e44ca665c04a 100644 (file)
--- a/doc/man-pages/pod1/vos_create.pod
+++ b/doc/man-pages/pod1/vos_create.pod
@@ -8,13 +8,13 @@ vos_create - Creates a read/write volume and associated VLDB entry
 <div class="synopsis">
 
 B<vos create> S<<< B<-server> <I<machine name>> >>> S<<< B<-partition> <I<partition name>> >>>
-    S<<< B<-name> <I<volume name>> >>> S<<< [B<-maxquota> <I<initial quota (KB)>>] >>>
+    S<<< B<-name> <I<volume name>> >>> S<<< [B<-maxquota> <I<initial quota>>] >>>
     S<<< [B<-id> <I<volume ID>>] >>> S<<< [B<-roid> <I<readonly volume ID>>] >>>
     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-verbose>]
     [B<-help>]
 
 B<vos cr> S<<< B<-s> <I<machine name>> >>> S<<< B<-p> <I<partition name>> >>>
-    S<<< B<-na> <I<volume name>> >>> S<<< [B<-m> <I<initial quota (KB)>>] >>>
+    S<<< B<-na> <I<volume name>> >>> S<<< [B<-m> <I<initial quota>>] >>>
     S<<< [B<-i> <I<volume ID>>] >>> S<<< [B<-r> <I<readonly volume ID>>] >>>
     S<<< [B<-c> <I<cell name>>] >>> [B<-no>] [B<-l>] [B<-v>] [B<-h>]
 
@@ -94,13 +94,15 @@ apply the C<.backup> or C<.readonly> extension to a read/write volume
 name; they are reserved for the Volume Server to add to the read/write
 name when creating those backup and read-only volumes respectively.
 
-=item B<-maxquota> <I<volume quota>>
+=item B<-maxquota> <I<initial quota>>
 
-Specifies the maximum amount of disk space the volume can use, as a number
-of kilobyte blocks (a value of C<1024> is one megabyte). The value C<0>
-(zero) grants an unlimited quota, but the size of the disk partition that
-houses the volume places an absolute limit on its size.  If this argument
-is omitted, the default value is C<5000>.
+Specifies the maximum amount of disk space the volume can use.  The size
+should be a positive integer followed by an optional suffix: C<K> for
+kibibytes (1024 bytes, the default), C<M> for mebibytes (1024 kibibytes),
+C<G> for gibibytes (1024 mebibytes), and C<T> for tebibytes (1024
+gibibytes).  The value C<0> (zero) grants an unlimited quota, but the size
+of the disk partition that houses the volume places an absolute limit on
+its size.  If this argument is omitted, the default value is C<5000K>.
 
 =item B<-id> <I<volume ID>>
 

diff --git a/doc/man-pages/pod1/vos_setfields.pod b/doc/man-pages/pod1/vos_setfields.pod
index 14931a9dcab2ddb44b64e1df5d7d5dc9d99dddda..ececa5212b32ae5bb41073d84e523fcf880fcd0a 100644 (file)
--- a/doc/man-pages/pod1/vos_setfields.pod
+++ b/doc/man-pages/pod1/vos_setfields.pod
@@ -8,12 +8,12 @@ vos_setfields - Sets the quota or clear the access counter on a volume.
 <div class="synopsis">
 
 B<vos setfields> S<<< B<-id> <I<volume name or ID>> >>>
-    S<<< B<-maxquota> <I<quota (KB)>> >>> [B<-clearuse>]
+    S<<< B<-maxquota> <I<quota>> >>> [B<-clearuse>]
     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
     [B<-verbose>] [B<-encrypt>] [b<-noresolve>] [B<-help>]
 
 B<vos se> S<<< B<-id> <I<volume name or ID>> >>>
-    S<<< B<-maxquota> <I<quota (KB)>> >>> [B<-clearuse>]
+    S<<< B<-maxquota> <I<quota>> >>> [B<-clearuse>]
     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
     [B<-verbose>] [B<-encrypt>] [b<-noresolve>] [B<-help>]
 
@@ -43,13 +43,15 @@ This command is not effective on read-only or backup volumes.
 Identifies the volume on which to operate, either by its complete name or
 volume ID number.
 
-=item B<-maxquota> <I<cell name>>
+=item B<-maxquota> <I<quota>>
 
-Sets the maximum amount of file server disk space the volume can
-occupy. Specify the number of one-kilobyte blocks as a positive integer
-(C<1024> is one megabyte). A value of C<0> sets an unlimited quota, but
-the size of the disk partition that houses the volume places an absolute
-limit on the volume's size.
+Sets the maximum amount of file server disk space the volume can occupy.
+The quota should be a positive integer followed by an optional suffix:
+C<K> for kibibytes (1024 bytes, the default), C<M> for mebibytes (1024
+kibibytes), C<G> for gibibytes (1024 mebibytes), and C<T> for tebibytes
+(1024 gibibytes).  A value of C<0> sets an unlimited quota, but the size
+of the disk partition that houses the volume places an absolute limit on
+the volume's size.
 
 =item B<-clearuse>