mirror of
https://git.openafs.org/openafs.git
synced 2025-01-31 21:47:45 +00:00
92 lines
3.4 KiB
XML
92 lines
3.4 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<refentry id="fs_apropos1">
|
|
<refmeta>
|
|
<refentrytitle>fs apropos</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>fs apropos</refname>
|
|
<refpurpose>Displays each help entry containing a keyword string</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Synopsis</title>
|
|
<para><emphasis role="bold">fs apropos</emphasis> <emphasis role="bold">-topic</emphasis> <<emphasis>help string</emphasis>> [<emphasis role="bold">-help</emphasis>]</para>
|
|
|
|
<para><emphasis role="bold">fs 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">fs apropos</emphasis> command displays the first line of the online help entry
|
|
for any <emphasis role="bold">fs</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">fs 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, in lowercase letters only. 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">fs</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 fs commands that include the word <computeroutput>cache</computeroutput>
|
|
in their names or short online descriptions:</para>
|
|
|
|
<programlisting>
|
|
% fs apropos cache
|
|
setcachesize: set cache size
|
|
flush: flush file from cache
|
|
getcacheparms: get cache usage info
|
|
monitor: set cache monitor host address
|
|
|
|
</programlisting>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Privilege Required</title>
|
|
<para>None</para>
|
|
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>See Also</title>
|
|
<para><link linkend="fs1">fs(1)</link>,
|
|
<link linkend="fs_help1">fs_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>
|