doc/html/AdminReference/auarf206.htm

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
   2 <HTML><HEAD>
   3 <TITLE>Administration Reference</TITLE>
   4 <!-- Begin Header Records  ========================================== -->
   5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
   6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
   7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
   8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
   9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
  10 </HEAD><BODY>
  11 <!-- (C) IBM Corporation 2000. All Rights Reserved    -->
  12 <BODY bgcolor="ffffff">
  13 <!-- End Header Records  ============================================ -->
  14 <A NAME="Top_Of_Page"></A>
  15 <H1>Administration Reference</H1>
  16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf205.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf207.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
  17 <P>
  18 <H2><A NAME="HDRPACKAGE_HELP" HREF="auarf002.htm#ToC_220">package help</A></H2>
  19 <A NAME="IDX5207"></A>
  20 <A NAME="IDX5208"></A>
  21 <A NAME="IDX5209"></A>
  22 <P><STRONG>Purpose</STRONG>
  23 <P>Displays the syntax of specified <B>package</B> commands or lists
  24 functional descriptions of all <B>package</B> commands
  25 <P><STRONG>Synopsis</STRONG>
  26 <PRE><B>package help</B> [<B>-topic</B> &lt;<VAR>help&nbsp;string</VAR>><SUP>+</SUP>]  [<B>-help</B>]
  27
  28 <B>package h</B> [<B>-t</B> &lt;<VAR>help&nbsp;string</VAR>><SUP>+</SUP>]  [<B>-h</B>]
  29 </PRE>
  30 <P><STRONG>Description</STRONG>
  31 <P>The <B>package help</B> command displays the complete online help entry
  32 (short description and syntax statement) for each command operation code
  33 specified by the <B>-topic</B> argument. If the <B>-topic</B>
  34 argument is omitted, the output includes the first line (name and short
  35 description) of the online help entry for every <B>package</B>
  36 command.
  37 <P>To list every <B>package</B> command whose name or short description
  38 includes a specified keyword, use the <B>package apropos</B>
  39 command.
  40 <P><STRONG>Options</STRONG>
  41 <DL>
  42 <P><DT><B>-topic
  43 </B><DD>Indicates each command for which to display the complete online help
  44 entry. Omit the <B>package</B> part of the command name, providing
  45 only the operation code (for example, specify <B>initcmd</B>, not
  46 <B>package initcmd</B>). If this argument is omitted, the output
  47 briefly describes every <B>package</B> command.
  48 <P><DT><B>-help
  49 </B><DD>Prints the online help for this command. All other valid options
  50 are ignored.
  51 </DL>
  52 <P><STRONG>Output</STRONG>
  53 <P>The online help entry for each <B>package</B> command consists of the
  54 following two or three lines:
  55 <UL>
  56 <P><LI>The first line names the command and briefly describes its
  57 function.
  58 <P><LI>The second line lists aliases for the command, if any.
  59 <P><LI>The final line, which begins with the string <TT>Usage</TT>, lists the
  60 command's options in the prescribed order. Online help entries use
  61 the same symbols (for example, brackets) as the reference pages in this
  62 document.
  63 </UL>
  64 <P><STRONG>Examples</STRONG>
  65 <P>The following command displays the online help entry for the <B>package
  66 initcmd</B> command:
  67 <PRE>   % <B>package help initcmd</B>
  68    package initcmd: initialize the program
  69    Usage: package [initcmd] [-config &lt;base name of configuration file>]
  70    [-fullconfig &lt;full name of configuration file, or stdin for standard input>]
  71    [-overwrite] [-noaction] [-verbose] [-silent] [-rebootfiles]
  72    [-debug] [-help]
  73
  74 </PRE>
  75 <P><STRONG>Privilege Required</STRONG>
  76 <P>None
  77 <P><STRONG>Related Information</STRONG>
  78 <P><A HREF="auarf204.htm#HDRPACKAGE">package</A>
  79 <P><A HREF="auarf205.htm#HDRPACKAGE_APROPOS">package apropos</A>
  80 <P>
  81 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf205.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf207.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
  82 <!-- Begin Footer Records  ========================================== -->
  83 <P><HR><B>
  84 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
  85 </B>
  86 <!-- End Footer Records  ============================================ -->
  87 <A NAME="Bot_Of_Page"></A>
  88 </BODY></HTML>