pod-man-pages-20051015
[openafs.git] / doc / man-pages / pod / fs_setquota.pod
1 =head1 NAME
2
3 fs setquota - Sets the maximum quota for the volume containing a file or directory
4
5 =head1 SYNOPSIS
6
7 fs setquota [B<-path> I<dir/file path>]  B<-max> I<max quota in kbytes>  [B<-help>]
8
9 fs setq [B<-p> I<dir/file path>]  B<-m> I<max quota in kbytes>  [B<-h>]
10
11 fs sq [B<-p> I<dir/file path>]  B<-m> I<max quota in kbytes>  [B<-h>]
12
13 =head1 DESCRIPTION
14
15 The C<fs setquota> command sets the quota (maximum possible size) of the
16 read/write volume that contains the directory or file named by the
17 B<-path> argument.
18
19 To set the quota on multiple volumes at the same time, use the C<fs
20 setvol> command.
21
22 To display a volume's quota, use the C<fs examine>, C<fs listquota> or C<fs
23 quota> command.
24
25 =head1 OPTIONS
26
27 =over 4
28
29 =item B<-path> I<dir/file path>
30
31 Names the directory or file for which to set the host volume's
32 quota. Partial pathnames are interpreted relative to the
33 current working directory, which is also the default value if
34 this argument is omitted.
35
36 Specify the read/write path to the file or directory, to avoid
37 the failure that results from attempting to change a read-only
38 volume. By convention, the read/write path is indicated by
39 placing a period before the cell name at the pathname's second
40 level (for example, B</afs/.abc.com>). For further discussion of
41 the concept of read/write and read-only paths through the
42 filespace, see the L<fs_mkmount(1)> reference page.
43
44 =item B<-max> I<max quota in kbytes>
45
46 Sets the maximum amount of file server disk space the volume
47 can occupy. Specify the number of one-kilobyte blocks as a
48 positive integer (B<1024> is one megabyte). A value of B<0> sets an
49 unlimited quota, but the size of the disk partition that houses
50 the volume places an absolute limit on the volume's size.
51
52 If the B<-path> argument is omitted (to set the quota of the
53 volume housing the current working directory), the B<-max> switch
54 must be included with this argument.
55
56 =item B<-help>
57
58 Prints the online help for this command. All other valid
59 options are ignored.
60
61 =back
62
63 =head1 EXAMPLES
64
65 The following command imposes a maximum quota of 3000 kilobytes on the
66 volume that houses the B</afs/abc.com/usr/smith> directory:
67
68     fs setquota -path /afs/abc.com/usr/smith -max 3000
69
70 =head1 PRIVILEGE REQUIRED
71
72 The issuer must belong to the B<system:administrators> group.
73
74 =head1 COPYRIGHT
75
76 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
77
78 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
79 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
80 Stanford Linear Accelerator Center, a department of Stanford University.
81
82 =head1 SEE ALSO
83
84 L<fs_examine(1)>,
85 L<fs_listquota(1)>,
86 L<fs_quota(1)>,
87 L<fs_mkmount(1)>,
88 L<fs_setvol(1)>
89
90 =cut