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