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