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