doc/man-pages/pod/bos_apropos.pod

   1 =head1 NAME
   2
   3 bos apropos - Displays each help entry containing a keyword string
   4
   5 =head1 SYNOPSIS
   6
   7 bos apropos B<-topic> I<help string>  [B<-help>]
   8
   9 bos ap B<-t> I<help string>  [B<-h>]
  10
  11 =head1 DESCRIPTION
  12
  13 The C<bos apropos> command displays the first line of the online help
  14 entry for any C<bos> command that has in its name or short description
  15 the string specified by the B<-topic> argument.
  16
  17 To display the syntax for a command, use the C<bos help> command.
  18
  19 =head1 OPTIONS
  20
  21 =over 4
  22
  23 =item B<-topic> I<help string>
  24
  25 Specifies the keyword string to match, in lowercase letters
  26 only. If the string is more than a single word, surround it
  27 with double quotes ("") or other delimiters.
  28
  29 =item B<-help>
  30
  31 Prints the online help for this command. All other valid
  32 options are ignored.
  33
  34 =back
  35
  36 =head1 OUTPUT
  37
  38 The first line of a command's online help entry names it and briefly
  39 describes its function. This command displays the first line for any
  40 C<bos> command where the string specified with the B<-topic> argument is
  41 part of the command name or first line.
  42
  43 =head1 EXAMPLES
  44
  45 The following command lists all C<bos> commands that include the word
  46 B<restart> in their names or short descriptions:
  47
  48     bos apropos restart
  49    getrestart: get restart times
  50    restart: restart all processes
  51    setrestart: set restart times
  52
  53 =head1 PRIVILEGE REQUIRED
  54
  55 None
  56
  57 =head1 COPYRIGHT
  58
  59 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
  60
  61 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
  62 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
  63 Stanford Linear Accelerator Center, a department of Stanford University.
  64
  65 =head1 SEE ALSO
  66
  67 L<bos(1)>,
  68 L<bos_help(1)>
  69
  70 =cut