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