doc/man-pages/pod1/fs_listquota.pod

   1 =head1 NAME
   2
   3 fs_listquota - Displays quota information for a volume
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<fs listquota> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-help>]
  11
  12 B<fs listq> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
  13
  14 B<fs lq> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
  15
  16 =for html
  17 </div>
  18
  19 =head1 DESCRIPTION
  20
  21 The B<fs listquota> command displays information about the volume
  22 containing each specified directory or file (its name, quota, and amount
  23 of disk space used), along with an indicator of the percentage of space
  24 used on the host partition.
  25
  26 To display more information about the host partition, use the B<fs
  27 examine> command.
  28
  29 To set volume quota, use the B<fs setquota> or B<fs setvol> command.
  30
  31 =head1 CAUTIONS
  32
  33 Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
  34
  35 =head1 OPTIONS
  36
  37 =over 4
  38
  39 =item B<-path> <I<dir/file path>>+
  40
  41 Names a file or directory that resides in the volume about which to
  42 produce output. Partial pathnames are interpreted relative to the current
  43 working directory, which is also the default value if this argument is
  44 omitted.
  45
  46 =item B<-help>
  47
  48 Prints the online help for this command. All other valid options are
  49 ignored.
  50
  51 =back
  52
  53 =head1 OUTPUT
  54
  55 The output displays information about the volume that houses each
  56 specified directory or file, in a tabular format that uses the following
  57 headers:
  58
  59 =over 4
  60
  61 =item Volume Name
  62
  63 The name of the volume.
  64
  65 =item Quota
  66
  67 The volume's quota in kilobytes, or the string C<no limit> to indicate an
  68 unlimited quota.
  69
  70 =item Used
  71
  72 The number of kilobytes of quota used.
  73
  74 =item % Used
  75
  76 The percentage of the volume's quota that is used (the C<Used> statistic
  77 divided by the C<Quota> statistic, times 100).
  78
  79 =item Partition
  80
  81 The percentage of space used on the partition that houses the
  82 volume. Although not directly related to how much of the user's quota is
  83 used, it is reported because a full partition can cause writing of data
  84 back to the volume to fail even when the volume has not reached its quota.
  85
  86 =back
  87
  88 =head1 EXAMPLES
  89
  90 The following example shows the output for the volume C<user.smith>:
  91
  92    % fs listquota -path /afs/abc.com/usr/smith
  93    Volume Name     Quota    Used    % Used   Partition
  94    user.smith      15000    5071       34%         86%
  95
  96 =head1 PRIVILEGE REQUIRED
  97
  98 The issuer must have the C<r> (read) permission on the ACL of the root
  99 directory of the volume that houses the file or directory named by the
 100 B<-path> argument, and C<l> (list) permission on the ACL of each
 101 directory that precedes it in the pathname.
 102
 103 =head1 SEE ALSO
 104
 105 L<fs_diskfree(1)>,
 106 L<fs_examine(1)>,
 107 L<fs_quota(1)>,
 108 L<fs_setquota(1)>,
 109 L<fs_setvol(1)>
 110
 111 =head1 COPYRIGHT
 112
 113 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 114
 115 This documentation is covered by the IBM Public License Version 1.0.  It was
 116 converted from HTML to POD by software written by Chas Williams and Russ
 117 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.