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