src/man/vos_help.1

   1 vos help                   AFS Commands                vos help
   2
   3
   4 NAME
   5
   6    vos help -- show syntax of specified vos command(s) or list
   7
   8                        functional description for all of them.
   9
  10
  11                                   +
  12    vos help  [-topic <help string> ]  [-help]
  13
  14 ACCEPTABLE ABBREVIATIONS/ALIASES
  15
  16                            +
  17    vos h  [-t <help string> ]  [-h]
  18
  19 DESCRIPTION
  20
  21    Displays the first line  (name  and  short  description)  of
  22    every  vos  command's  help  entry,  if  no  help  string is
  23    provided.  For each operation code specified with -topic, it
  24    outputs  the  entire  help  entry.    See the Output section
  25    below.
  26
  27 ARGUMENTS
  28
  29    -topic          specifies the operation  code(s)  for  which
  30                    syntax is to be provided.  If it is omitted,
  31                    the  output   instead   provides   a   short
  32                    description of all vos commands.
  33
  34    -help           prints the online help for this command.  Do
  35                    not provide any  other  arguments  or  flags
  36                    with  this  one.    See  section  8.3 in the
  37                    Reference Manual for more details.
  38
  39 OUTPUT
  40
  41    The online help entry for each vos command consists  of  two
  42    or three lines:
  43
  44       - The  first  line  names  the  command  and briefly
  45         describes what it does.
  46
  47       - If the command has aliases, they  will  appear  on
  48         the next line.
  49
  50       - The  final line, which begins with "Usage:", lists
  51         the  command's  arguments   and   flags   in   the
  52         prescribed  order.    Online  help entries use the
  53         same  symbols  (brackets,  etc.)  as  the  command
  54         definitions in this manual.  For an explanation of
  55         their meaning, see  page  v  of  the  introductory
  56         About This Manual chapter.
  57
  58
  59
  60 EXAMPLE
  61
  62    The  following  displays  the  online  help  entry  for  the
  63    vos create command.
  64
  65        %vos help create
  66        vos create: create a new volume
  67        Usage: vos create -server <machine name> -partition
  68        <partition name> -name <volume name> [-cell <cell name>]
  69        [-noauth] [-localauth] [-verbose] [-help]
  70
  71 PRIVILEGE REQUIRED
  72
  73    None.
  74
  75 MORE INFORMATION
  76
  77    vos apropos