From 55b8a4d35eb5913ebdc9e5ce8c1f1db525c55ff1 Mon Sep 17 00:00:00 2001 From: Russ Allbery Date: Fri, 24 Jul 2009 13:38:09 -0700 Subject: [PATCH] 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 Reviewed-by: Derrick Brashear --- doc/man-pages/pod1/fs_setcachesize.pod | 23 +++++++++++------------ doc/man-pages/pod1/fs_setquota.pod | 14 ++++++++------ doc/man-pages/pod1/vos_create.pod | 18 ++++++++++-------- doc/man-pages/pod1/vos_setfields.pod | 18 ++++++++++-------- 4 files changed, 39 insertions(+), 34 deletions(-) diff --git a/doc/man-pages/pod1/fs_setcachesize.pod b/doc/man-pages/pod1/fs_setcachesize.pod index b0aafd7fc..da061a9bb 100644 --- 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
-B [B<-blocks> reset)>>] - [B<-reset>] [B<-help>] +B [B<-blocks> reset)>>] [B<-reset>] [B<-help>] -B [B<-b> reset)>>] - [B<-r>] [B<-h>] +B [B<-b> reset)>>] [B<-r>] [B<-h>] -B [B<-b> reset)>>] - [B<-r>] [B<-h>] +B [B<-b> reset)>>] [B<-r>] [B<-h>] -B [B<-b> reset)>>] - [B<-r>] [B<-h>] +B [B<-b> reset)>>] [B<-r>] [B<-h>] =for html
@@ -57,11 +53,14 @@ implementation itself requires a small amount of space on the partition. =over 4 -=item B<-blocks> > +=item B<-blocks> > -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 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 for kibibytes (1024 bytes, the default), C for +mebibytes (1024 kibibytes), C for gibibytes (1024 mebibytes), and C +for tebibytes (1024 gibibytes). Provide a value of C<0> to set cache size +to the default specified in the F file. =item B<-reset> diff --git a/doc/man-pages/pod1/fs_setquota.pod b/doc/man-pages/pod1/fs_setquota.pod index 2a2af3e64..e79deee1f 100644 --- 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 S<<< [B<-path> >] >>> S<<< B<-max> > >>> [B<-help>] -B S<<< [B<-p> >] >>> S<<< B<-m> > >>> [B<-h>] +B S<<< [B<-p> >] >>> S<<< B<-m> > >>> [B<-h>] -B S<<< [B<-p> >] >>> S<<< B<-m> > >>> [B<-h>] +B S<<< [B<-p> >] >>> S<<< B<-m> > >>> [B<-h>] =for html @@ -50,11 +50,13 @@ at the pathname's second level (for example, F). For further discussion of the concept of read/write and read-only paths through the filespace, see the B reference page. -=item B<-max> > +=item B<-max> > -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 for kibibytes (1024 bytes, the default), C for mebibytes +(1024 kibibytes), C for gibibytes (1024 mebibytes), and C 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 e7b6b3dda..0c329ada7 100644 --- 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
B S<<< B<-server> > >>> S<<< B<-partition> > >>> - S<<< B<-name> > >>> S<<< [B<-maxquota> >] >>> + S<<< B<-name> > >>> S<<< [B<-maxquota> >] >>> S<<< [B<-id> >] >>> S<<< [B<-roid> >] >>> S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>] B S<<< B<-s> > >>> S<<< B<-p> > >>> - S<<< B<-na> > >>> S<<< [B<-m> >] >>> + S<<< B<-na> > >>> S<<< [B<-m> >] >>> S<<< [B<-i> >] >>> S<<< [B<-r> >] >>> S<<< [B<-c> >] >>> [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> > +=item B<-maxquota> > -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 for +kibibytes (1024 bytes, the default), C for mebibytes (1024 kibibytes), +C for gibibytes (1024 mebibytes), and C 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> > diff --git a/doc/man-pages/pod1/vos_setfields.pod b/doc/man-pages/pod1/vos_setfields.pod index 14931a9dc..ececa5212 100644 --- 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.
B S<<< B<-id> > >>> - S<<< B<-maxquota> > >>> [B<-clearuse>] + S<<< B<-maxquota> > >>> [B<-clearuse>] S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-encrypt>] [b<-noresolve>] [B<-help>] B S<<< B<-id> > >>> - S<<< B<-maxquota> > >>> [B<-clearuse>] + S<<< B<-maxquota> > >>> [B<-clearuse>] S<<< [B<-cell> >] >>> [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> > +=item B<-maxquota> > -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 for kibibytes (1024 bytes, the default), C for mebibytes (1024 +kibibytes), C for gibibytes (1024 mebibytes), and C 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> -- 2.39.5