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