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