doc/xml/AdminReference/sect8/bos_apropos.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="bos_apropos8">
   3   <refmeta>
   4     <refentrytitle>bos apropos</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>bos apropos</refname>
   9     <refpurpose>Displays each help entry containing a keyword string</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">bos apropos</emphasis> <emphasis role="bold">-topic</emphasis> &lt;<emphasis>help string</emphasis>&gt; [<emphasis role="bold">-help</emphasis>]</para>
  14
  15     <para><emphasis role="bold">bos ap</emphasis> <emphasis role="bold">-t</emphasis> &lt;<emphasis>help string</emphasis>&gt; [<emphasis role="bold">-h</emphasis>]</para>
  16
  17   </refsect1>
  18   <refsect1>
  19     <title>Description</title>
  20     <para>The <emphasis role="bold">bos apropos</emphasis> command displays the first line of the online help
  21     entry for any <emphasis role="bold">bos</emphasis> command that has in its name or short description the
  22     string specified by the <emphasis role="bold">-topic</emphasis> argument.</para>
  23
  24     <para>To display the syntax for a command, use the <emphasis role="bold">bos help</emphasis> command.</para>
  25
  26   </refsect1>
  27   <refsect1>
  28     <title>Options</title>
  29     <variablelist>
  30       <varlistentry>
  31         <term><emphasis role="bold">-topic</emphasis> &lt;<emphasis>help string</emphasis>&gt;</term>
  32         <listitem>
  33           <para>Specifies the keyword string to match, in lowercase letters only.  If the
  34           string is more than a single word, surround it with double quotes (<computeroutput>""</computeroutput>)
  35           or other delimiters.</para>
  36
  37         </listitem>
  38       </varlistentry>
  39       <varlistentry>
  40         <term><emphasis role="bold">-help</emphasis></term>
  41         <listitem>
  42           <para>Prints the online help for this command. All other valid options are
  43           ignored.</para>
  44
  45         </listitem>
  46       </varlistentry>
  47     </variablelist>
  48   </refsect1>
  49   <refsect1>
  50     <title>Output</title>
  51     <para>The first line of a command's online help entry names it and briefly
  52     describes its function. This command displays the first line for any
  53     <emphasis role="bold">bos</emphasis> command where the string specified with the <emphasis role="bold">-topic</emphasis> argument is
  54     part of the command name or first line.</para>
  55
  56   </refsect1>
  57   <refsect1>
  58     <title>Examples</title>
  59     <para>The following command lists all <emphasis role="bold">bos</emphasis> commands that include the word
  60     <computeroutput>restart</computeroutput> in their names or short descriptions:</para>
  61
  62 <programlisting>
  63    % bos apropos restart
  64    getrestart: get restart times
  65    restart: restart all processes
  66    setrestart: set restart times
  67
  68 </programlisting>
  69     </refsect1>
  70     <refsect1>
  71       <title>Privilege Required</title>
  72       <para>None</para>
  73
  74     </refsect1>
  75     <refsect1>
  76       <title>See Also</title>
  77       <para><link linkend="bos8">bos(8)</link>,
  78       <link linkend="bos_help8">bos_help(8)</link></para>
  79
  80     </refsect1>
  81     <refsect1>
  82       <title>Copyright</title>
  83       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
  84
  85       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
  86       converted from HTML to POD by software written by Chas Williams and Russ
  87       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
  88
  89     </refsect1>
  90   </refentry>