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