fix-fs-error-string-printing-20010623
[openafs.git] / doc / html / AdminReference / auarf173.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="auarf172.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="auarf174.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="HDRFSTRACE_HELP" HREF="auarf002.htm#ToC_187">fstrace help</A></H2>
19 <P><STRONG>Purpose</STRONG>
20 <A NAME="IDX5033"></A>
21 <A NAME="IDX5034"></A>
22 <A NAME="IDX5035"></A>
23 <P>Displays the syntax of specified <B>fstrace</B> commands or lists
24 functional descriptions of all <B>fstrace</B> commands
25 <P><STRONG>Synopsis</STRONG>
26 <PRE><B>fstrace help</B> [<B>-topic</B> &lt;<VAR>help string</VAR>><SUP>+</SUP>]  [<B>-help</B>] 
27     
28 <B>fstrace h</B> [<B>-t</B> &lt;<VAR>help string</VAR>><SUP>+</SUP>]  [<B>-h</B>] 
29 </PRE>
30 <P><STRONG>Description</STRONG>
31 <P>The <B>fstrace help</B> command displays the complete online help entry
32 (short description and syntax statement) for each command operation code
33 specified by the <B>-topic</B> argument. If the <B>-topic</B>
34 argument is omitted, the output includes the first line (name and short
35 description) of the online help entry for every <B>fstrace</B>
36 command.
37 <P>To list every <B>fstrace</B> command whose name or short description
38 includes a specified keyword, use the <B>fstrace apropos</B>
39 command.
40 <P><STRONG>Options</STRONG>
41 <DL>
42 <P><DT><B>-topic
43 </B><DD>Indicates each command for which to display the complete online help
44 entry. Omit the <B>fstrace</B> part of the command name, providing
45 only the operation code (for example, specify <B>clear</B>, not
46 <B>fstrace clear</B>). If this argument is omitted, the output
47 briefly describes every <B>fstrace</B> command.
48 <P><DT><B>-help
49 </B><DD>Prints the online help for this command. All other valid options
50 are ignored.
51 </DL>
52 <P><STRONG>Output</STRONG>
53 <P>The online help entry for each <B>fstrace</B> command consists of two
54 or three lines:
55 <UL>
56 <P><LI>The first line names the command and briefly describes its
57 function.
58 <P><LI>The second line lists aliases for the command, if any.
59 <P><LI>The final line, which begins with the string <TT>Usage</TT>, lists the
60 command's options in the prescribed order. Online help entries use
61 the same symbols (for example, brackets) as the reference pages in this
62 document.
63 </UL>
64 <P><STRONG>Examples</STRONG>
65 <P>The following command displays the online help entry for the <B>fstrace
66 setset</B> command:
67 <PRE>   %<B> fstrace help -topic setset</B>
68    fstrace setset: set state of event sets 
69    Usage: fstrace setset [-set &lt;set_name><SUP>+</SUP>] [-active] [-inactive]  
70    [-dormant] [-help] 
71    
72 </PRE>
73 <P><STRONG>Privilege Required</STRONG>
74 <P>None
75 <P><STRONG>Related Information</STRONG>
76 <P><A HREF="auarf169.htm#HDRFSTRACE_INTRO">fstrace</A>
77 <P><A HREF="auarf170.htm#HDRFSTRACE_APROPOS">fstrace apropos</A>
78 <P>
79 <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="auarf172.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="auarf174.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> 
80 <!-- Begin Footer Records  ========================================== -->
81 <P><HR><B> 
82 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
83 </B> 
84 <!-- End Footer Records  ============================================ -->
85 <A NAME="Bot_Of_Page"></A>
86 </BODY></HTML>