man-page-fs-read-not-list-20080711

[openafs.git] / doc / man-pages / pod1 / fs_quota.pod

diff --git a/doc/man-pages/pod1/fs_quota.pod b/doc/man-pages/pod1/fs_quota.pod
index c56bcb4..d944509 100644 (file)
--- a/doc/man-pages/pod1/fs_quota.pod
+++ b/doc/man-pages/pod1/fs_quota.pod
@@ -1,41 +1,55 @@
 =head1 NAME
 
-fs quota - Displays the percentage of quota used in the volume containing a directory
-or file
+fs_quota - Displays the quota used in the volume containing a directory or file
 
 =head1 SYNOPSIS
 
-B<fs quota> [B<-path> <I<dir/file path>>+]  [-help]
+=for html
+<div class="synopsis">
 
-B<fs q> [B<-p> <I<dir/file path>>+]  [-h]
+B<fs quota> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-help>]
+
+B<fs q> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
+
+=for html
+</div>
 
 =head1 DESCRIPTION
 
-The fs quota command displays the percent of quota consumed in
-the volume that contains each specified directory or file.
+The B<fs quota> command displays the percent of quota consumed in the
+volume that contains each specified directory or file.
 
 To display more detailed information about the volume and the partition it
-resides on, use the B<fs examine> and B<fs listquota>
-commands.
+resides on, use the B<fs examine> and B<fs listquota> commands.
+
+To set volume quota, use the B<fs setquota> or B<fs setvol> command.
+
+=head1 CAUTIONS
 
-To set volume quota, use the B<fs setquota> or fs setvol
-command.
+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
+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 terabytes.
 
 =head1 OPTIONS
 
 =over 4
 
-=item -path
+=item B<-path> <I<dir/file path>>
 
 Names each file or directory for which to display the quota consumed in
 its parent volume. Partial pathnames are interpreted relative to the
-current working directory, which is also the default value if this argument is
-omitted.
+current working directory, which is also the default value if this
+argument is omitted.
 
-=item -help
+=item B<-help>
 
-Prints the online help for this command. All other valid options
-are ignored.
+Prints the online help for this command. All other valid options are
+ignored.
 
 =back
 
@@ -44,7 +58,7 @@ are ignored.
 The output reports the percent of volume quota used, in the following
 format:
 
-   I<percent>% of quota used.
+   <percent>% of quota used.
 
 =head1 EXAMPLES
 
@@ -56,18 +70,18 @@ the current working directory:
 
 The following command lists the percent quota used of both the volume
 housing the current working directory's parent directory and the volume
-housing the directory B</afs/abc.com/usr/smith>:
+housing the directory F</afs/abc.com/usr/smith>:
 
-   % fs quota -path  ..  /afs/abc.com/usr/smith
+   % fs quota -path .. /afs/abc.com/usr/smith
    43% of quota used.
    92% of quota used.
 
 =head1 PRIVILEGE REQUIRED
 
-The issuer must have the B<l> (lookup) permission on the
-ACL of the root directory of the volume that houses the file or directory
-named by the B<-path> argument, and on the ACL of each directory that
-precedes it in the pathname.
+The issuer must have the C<r> (read) permission on the ACL of the root
+directory of the volume that houses the file or directory named by the
+B<-path> argument, and C<l> (list) permission on the ACL of each 
+directory that precedes it in the pathname.
 
 =head1 SEE ALSO