src/man/fs.1

   1                            AFS Commands
   2
   3    1. The fs Commands
   4
   5    ------------------------------------------------------------
   6
   7    This  command  defines the fs commands that users and system
   8    administrators employ to contact  the  File  Server  and  to
   9    configure  the  Cache  Manager.    It  assumes the reader is
  10    familiar with the  concepts  described  in  the  AFS  System
  11    Administrator's Guide.
  12
  13    Some  fs  commands  extend  UNIX  file  system  semantics by
  14    invoking file-related functions that UNIX does  not  provide
  15    (setting  access  control  lists,  for  example).   Other fs
  16    commands help users control the  performance  of  the  Cache
  17    Manager  running  on  their  local client workstation.  When
  18    using fs commands, pay particular attention to the  kind  of
  19    privilege required, as it varies from command to command.
  20
  21    Refer to the Command Summary at the end of this document for
  22    a complete list of fs commands and their syntax.
  23
  24    1.1 Common Arguments and Flags
  25    All fs commands accept the following optional flag.   It  is
  26    listed  in  the  command  descriptions  and  is described in
  27    detail here:
  28
  29    [-help]
  30
  31    This flag has the same function as the fs help command:   It
  32    prints  a  command's  online help message on the screen.  No
  33    other arguments or flags should be provided at the same time
  34    as  this  flag.   If they are, this flag overrides them, and
  35    the only effect of issuing the  command  is  that  the  help
  36    message appears.
  37    AFS Command Reference Manual              The fs Commands  2
  38
  39
  40    1.2 The Privileges Required for fs Commands
  41    The privileges required for fs commands vary more than those
  42    required  for  commands  in  other  suites.    Pay   special
  43    attention  to the PRIVILEGE REQUIRED section of each command
  44    description.
  45
  46    The various types of necessary privilege include
  47
  48
  49       - Having certain  rights  on  a  directory's  access
  50         control  list.  For example, creating and removing
  51         mount  points  requires  ADMINISTER,  INSERT,  and
  52         DELETE rights for the directory in which the mount
  53         point  resides.    Setting  a  directory's  access
  54         control list requires certain rights, too.
  55
  56       - Being  logged  in  as the super-user "root" in the
  57         UNIX file system  of  the  machine  on  which  the
  58         command  is  being issued.  This is necessary when
  59         issuing  commands  that   affect   Cache   Manager
  60         configuration.
  61
  62       - Belonging  to  the  system:administrators group in
  63         the  Protection  Database.    See  the   fs setvol
  64         command for an example.
  65
  66       - No  privilege.    Many  fs  commands  simply  list
  67         information and so  do  not  require  any  special
  68         privilege.