doc/man-pages/pod8/package_help.pod

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