doc/man-pages/pod8/uss_help.pod

   1 =head1 NAME
   2
   3 uss_help - Displays help for uss commands (deprecated)
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<uss help> S<<< [B<-topic> <I<help string>>+] >>> [B<-help>]
  11
  12 B<uss h> S<<< [B<-t> <I<help string>>+] >>> [B<-h>]
  13
  14 =for html
  15 </div>
  16
  17 =head1 CAUTIONS
  18
  19 The B<uss> command suite is currently designed for cells using the
  20 obsolete Authentication Server, and therefore is primarily useful for
  21 sites that have not yet migrated to a Kerberos version 5 KDC. The
  22 Authentication Server and supporting commands will be removed in a future
  23 version of OpenAFS, which may include B<uss> unless someone who finds it
  24 useful converts it to work with a Kerberos version 5 KDC.
  25
  26 =head1 DESCRIPTION
  27
  28 The B<uss help> command displays the complete online help entry (short
  29 description and syntax statement) for each command operation code
  30 specified by the B<-topic> argument. If the B<-topic> argument is omitted,
  31 the output includes the first line (name and short description) of the
  32 online help entry for every B<uss> command.
  33
  34 To list every uss command whose name or short description includes a
  35 specified keyword, use the B<uss apropos> command.
  36
  37 =head1 OPTIONS
  38
  39 =over 4
  40
  41 =item B<-topic> <I<help string>>+
  42
  43 Indicates each command for which to display the complete online help
  44 entry. Omit the B<uss> part of the command name, providing only the
  45 operation code (for example, specify B<bulk>, not B<uss bulk>). If this
  46 argument is omitted, the output briefly describes every B<uss> command.
  47
  48 =item B<-help>
  49
  50 Prints the online help for this command. All other valid options are
  51 ignored.
  52
  53 =back
  54
  55 =head1 OUTPUT
  56
  57 The online help entry for each uss command consists of the following two
  58 or three lines:
  59
  60 =over 4
  61
  62 =item *
  63
  64 The first line names the command and briefly describes its function.
  65
  66 =item *
  67
  68 The second line lists aliases for the command, if any.
  69
  70 =item *
  71
  72 The final line, which begins with the string C<Usage>, lists the command's
  73 options in the prescribed order. Online help entries use the same symbols
  74 (for example, brackets) as the reference pages in this document.
  75
  76 =back
  77
  78 =head1 EXAMPLES
  79
  80 The following command displays the online help entry for the B<uss bulk>
  81 command:
  82
  83    % uss help bulk
  84    uss bulk: bulk input mode
  85    Usage: uss bulk -file <bulk input file> [-template <pathname
  86    of template file>] [-verbose] [-cell <cell name>] [-admin
  87    <administrator to authenticate>] [-dryrun] [-skipauth] [-overwrite]
  88    [-pwexpires <password expires in [0..254] days (0 => never)>] [-pipe]
  89    [-help]
  90
  91 =head1 PRIVILEGE REQUIRED
  92
  93 None
  94
  95 =head1 SEE ALSO
  96
  97 L<uss(8)>,
  98 L<uss_apropos(8)>
  99
 100 =head1 COPYRIGHT
 101
 102 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 103
 104 This documentation is covered by the IBM Public License Version 1.0.  It was
 105 converted from HTML to POD by software written by Chas Williams and Russ
 106 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.