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