man-page-conversion-20051208
[openafs.git] / doc / man-pages / pod1 / fs_setvol.pod
1 =head1 NAME
2
3 fs setvol - Set maximum quota and messages for the volume containing a file or
4 directory
5
6 =head1 SYNOPSIS
7
8 B<fs setvol> [B<-path> <I<dir/file path>>+]  [-max <I<disk space quota in 1K units>>]
9 [B<-offlinemsg> <I<offline message>>]  [B<-help>]
10
11 B<fs setv> [B<-p> <I<dir/file path>>+]  [-ma <I<disk space quota in 1K  units>>] 
12 [B<-o> <I<offline message>>]  [B<-h>]
13     
14 B<fs sv> [B<-p> <I<dir/file path>>+]  [-ma <I<disk space quota in 1K units>>] 
15 [B<-o> <I<offline message>>]  [B<-h>]
16
17 =head1 DESCRIPTION
18
19 The fs setvol command sets the quota (maximum possible size) of
20 the read/write volume that contains each directory or file named by the
21 B<-path> argument. To associate a message with the volume which
22 then appears in the output of the B<fs examine> command, include the
23 B<-offlinemsg> argument.
24
25 To display all of the settings made with this command, use the fs
26 examine command. The B<fs listquota> command reports a
27 fileset's quota, and the B<fs quota> command the percent of quota
28 used.
29
30 To set quota on one volume at a time, use the fs setquota
31 command.
32
33 =head1 OPTIONS
34
35 =over 4
36
37 =item -path
38
39 Names each file or directory for which to set the host volume's quota
40 and offline message. Partial pathnames are interpreted relative to the
41 current working directory, which is also the default value if this argument is
42 omitted.
43
44 Specify the read/write path to the file or directory, to avoid the failure
45 that results from attempting to change a read-only volume. By
46 convention, the read/write path is indicated by placing a period before the
47 cell name at the pathname's second level (for example,
48 B</afs/.abc.com>). For further discussion of the
49 concept of read/write and read-only paths through the filespace, see the
50 B<fs mkmount> reference page.
51
52 =item -max
53
54 Sets the maximum amount of file server disk space the volume can
55 occupy. Provide a positive integer to indicate the number of
56 one-kilobyte blocks (B<1024> is one megabyte). A value of
57 B<0> sets an unlimited quota, but the size of the disk partition that
58 houses the volume places an absolute limit on the volume's size.
59
60 If the -path argument is omitted (so that the command sets the
61 quota of the volume housing the current working directory), the
62 B<-max> switch must be provided.
63
64 =item -offlinemsg
65 >
66
67 Associates a message with the volume which then appears in the output of
68 the B<fs examine> command. Its intended use is to explain why
69 the volume is currently offline.
70
71 =item -help
72
73 Prints the online help for this command. All other valid options
74 are ignored.
75
76 =back
77
78 =head1 EXAMPLES
79
80 The following command imposes a 6500 kilobyte quota on the volumes mounted
81 at the home directories B</afs/abc.com/usr/smith> and
82 B</afs/abc.com/usr/pat>:
83
84    % cd /afs/abc.com/usr
85
86    % fs setvol -path smith pat -max 6500B<>
87    
88
89 =head1 PRIVILEGE REQUIRED
90
91 The issuer must belong to the system:administrators
92 group.
93
94 =head1 SEE ALSO
95
96 L<fs_examine(1)>,
97 L<fs_listquota(1)>,
98 L<fs_mkmount(1)>,
99 L<fs_quota(1)>,
100 L<fs_setquota(1)>
101
102 =head1 COPYRIGHT
103
104 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
105
106 This documentation is covered by the IBM Public License Version 1.0.  It was
107 converted from HTML to POD by software written by Chas Williams and Russ
108 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.