doc/html/AdminReference/auarf205.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="auarf204.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="auarf206.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_APROPOS" HREF="auarf002.htm#ToC_219">package apropos</A></H2>
  19 <A NAME="IDX5204"></A>
  20 <A NAME="IDX5205"></A>
  21 <A NAME="IDX5206"></A>
  22 <P><STRONG>Purpose</STRONG>
  23 <P>Displays each help entry containing a keyword string
  24 <P><STRONG>Synopsis</STRONG>
  25 <PRE><B>package apropos</B> [<B>-topic</B> &lt;<VAR>help&nbsp;string</VAR>>]  [<B>-help</B>]
  26
  27 <B>package a</B> [<B>-t</B> &lt;<VAR>help&nbsp;string</VAR>>]  [<B>-h</B>]
  28 </PRE>
  29 <P><STRONG>Description</STRONG>
  30 <P>The <B>package apropos</B> command displays the first line of the
  31 online help entry for any <B>package</B> command that has in its name or
  32 short description the string specified by the <B>-topic</B>
  33 argument.
  34 <P>To display the syntax for a command, use the <B>package help</B>
  35 command.
  36 <P><STRONG>Options</STRONG>
  37 <DL>
  38 <P><DT><B>-topic
  39 </B><DD>Specifies the keyword string to match, in lowercase letters only.
  40 If the string is more than a single word, surround it with double quotes ("")
  41 or other delimiters.
  42 <P><DT><B>-help
  43 </B><DD>Prints the online help for this command. All other valid options
  44 are ignored.
  45 </DL>
  46 <P><STRONG>Output</STRONG>
  47 <P>The first line of a command's online help entry names it and briefly
  48 describes its function. This command displays the first line for any
  49 <B>package</B> command where the string specified with the
  50 <B>-topic</B> argument is part of the command name or first line.
  51 <P><STRONG>Examples</STRONG>
  52 <P>The following command lists all <B>package</B> commands that include
  53 the word <B>help</B> in their names or short descriptions:
  54 <PRE>   % <B>package apropos help</B>
  55    apropos: search by help text
  56    help: get help on commands
  57
  58 </PRE>
  59 <P><STRONG>Privilege Required</STRONG>
  60 <P>None
  61 <P><STRONG>Related Information</STRONG>
  62 <P><A HREF="auarf204.htm#HDRPACKAGE">package</A>
  63 <P><A HREF="auarf206.htm#HDRPACKAGE_HELP">package help</A>
  64 <P>
  65 <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="auarf204.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="auarf206.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>
  66 <!-- Begin Footer Records  ========================================== -->
  67 <P><HR><B>
  68 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
  69 </B>
  70 <!-- End Footer Records  ============================================ -->
  71 <A NAME="Bot_Of_Page"></A>
  72 </BODY></HTML>