doc/man-pages/pod8/uss_apropos.pod

   1 =head1 NAME
   2
   3 uss_apropos - Displays each help entry containing a keyword string (deprecated)
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<uss apropos> S<<< B<-topic> <I<help string>> >>> [B<-help>]
  11
  12 B<uss ap> 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 apropos> command displays the first line of the online help
  29 entry for any B<uss> command that has in its name or short description the
  30 string specified by the B<-topic> argument.
  31
  32 To display the syntax for a command, use the B<uss help> command.
  33
  34 =head1 OPTIONS
  35
  36 =over 4
  37
  38 =item B<-topic> <I<help string>>+
  39
  40 Specifies the keyword string to match, in lowercase letters only.  If the
  41 string is more than a single word, surround it with double quotes (C<"">)
  42 or other delimiters.
  43
  44 =item B<-help>
  45
  46 Prints the online help for this command. All other valid options are
  47 ignored.
  48
  49 =back
  50
  51 =head1 OUTPUT
  52
  53 The first line of a command's online help entry names it and briefly
  54 describes its function. This command displays the first line for any
  55 B<uss> command where the string specified by the B<-topic> argument is
  56 part of the command name or first line.
  57
  58 =head1 EXAMPLES
  59
  60 The following command lists all uss commands that include the word
  61 C<create> in their names or short descriptions:
  62
  63    % uss apropos create
  64    add: create a new user
  65
  66 =head1 PRIVILEGE REQUIRED
  67
  68 None
  69
  70 =head1 SEE ALSO
  71
  72 L<uss(8)>,
  73 L<uss_help(8)>
  74
  75 =head1 COPYRIGHT
  76
  77 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
  78
  79 This documentation is covered by the IBM Public License Version 1.0.  It was
  80 converted from HTML to POD by software written by Chas Williams and Russ
  81 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.