xml-docbook-documentation-first-pass-20060915

[openafs.git] / doc / xml / AdminReference / sect8 / fstrace_apropos.xml

diff --git a/doc/xml/AdminReference/sect8/fstrace_apropos.xml b/doc/xml/AdminReference/sect8/fstrace_apropos.xml
new file mode 100644 (file)
index 0000000..e288520
--- /dev/null
+++ b/doc/xml/AdminReference/sect8/fstrace_apropos.xml
@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<refentry id="fstrace_apropos8">
+  <refmeta>
+    <refentrytitle>fstrace apropos</refentrytitle>
+    <manvolnum>8</manvolnum>
+  </refmeta>
+  <refnamediv>
+    <refname>fstrace apropos</refname>
+    <refpurpose>Displays each help entry containing a keyword string</refpurpose>
+  </refnamediv>
+  <refsect1>
+    <title>Synopsis</title>
+    <para><emphasis role="bold">fstrace apropos</emphasis> <emphasis role="bold">-topic</emphasis> &lt;<emphasis>help string</emphasis>&gt; [<emphasis role="bold">-help</emphasis>]</para>
+
+    <para><emphasis role="bold">fstrace ap</emphasis> <emphasis role="bold">-t</emphasis> &lt;<emphasis>help string</emphasis>&gt; [<emphasis role="bold">-h</emphasis>]</para>
+
+  </refsect1>
+  <refsect1>
+    <title>Description</title>
+    <para>The <emphasis role="bold">fstrace apropos</emphasis> command displays the first line of the online help
+    entry for any <emphasis role="bold">fstrace</emphasis> command that contains in its name or short
+    description the string specified with the <emphasis role="bold">-topic</emphasis> argument.</para>
+
+    <para>To display a command's complete syntax, use the <emphasis role="bold">fstrace help</emphasis> command.</para>
+
+  </refsect1>
+  <refsect1>
+    <title>Options</title>
+    <variablelist>
+      <varlistentry>
+        <term><emphasis role="bold">-topic</emphasis> &lt;<emphasis>help string</emphasis>&gt;</term>
+        <listitem>
+          <para>Specifies the keyword string to match, in lowercase letters only.  If the
+          string is more than a single word, surround it with double quotes (<computeroutput>""</computeroutput>)
+          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">fstrace</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 lists all <emphasis role="bold">fstrace</emphasis> commands that include the word
+    <computeroutput>set</computeroutput> in their names or short descriptions:</para>
+
+<programlisting>
+   % fstrace apropos set
+   clear: clear logs by logname or by event set
+   lsset: list available event sets
+   setlog: set the size of a log
+   setset: set state of event sets
+
+</programlisting>
+    </refsect1>
+    <refsect1>
+      <title>Privilege Required</title>
+      <para>None</para>
+
+    </refsect1>
+    <refsect1>
+      <title>See Also</title>
+      <para><link linkend="fstrace8">fstrace(8)</link>,
+      <link linkend="fstrace_help8">fstrace_help(8)</link></para>
+
+    </refsect1>
+    <refsect1>
+      <title>Copyright</title>
+      <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; 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>