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