man-page-fs-read-not-list-20080711
[openafs.git] / 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 and the maximum size of a /vicepX partition on a fileserver is also 2
35 terabytes. The fileserver will not report an error when it has access
36 to a partition larger than 2 terabytes, but it will probably fail if
37 the administrator attempts to use more than 2 terabytes of space. In
38 addition, there are reports of erroneous disk usage numbers when
39 B<vos partinfo> or other OpenAFS disk reporting tools are used with
40 partitions larger than 2 terabytes.
41
42 =head1 OPTIONS
43
44 =over 4
45
46 =item B<-path> <I<dir/file path>>+
47
48 Names a file or directory that resides in the volume about which to
49 produce output. Partial pathnames are interpreted relative to the current
50 working directory, which is also the default value if this argument is
51 omitted.
52
53 =item B<-help>
54
55 Prints the online help for this command. All other valid options are
56 ignored.
57
58 =back
59
60 =head1 OUTPUT
61
62 The output displays information about the volume that houses each
63 specified directory or file, in a tabular format that uses the following
64 headers:
65
66 =over 4
67
68 =item Volume Name
69
70 The name of the volume.
71
72 =item Quota
73
74 The volume's quota in kilobytes, or the string C<no limit> to indicate an
75 unlimited quota.
76
77 =item Used
78
79 The number of kilobytes of quota used.
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 =back
94
95 =head1 EXAMPLES
96
97 The following example shows the output for the volume C<user.smith>:
98
99    % fs listquota -path /afs/abc.com/usr/smith
100    Volume Name     Quota    Used    % Used   Partition
101    user.smith      15000    5071       34%         86%
102
103 =head1 PRIVILEGE REQUIRED
104
105 The issuer must have the C<r> (read) permission on the ACL of the root
106 directory of the volume that houses the file or directory named by the
107 B<-path> argument, and C<l> (list) permission on the ACL of each 
108 directory that precedes it in the pathname.
109
110 =head1 SEE ALSO
111
112 L<fs_diskfree(1)>,
113 L<fs_examine(1)>,
114 L<fs_quota(1)>,
115 L<fs_setquota(1)>,
116 L<fs_setvol(1)>
117
118 =head1 COPYRIGHT
119
120 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
121
122 This documentation is covered by the IBM Public License Version 1.0.  It was
123 converted from HTML to POD by software written by Chas Williams and Russ
124 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.