doc/man-pages/pod8/bos_help.pod

   1 =head1 NAME
   2
   3 bos_help - Displays help for bos commands
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<bos help> S<<< [B<-topic> <I<help string>>+] >>> [B<-help>]
  11
  12 B<bos h> S<<< [B<-t> <I<help string>>+] >>> [B<-h>]
  13
  14 =for html
  15 </div>
  16
  17 =head1 DESCRIPTION
  18
  19 The B<bos help> command displays the complete online help entry (short
  20 description and syntax statement) for each command operation code
  21 specified by the B<-topic> argument. If the B<-topic> argument is omitted,
  22 the output includes the first line (name and short description) of the
  23 online help entry for every B<bos> command.
  24
  25 To list every bos command whose name or short description includes a
  26 specified keyword, use the B<bos apropos> command.
  27
  28 =head1 OPTIONS
  29
  30 =over 4
  31
  32 =item B<-topic> <I<help string>>+
  33
  34 Indicates each command for which to display the complete online help
  35 entry. Omit the B<bos> part of the command name, providing only the
  36 operation code (for example, specify B<status>, not B<bos status>). If
  37 this argument is omitted, the output briefly describes every B<bos>
  38 command.
  39
  40 =item B<-help>
  41
  42 Prints the online help for this command. All other valid options are
  43 ignored.
  44
  45 =back
  46
  47 =head1 OUTPUT
  48
  49 The online help entry for each bos command consists of the following two
  50 or three lines:
  51
  52 =over 4
  53
  54 =item *
  55
  56 The first line names the command and briefly describes its function.
  57
  58 =item *
  59
  60 The second line lists aliases for the command, if any.
  61
  62 =item *
  63
  64 The final line, which begins with the string C<Usage>, lists the command's
  65 options in the prescribed order. Online help entries use the same symbols
  66 (for example, brackets) as the reference pages in this document.
  67
  68 =back
  69
  70 =head1 EXAMPLES
  71
  72 The following command displays the online help entry for the B<bos status>
  73 command:
  74
  75    % bos help status
  76    bos status: show server instance status
  77    Usage: bos status -server <machine name> [-instance <server
  78    process name>+] [-long] [-cell <cell name>] [-noauth]
  79    [-localauth] [-help]
  80
  81 =head1 PRIVILEGE REQUIRED
  82
  83 None
  84
  85 =head1 SEE ALSO
  86
  87 L<bos(8)>,
  88 L<bos_apropos(8)>
  89
  90 =head1 COPYRIGHT
  91
  92 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
  93
  94 This documentation is covered by the IBM Public License Version 1.0.  It was
  95 converted from HTML to POD by software written by Chas Williams and Russ
  96 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.