src/man/kas_help.1

   1 kas help                   AFS Commands                kas help
   2
   3
   4 NAME
   5
   6    kas help -- show syntax of specified kas command(s) or list
   7
   8                        functional description for all of them.
   9
  10
  11                                  +
  12    kas help [-topic <help string> ]  [-help]
  13
  14 ACCEPTABLE ABBREVIATIONS/ALIASES
  15
  16                            +
  17    kas h  [-t <help string> ]  [-h]
  18
  19 DESCRIPTION
  20
  21    Displays the first line  (name  and  short  description)  of
  22    every  kas  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
  30          specifies the operation code(s) for which syntax is to
  31          be provided.  If  the  issuer  omits  it,  the  output
  32          instead  provides  a  short  description  of  all  kas
  33          commands.
  34
  35    -help prints the online help  for  this  command.    Do  not
  36          provide  any  other  arguments or flags with this one.
  37          See section 4.3  in  the  Reference  Manual  for  more
  38          details.
  39
  40 OUTPUT
  41
  42    The  online  help entry for each kas command consists of two
  43    or three lines:
  44
  45       - The first  line  names  the  command  and  briefly
  46         describes what it does
  47
  48       - If  the  command  has aliases, they will appear on
  49         the next line
  50
  51       - The final line, which begins with "Usage:",  lists
  52         the   command's   arguments   and   flags  in  the
  53         prescribed order.  Online  help  entries  use  the
  54         same  symbols  (brackets,  etc.)  as  the  command
  55         definitions in this manual.  For an explanation of
  56         their  meaning,  see  page  v  of the introductory
  57         About This Manual chapter.
  58
  59
  60
  61 EXAMPLE
  62
  63    The  following  displays  the  online  help  entry  for  the
  64    kas setpassword command.
  65
  66        % kas help setpassword
  67        kas setpassword: set a user's password
  68        aliases: sp
  69        Usage: kas setpassword -name <name of user> [-new_passwo
  70        <new password>] [-kvno <key version number>]
  71        [-admin_username <admin principal to use for authenticat
  72        [-password_for_admin <password>] [-cell <cell name>]
  73                                                           +
  74        [-servers <explicit list of authentication servers> ] [-
  75
  76 PRIVILEGE REQUIRED
  77
  78    None.  No password will be prompted for.
  79
  80 MORE INFORMATION
  81
  82    kas apropos