man-page-fs-read-not-list-20080711
[openafs.git] / doc / man-pages / pod1 / fs_quota.pod
1 =head1 NAME
2
3 fs_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
10 B<fs quota> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-help>]
11
12 B<fs q> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
13
14 =for html
15 </div>
16
17 =head1 DESCRIPTION
18
19 The B<fs quota> command displays the percent of quota consumed in the
20 volume that contains each specified directory or file.
21
22 To display more detailed information about the volume and the partition it
23 resides on, use the B<fs examine> and B<fs listquota> commands.
24
25 To set volume quota, use the B<fs setquota> or B<fs setvol> command.
26
27 =head1 CAUTIONS
28
29 Currently, the maximum size of a volume is 2 terabytes (2^31 bytes)
30 and the maximum size of a /vicepX partition on a fileserver is also 2
31 terabytes. The fileserver will not report an error when it has access
32 to a partition larger than 2 terabytes, but it will probably fail if
33 the administrator attempts to use more than 2 terabytes of space. In
34 addition, there are reports of erroneous disk usage numbers when
35 B<vos partinfo> or other OpenAFS disk reporting tools are used with
36 partitions larger than 2 terabytes.
37
38 =head1 OPTIONS
39
40 =over 4
41
42 =item B<-path> <I<dir/file path>>
43
44 Names each file or directory for which to display the quota consumed in
45 its parent volume. Partial pathnames are interpreted relative to the
46 current working directory, which is also the default value if this
47 argument is omitted.
48
49 =item B<-help>
50
51 Prints the online help for this command. All other valid options are
52 ignored.
53
54 =back
55
56 =head1 OUTPUT
57
58 The output reports the percent of volume quota used, in the following
59 format:
60
61    <percent>% of quota used.
62
63 =head1 EXAMPLES
64
65 The following command lists the percent quota used of the volume housing
66 the current working directory:
67
68    % fs quota
69    17% of quota used.
70
71 The following command lists the percent quota used of both the volume
72 housing the current working directory's parent directory and the volume
73 housing the directory F</afs/abc.com/usr/smith>:
74
75    % fs quota -path .. /afs/abc.com/usr/smith
76    43% of quota used.
77    92% of quota used.
78
79 =head1 PRIVILEGE REQUIRED
80
81 The issuer must have the C<r> (read) permission on the ACL of the root
82 directory of the volume that houses the file or directory named by the
83 B<-path> argument, and C<l> (list) permission on the ACL of each 
84 directory that precedes it in the pathname.
85
86 =head1 SEE ALSO
87
88 L<fs_examine(1)>,
89 L<fs_listquota(1)>,
90 L<fs_setquota(1)>,
91 L<fs_setvol(1)>
92
93 =head1 COPYRIGHT
94
95 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
96
97 This documentation is covered by the IBM Public License Version 1.0.  It was
98 converted from HTML to POD by software written by Chas Williams and Russ
99 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.