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