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