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