doc/man-pages/pod/fs.pod

   1 =head1 NAME
   2
   3 fs - Introduction to the C<fs> command suite
   4
   5 =head1 DESCRIPTION
   6
   7 The commands in the C<fs> command suite constitute the main
   8 administrative interface to the Cache Manager on an AFS client
   9 machine, which is responsible for fetching AFS data from file server
  10 machines on behalf of applications running on the client machine.
  11
  12 There are several categories of commands in the C<fs> command suite:
  13
  14 =over
  15
  16 =item *
  17
  18 Commands to set and report how the Cache Manager interacts with
  19 server machines: C<fs checkservers>, C<fs getcellstatus>, C<fs
  20 getserverprefs>, C<fs listcells>, C<fs newcell>, C<fs setcell>,
  21 C<fs setserverprefs>, C<fs sysname>, and C<fs wscell>
  22
  23 =item *
  24
  25 Commands to administer access control lists (ACLs): C<fs cleanacl>,
  26 C<fs copyacl>, C<fs listacl>, and C<fs setacl>
  27
  28 =item *
  29
  30 Commands to administer server machines, volumes or partitions that
  31 house a given file or directory: C<fs diskfree>, C<fs examine>, C<fs
  32 listquota>, C<fs quota>, C<fs setquota>, C<fs setvol>,
  33 C<fs whereis>, and C<fs whichcell>
  34
  35 =item *
  36
  37 Commands to administer the local client cache and related
  38 information: C<fs checkvolumes>, C<fs flush>, C<fs flushvolume>, C<fs
  39 getcacheparms>, and C<fs setcachesize>
  40
  41 =item *
  42
  43 Commands to administer volume mount points: C<fs lsmount>, C<fs
  44 mkmount>, and C<fs rmmount>
  45
  46 =item *
  47
  48 Commands to control monitoring and tracing: C<fs debug>, and C<fs
  49 messages>
  50
  51 =item *
  52
  53 A command to administer the Cache Manager's interaction with other
  54 file systems: C<fs exportafs>
  55
  56 =item *
  57
  58 Commands to obtain help: C<fs apropos> and C<fs help>
  59
  60 =back
  61
  62 The Cache Manager and the C<fs> commands use and maintain the following
  63 configuration files:
  64
  65 =over
  66
  67 =item *
  68
  69 The B</usr/vice/etc/CellServDB> file lists the database server
  70 machines in the local cell and any foreign cell to which the
  71 administrator wishes to enable AFS access for users working on the
  72 machine. The database server machines run the Authentication,
  73 Backup, Protection and Volume Location (VL) Server processes,
  74 which maintain databases of administrative information. For users
  75 to access a cell, its B<root.cell> volume must also be mounted in the
  76 local cell's AFS file tree.
  77
  78 =item *
  79
  80 The B</usr/vice/etc/ThisCell> file defines the machine's cell
  81 membership with respect to the AFS command suites and Cache
  82 Manager access to AFS data.
  83
  84 =item *
  85
  86 The B</usr/vice/etc/cacheinfo> file defines configuration parameters
  87 for the cache, including its size and whether it is in memory or
  88 on disk.
  89
  90 =back
  91
  92 In addition, the Cache Manager automatically creates files on the
  93 cache partition (by default, B</usr/vice/cache> for caching and tracking
  94 files fetched from file server machines.
  95
  96 For more details, see the reference page for each file.
  97
  98 =head1 OPTIONS
  99
 100 The following flag is available on every command in the C<fs> suite. The
 101 reference page for each command also lists it, but it is described
 102 here in greater detail.
 103
 104 =over 4
 105
 106 =item B<-help>
 107
 108 Prints a command's online help message on the standard output
 109 stream. Do not combine this flag with any of the command's
 110 other options; when it is provided, the command interpreter
 111 ignores all other options, and only prints the help message.
 112
 113 =back
 114
 115 =head1 PRIVILEGE REQUIRED
 116
 117 The privileges required for C<fs> commands vary more than for other
 118 command suites. Pay special attention to the C<PRIVILEGE REQUIRED>
 119 section of each command description.
 120
 121 The various types of necessary privilege include:
 122
 123 =over
 124
 125 =item *
 126
 127 Having permissions on a directory's ACL. For example, creating and
 128 removing mount points requires B<a> (B<administer>), B<i> (B<insert>), and B<d>
 129 (B<delete>) permissions on the ACL of the directory in which the
 130 mount point resides.
 131
 132 =item *
 133
 134 Being logged onto the machine as the local superuser B<root>. This is
 135 necessary when issuing commands that affect Cache Manager
 136 configuration.
 137
 138 =item *
 139
 140 Belonging to the B<system:administrators> group in the Protection
 141 Database.
 142
 143 =item *
 144
 145 No privilege. Many C<fs> commands simply list information.
 146
 147 =back
 148
 149 =head1 COPYRIGHT
 150
 151 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 152
 153 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
 154 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
 155 Stanford Linear Accelerator Center, a department of Stanford University.
 156
 157 =head1 SEE ALSO
 158
 159 L<CacheItems(1)>,
 160 L<CellServDB_client_version(1)>,
 161 L<ThisCell_client_version(1)>,
 162 L<Vn(1)>,
 163 L<VolumeItems(1)>,
 164 L<cacheinfo(1)>,
 165 L<fs_apropos(1)>,
 166 L<fs_checkservers(1)>,
 167 L<fs_checkvolumes(1)>,
 168 L<fs_cleanacl(1)>,
 169 L<fs_copyacl(1)>,
 170 L<fs_diskfree(1)>,
 171 L<fs_examine(1)>,
 172 L<fs_exportafs(1)>,
 173 L<fs_flush(1)>,
 174 L<fs_flushmount(1)>,
 175 L<fs_flushvolume(1)>,
 176 L<fs_getcacheparms(1)>,
 177 L<fs_getcellstatus(1)>,
 178 L<fs_getclientaddrs(1)>,
 179 L<fs_getserverprefs(1)>,
 180 L<fs_help(1)>,
 181 L<fs_listacl(1)>,
 182 L<fs_listcells(1)>,
 183 L<fs_listquota(1)>,
 184 L<fs_lsmount(1)>,
 185 L<fs_messages(1)>,
 186 L<fs_mkmount(1)>,
 187 L<fs_newcell(1)>,
 188 L<fs_quota(1)>,
 189 L<fs_rmmount(1)>,
 190 L<fs_setacl(1)>,
 191 L<fs_setcachesize(1)>,
 192 L<fs_setcell(1)>,
 193 L<fs_setclientaddrs(1)>,
 194 L<fs_setquota(1)>,
 195 L<fs_setserverprefs(1)>,
 196 L<fs_setvol(1)>,
 197 L<fs_storebehind(1)>,
 198 L<fs_sysname(1)>,
 199 L<fs_whereis(1)>,
 200 L<fs_whichcell(1)>,
 201 L<fs_wscell(1)>
 202
 203 =cut