+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>
-<refentry id="vos_apropos1">
- <refmeta>
- <refentrytitle>vos apropos</refentrytitle>
- <manvolnum>1</manvolnum>
- </refmeta>
- <refnamediv>
- <refname>vos apropos</refname>
- <refpurpose>Displays each help entry containing a keyword string</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Synopsis</title>
- <para><emphasis role="bold">vos apropos</emphasis> <emphasis role="bold">-topic</emphasis> <<emphasis>help string</emphasis>> [<emphasis role="bold">-help</emphasis>]</para>
-
- <para><emphasis role="bold">vos ap</emphasis> <emphasis role="bold">-t</emphasis> <<emphasis>help string</emphasis>> [<emphasis role="bold">-h</emphasis>]</para>
-
- </refsect1>
- <refsect1>
- <title>Description</title>
- <para>The <emphasis role="bold">vos apropos</emphasis> command displays the first line of the online help
- entry for any <emphasis role="bold">vos</emphasis> command that has in its name or short description the
- string specified by the <emphasis role="bold">-topic</emphasis> argument.</para>
-
- <para>To display the syntax for a command, use the <emphasis role="bold">vos help</emphasis> command.</para>
-
- </refsect1>
- <refsect1>
- <title>Options</title>
- <variablelist>
- <varlistentry>
- <term><emphasis role="bold">-topic</emphasis> <<emphasis>help string</emphasis>></term>
- <listitem>
- <para>Specifies the keyword string to match. Use lowercase letters only, except
- for the acronym <computeroutput>VLDB</computeroutput>. If the string is more than a single word,
- surround it with double quotes ("") or other delimiters.</para>
-
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><emphasis role="bold">-help</emphasis></term>
- <listitem>
- <para>Prints the online help for this command. All other valid options are
- ignored.</para>
-
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Output</title>
- <para>The first line of a command's online help entry names it and briefly
- describes its function. This command displays the first line for any
- <emphasis role="bold">vos</emphasis> command where the string specified with the <emphasis role="bold">-topic</emphasis> argument is
- part of the command name or first line.</para>
-
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para>The following command displays all vos commands that include the word
- <emphasis role="bold">lock</emphasis> in their names or short descriptions:</para>
-
-<programlisting>
- % vos apropos lock
- lock: lock VLDB entry for a volume
- unlock: release lock on VLDB entry for a volume
- unlockvldb: unlock all the locked entries in the VLDB
-
-</programlisting>
- </refsect1>
- <refsect1>
- <title>Privilege Required</title>
- <para>None</para>
-
- </refsect1>
- <refsect1>
- <title>See Also</title>
- <para><link linkend="vos1">vos(1)</link>,
- <link linkend="vos_help1">vos_help(1)</link></para>
-
- </refsect1>
- <refsect1>
- <title>Copyright</title>
- <para>IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.</para>
-
- <para>This documentation is covered by the IBM Public License Version 1.0. It was
- converted from HTML to POD by software written by Chas Williams and Russ
- Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
-
- </refsect1>
- </refentry>