doc/man-pages/pod8/bos_help.pod

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