Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod1 / fs_quota.pod.in
CommitLineData
805e021f
CE
1=head1 NAME
2
3fs_quota - Displays the quota used in the volume containing a directory or file
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<fs quota> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-help>]
11
12B<fs q> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
13
14=for html
15</div>
16
17=head1 DESCRIPTION
18
19The B<fs quota> command displays the percent of quota consumed in the
20volume that contains each specified directory or file.
21
22To display more detailed information about the volume and the partition it
23resides on, use the B<fs examine> and B<fs listquota> commands.
24
25To set volume quota, use the B<fs setquota> or B<fs setvol> command.
26
27=head1 CAUTIONS
28
29=include fragments/volsize-caution.pod
30
31=head1 OPTIONS
32
33=over 4
34
35=item B<-path> <I<dir/file path>>
36
37Names each file or directory for which to display the quota consumed in
38its parent volume. Partial pathnames are interpreted relative to the
39current working directory, which is also the default value if this
40argument is omitted.
41
42=item B<-help>
43
44Prints the online help for this command. All other valid options are
45ignored.
46
47=back
48
49=head1 OUTPUT
50
51The output reports the percent of volume quota used, in the following
52format:
53
54 <percent>% of quota used.
55
56=head1 EXAMPLES
57
58The following command lists the percent quota used of the volume housing
59the current working directory:
60
61 % fs quota
62 17% of quota used.
63
64The following command lists the percent quota used of both the volume
65housing the current working directory's parent directory and the volume
66housing the directory F</afs/example.com/usr/smith>:
67
68 % fs quota -path .. /afs/example.com/usr/smith
69 43% of quota used.
70 92% of quota used.
71
72=head1 PRIVILEGE REQUIRED
73
74The issuer must have the C<r> (read) permission on the ACL of the root
75directory of the volume that houses the file or directory named by the
76B<-path> argument, and C<l> (list) permission on the ACL of each
77directory that precedes it in the pathname.
78
79=head1 SEE ALSO
80
81L<fs_examine(1)>,
82L<fs_listquota(1)>,
83L<fs_setquota(1)>,
84L<fs_setvol(1)>
85
86=head1 COPYRIGHT
87
88IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
89
90This documentation is covered by the IBM Public License Version 1.0. It was
91converted from HTML to POD by software written by Chas Williams and Russ
92Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.