man-page-name-underscore-20071111
[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 OPTIONS
32
33 =over 4
34
35 =item B<-path> <I<dir/file path>>+
36
37 Names a file or directory that resides in the volume about which to
38 produce output. Partial pathnames are interpreted relative to the current
39 working directory, which is also the default value if this argument is
40 omitted.
41
42 =item B<-help>
43
44 Prints the online help for this command. All other valid options are
45 ignored.
46
47 =back
48
49 =head1 OUTPUT
50
51 The output displays information about the volume that houses each
52 specified directory or file, in a tabular format that uses the following
53 headers:
54
55 =over 4
56
57 =item Volume Name
58
59 The name of the volume.
60
61 =item Quota
62
63 The volume's quota in kilobytes, or the string C<no limit> to indicate an
64 unlimited quota.
65
66 =item Used
67
68 The number of kilobytes of quota used.
69
70 =item % Used
71
72 The percentage of the volume's quota that is used (the C<Used> statistic
73 divided by the C<Quota> statistic, times 100).
74
75 =item Partition
76
77 The percentage of space used on the partition that houses the
78 volume. Although not directly related to how much of the user's quota is
79 used, it is reported because a full partition can cause writing of data
80 back to the volume to fail even when the volume has not reached its quota.
81
82 =back
83
84 =head1 EXAMPLES
85
86 The following example shows the output for the volume C<user.smith>:
87
88    % fs listquota -path /afs/abc.com/usr/smith
89    Volume Name     Quota    Used    % Used   Partition
90    user.smith      15000    5071       34%         86%
91
92 =head1 PRIVILEGE REQUIRED
93
94 The issuer must have the C<r> (read) permission on the ACL of the root
95 directory of the volume that houses the file or directory named by the
96 B<-path> argument, and on the ACL of each directory that precedes it in
97 the pathname.
98
99 =head1 SEE ALSO
100
101 L<fs_diskfree(1)>,
102 L<fs_examine(1)>,
103 L<fs_quota(1)>,
104 L<fs_setquota(1)>,
105 L<fs_setvol(1)>
106
107 =head1 COPYRIGHT
108
109 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
110
111 This documentation is covered by the IBM Public License Version 1.0.  It was
112 converted from HTML to POD by software written by Chas Williams and Russ
113 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.