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