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