doc/man-pages/pod1/fs_listquota.pod.in

   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<-human>] [B<-help>]
  11
  12 B<fs listq> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-hu>] [B<-he>]
  13
  14 B<fs lq> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-hu>] [B<-he>]
  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 =include fragments/volsize-caution.pod
  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<-human>
  47
  48 Print space in a "human-readable" format. Instead of always printing space
  49 in kilobytes, show disk space in kilobytes, megabytes, gigabytes,
  50 terabytes, or petabytes, as appropriate.
  51
  52 =item B<-help>
  53
  54 Prints the online help for this command. All other valid options are
  55 ignored.
  56
  57 =back
  58
  59 =head1 OUTPUT
  60
  61 The output displays information about the volume that houses each
  62 specified directory or file, in a tabular format that uses the following
  63 headers:
  64
  65 =over 4
  66
  67 =item Volume Name
  68
  69 The name of the volume.
  70
  71 =item Quota
  72
  73 The volume's quota in kilobytes, or the string C<no limit> to indicate an
  74 unlimited quota.
  75
  76 =item Used
  77
  78 The amount of space used. If B<-human> is not specified, this value is in
  79 kilobytes.
  80
  81 =item % Used
  82
  83 The percentage of the volume's quota that is used (the C<Used> statistic
  84 divided by the C<Quota> statistic, times 100).
  85
  86 =item Partition
  87
  88 The percentage of space used on the partition that houses the
  89 volume. Although not directly related to how much of the user's quota is
  90 used, it is reported because a full partition can cause writing of data
  91 back to the volume to fail even when the volume has not reached its quota.
  92
  93 Note that due to limitations in the current wire protocol, OpenAFS cannot
  94 accurately calculate this field for partitions over 2 terabytes (2^41 bytes)
  95 in size. As a result, the percentage displayed in this field may be smaller
  96 than reality. For example, if the partition has over 2 terabytes (2^41 bytes)
  97 free, B<fs listquota> will report the partition usage as 0%. If the partition
  98 has less than 2 terabytes (2^41 bytes) free, but is larger than 2 terabytes
  99 (2^41 bytes) in size, the reported partition usage will be larger than
 100 0%, but will still be less than the actual usage.
 101
 102 =back
 103
 104 =head1 EXAMPLES
 105
 106 The following example shows the output for the volume C<user.smith>:
 107
 108    % fs listquota -path /afs/example.com/usr/smith
 109    Volume Name     Quota    Used    % Used   Partition
 110    user.smith      15000    5071       34%         86%
 111
 112 =head1 PRIVILEGE REQUIRED
 113
 114 The issuer must have the C<r> (read) permission on the ACL of the root
 115 directory of the volume that houses the file or directory named by the
 116 B<-path> argument, and C<l> (list) permission on the ACL of each
 117 directory that precedes it in the pathname.
 118
 119 =head1 SEE ALSO
 120
 121 L<fs_diskfree(1)>,
 122 L<fs_examine(1)>,
 123 L<fs_quota(1)>,
 124 L<fs_setquota(1)>,
 125 L<fs_setvol(1)>
 126
 127 =head1 COPYRIGHT
 128
 129 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 130
 131 This documentation is covered by the IBM Public License Version 1.0.  It was
 132 converted from HTML to POD by software written by Chas Williams and Russ
 133 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.