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