man-pages: add fs_getverify and fs_setverify
[openafs.git] / doc / man-pages / pod1 / fs.pod
1 =head1 NAME
2
3 fs - Introduction to the fs command suite
4
5 =head1 DESCRIPTION
6
7 The commands in the B<fs> command suite constitute the main administrative
8 interface to the Cache Manager on an AFS client machine, which is
9 responsible for fetching AFS data from file server machines on behalf of
10 applications running on the client machine.
11
12 There are several categories of commands in the B<fs> command suite:
13
14 =over 4
15
16 =item *
17
18 Commands to set and report how the Cache Manager interacts with server
19 machines:
20 L<B<fs checkservers>|fs_checkservers(1)>,
21 L<B<fs getcellstatus>|fs_getcellstatus(1)>,
22 L<B<fs getcrypt>|fs_getcrypt(1)>,
23 L<B<fs getserverprefs>|fs_getserverprefs(1)>,
24 L<B<fs getverify>|fs_getverify(1)>,
25 L<B<fs listcells>|fs_listcells(1)>,
26 L<B<fs newcell>|fs_newcell(1)>,
27 L<B<fs setcbaddr>|fs_setcbaddr(1)>,
28 L<B<fs setcell>|fs_setcell(1)>,
29 L<B<fs setcrypt>|fs_setcrypt(1)>,
30 L<B<fs setserverprefs>|fs_setserverprefs(1)>,
31 L<B<fs setverify>|fs_setverify(1)>,
32 L<B<fs sysname>|fs_sysname(1)>,
33 L<B<fs uuid>|fs_uuid(1)>,
34 and L<B<fs wscell>|fs_wscell(1)>.
35
36 =item *
37
38 Commands to administer access control lists (ACLs):
39 L<B<fs cleanacl>|fs_cleanacl(1)>,
40 L<B<fs copyacl>|fs_copyacl(1)>,
41 L<B<fs getcalleraccess>|fs_getcalleraccess(1)>,
42 L<B<fs listacl>|fs_listacl(1)>,
43 and L<B<fs setacl>|fs_setacl(1)>.
44
45 =item *
46
47 Commands to administer server machines, volumes or partitions that house a
48 given file or directory:
49 L<B<fs diskfree>|fs_diskfree(1)>,
50 L<B<fs examine>|fs_examine(1)>,
51 L<B<fs getfid>|fs_getfid(1)>,
52 L<B<fs listquota>|fs_listquota(1)>,
53 L<B<fs quota>|fs_quota(1)>,
54 L<B<fs setquota>|fs_setquota(1)>,
55 L<B<fs setvol>|fs_setvol(1)>,
56 L<B<fs whereis>|fs_whereis(1)>,
57 and L<B<fs whichcell>|fs_whichcell(1)>.
58
59 =item *
60
61 Commands to administer the local client cache and related information:
62 L<B<fs checkvolumes>|fs_checkvolumes(1)>,
63 L<B<fs cscpolicy>|fs_cscpolicy(1)>,
64 L<B<fs flush>|fs_flush(1)>,
65 L<B<fs flushall>|fs_flushall(1)>,
66 L<B<fs flushvolume>|fs_flushvolume(1)>,
67 L<B<fs getcacheparms>|fs_getcacheparms(1)>,
68 L<B<fs listaliases>|fs_listaliases(1)>,
69 L<B<fs newalias>|fs_newalias(1)>,
70 and L<B<fs setcachesize>|fs_setcachesize(1)>.
71
72 =item *
73
74 Commands to administer volume mount points:
75 L<B<fs lsmount>|fs_lsmount(1)>,
76 L<B<fs mkmount>|fs_mkmount(1)>,
77 and L<B<fs rmmount>|fs_rmmount(1)>.
78
79 =item *
80
81 Commands to control monitoring and tracing:
82 L<B<fs debug>|fs_debug(1)>,
83 L<B<fs memdump>|fs_memdump(1)>,
84 L<B<fs messages>|fs_messages(1)>,
85 L<B<fs minidump>|fs_minidump(1)>,
86 L<B<fs monitor>|fs_monitor(1)>,
87 L<B<fs rxstatpeer>|fs_rxstatpeer(1)>,
88 L<B<fs rxstatproc>|fs_rxstatproc(1)>,
89 and L<B<fs trace>|fs_trace(1)>.
90
91 =item *
92
93 A command to administer the Cache Manager's interaction with other
94 file systems:
95 L<B<fs exportafs>|fs_exportafs(1)>.
96
97 =item *
98
99 Commands to obtain help:
100 L<B<fs apropos>|fs_apropos(1)>
101 and L<B<fs help>|fs_help(1)>.
102
103 =back
104
105 The Cache Manager and the fs commands use and maintain the following
106 configuration files:
107
108 =over 4
109
110 =item F</usr/vice/etc/CellServDB>
111
112 Lists the database server machines in the local cell and any foreign cell
113 to which the administrator wishes to enable AFS access for users working
114 on the machine. The database server machines run the Authentication,
115 Backup, Protection and Volume Location (VL) Server processes, which
116 maintain databases of administrative information. For users to access a
117 cell, its C<root.cell> volume must also be mounted in the local cell's AFS
118 file tree.
119
120 =item F</usr/vice/etc/ThisCell>
121
122 Defines the machine's cell membership with respect to the AFS command
123 suites and Cache Manager access to AFS data.
124
125 =item F</usr/vice/etc/cacheinfo>
126
127 Defines configuration parameters for the cache, including its size and
128 whether it is in memory or on disk.
129
130 =back
131
132 In addition, the Cache Manager automatically creates files on the cache
133 partition (by default, F</usr/vice/cache> for caching and tracking files
134 fetched from file server machines.
135
136 For more details, see the reference page for each file.
137
138 =head1 OPTIONS
139
140 The following flag is available on every command in the fs suite. The
141 reference page for each command also lists it, but it is described here in
142 greater detail.
143
144 =over 4
145
146 =item B<-help>
147
148 Prints a command's online help message on the standard output stream. Do
149 not combine this flag with any of the command's other options; when it is
150 provided, the command interpreter ignores all other options, and only
151 prints the help message.
152
153 =back
154
155 =head1 PRIVILEGE REQUIRED
156
157 The privileges required for fs commands vary more than for other command
158 suites. Pay special attention to the PRIVILEGE REQUIRED section of each
159 command description.
160
161 The various types of necessary privilege include:
162
163 =over 4
164
165 =item *
166
167 Having permissions on a directory's ACL. For example, creating and
168 removing mount points requires C<a> (administer), C<i> (insert), and C<d>
169 (delete) permissions on the ACL of the directory in which the mount point
170 resides.
171
172 =item *
173
174 Being logged onto the machine as the local superuser C<root>. This is
175 necessary when issuing commands that affect Cache Manager configuration.
176
177 =item *
178
179 Belonging to the system:administrators group in the Protection Database.
180
181 =item *
182
183 No privilege. Many B<fs> commands simply list information.
184
185 =back
186
187 =head1 SEE ALSO
188
189 L<afs_cache(5)>,
190 L<CellServDB(5)>,
191 L<ThisCell(5)>
192 L<cacheinfo(5)>,
193 L<fs_apropos(1)>,
194 L<fs_checkservers(1)>,
195 L<fs_checkvolumes(1)>,
196 L<fs_cleanacl(1)>,
197 L<fs_copyacl(1)>,
198 L<fs_cscpolicy(1)>,
199 L<fs_diskfree(1)>,
200 L<fs_examine(1)>,
201 L<fs_exportafs(1)>,
202 L<fs_flush(1)>,
203 L<fs_flushall(1)>,
204 L<fs_flushmount(1)>,
205 L<fs_flushvolume(1)>,
206 L<fs_getcacheparms(1)>,
207 L<fs_getcalleraccess(1)>,
208 L<fs_getcellstatus(1)>,
209 L<fs_getclientaddrs(1)>,
210 L<fs_getcrypt(1)>,
211 L<fs_getfid(1)>,
212 L<fs_getserverprefs(1)>,
213 L<fs_getverify(1)>,
214 L<fs_help(1)>,
215 L<fs_listacl(1)>,
216 L<fs_listaliases(1)>,
217 L<fs_listcells(1)>,
218 L<fs_listquota(1)>,
219 L<fs_lsmount(1)>,
220 L<fs_memdump(1)>,
221 L<fs_messages(1)>,
222 L<fs_minidump(1)>,
223 L<fs_mkmount(1)>,
224 L<fs_monitor(1)>,
225 L<fs_newalias(1)>,
226 L<fs_newcell(1)>,
227 L<fs_quota(1)>,
228 L<fs_rmmount(1)>,
229 L<fs_rxstatpeer(1)>,
230 L<fs_rxstatproc(1)>,
231 L<fs_setacl(1)>,
232 L<fs_setcachesize(1)>,
233 L<fs_setcbaddr(1)>,
234 L<fs_setcell(1)>,
235 L<fs_setclientaddrs(1)>,
236 L<fs_setcrypt(1)>,
237 L<fs_setquota(1)>,
238 L<fs_setserverprefs(1)>,
239 L<fs_setverify(1)>,
240 L<fs_setvol(1)>,
241 L<fs_storebehind(1)>,
242 L<fs_sysname(1)>,
243 L<fs_trace(1)>,
244 L<fs_whereis(1)>,
245 L<fs_whichcell(1)>,
246 L<fs_wscell(1)>
247
248 =head1 COPYRIGHT
249
250 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
251
252 This documentation is covered by the IBM Public License Version 1.0.  It was
253 converted from HTML to POD by software written by Chas Williams and Russ
254 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.