autoconf-updates-for-ac-check-lib-quoting-20010629
[openafs.git] / doc / html / AdminReference / auarf174.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="auarf173.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="auarf175.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_LSLOG" HREF="auarf002.htm#ToC_188">fstrace lslog</A></H2>
19 <P><STRONG>Purpose</STRONG>
20 <A NAME="IDX5036"></A>
21 <A NAME="IDX5037"></A>
22 <P>Displays information about a log
23 <P><STRONG>Synopsis</STRONG>
24 <PRE><B>fstrace lslog</B> [<B>-set</B> &lt;<VAR>set_name</VAR>><SUP>+</SUP>]  [<B>-log</B> &lt;<VAR>log_name</VAR>>]  [<B>-long</B>]  [<B>-help</B>]
25    
26 <B>fstrace lsl</B> [<B>-s</B> &lt;<VAR>set_name</VAR>><SUP>+</SUP>]  [<B>-log</B> &lt;<VAR>log_name</VAR>>]  [<B>-lon</B>]  [<B>-h</B>] 
27 </PRE>
28 <P><STRONG>Description</STRONG>
29 <P>The <B>fstrace lslog</B> command reports whether the <B>cmfx</B>
30 log is available for use. If the <B>-long</B> argument is included,
31 the output reports the log's defined size, and whether that amount of
32 space is currently allocated in kernel memory or not.
33 <P>To change the <B>cmfx</B> trace log's size, use the <B>fstrace
34 setlog</B> command. To display or set whether space is allocated for
35 it in kernel memory, use the <B>fstrace lsset</B> or <B>fstrace
36 setset</B> command to display or set the state of the corresponding
37 <B>cm</B> event set, respectively.
38 <P><STRONG>Options</STRONG>
39 <DL>
40 <P><DT><B>-set
41 </B><DD>Names the event set for which to display information about the
42 corresponding trace log. The only acceptable value is <B>cm</B>
43 (for which the associated trace log is <B>cmfx</B>). Provide either
44 this argument or the <B>-log</B> argument, or omit both to display
45 information about the <B>cmfx</B> log by default.
46 <P><DT><B>-log
47 </B><DD>Names the trace log about which to report. The only acceptable
48 value is <B>cmfx</B>. Provide either this argument or the
49 <B>-set</B> argument, or omit both to report on the <B>cmfx</B> log by
50 default.
51 <P><DT><B>-long
52 </B><DD>Reports the defined size of the log in kilobyte units and whether that
53 amount of space is currently allocated in kernel memory.
54 <P><DT><B>-help
55 </B><DD>Prints the online help for this command. All other valid options
56 are ignored.
57 </DL>
58 <P><STRONG>Output</STRONG>
59 <P>By default, the <B>fstrace lslog</B> command displays only the name of
60 the available log, <B>cmfx</B>, in the following format:
61 <PRE>   Available logs:
62    cmfx
63     
64 </PRE>
65 <P>When the <B>-long</B> flag is included, the output also reports the
66 defined size of the log in kilobytes, and whether or not that amount of space
67 is currently allocated in kernel memory, in the following format:
68 <PRE>   Available logs:
69    cmfx : <VAR>log_size</VAR> kbytes (allocated &nbsp;|&nbsp; unallocated)
70    
71 </PRE>
72 <P>The <TT>allocated</TT> state indicates that the indicated number of
73 kilobytes is reserved for the <B>cmfx</B> trace log in kernel
74 memory. The <B>cm</B> event set's state is either
75 <TT>active</TT> or <TT>inactive</TT>, as reported by the <B>fstrace
76 lsset</B> command, and set by the <B>fstrace setset</B> command's
77 <B>-active</B> or <B>-inactive</B> flags respectively.
78 <P>The <TT>unallocated</TT> state indicates that no kernel memory is
79 currently reserved for the <B>cmfx</B> trace log. The <B>cm</B>
80 event set's state is <TT>dormant</TT>, as reported by the <B>fstrace
81 lsset</B> command and set by the <B>fstrace setset</B> command's
82 <B>-dormant</B> flag. If the event set's state is later
83 changed to active or inactive, the number of kilobytes indicated as
84 <VAR>log_size</VAR> are again allocated in kernel memory.
85 <P><STRONG>Examples</STRONG>
86 <P>The following example uses the <B>-long</B> flag to display information
87 about the <B>cmfx</B> log:
88 <PRE>   # <B>fstrace lslog -log cmfx -long</B>
89    Available logs:
90    cmfx : 60 kbytes (allocated)
91     
92 </PRE>
93 <P><STRONG>Privilege Required</STRONG>
94 <P>The issuer must be logged in as the local superuser <B>root</B>.
95 <P><STRONG>Related Information</STRONG>
96 <P><A HREF="auarf169.htm#HDRFSTRACE_INTRO">fstrace</A>
97 <P><A HREF="auarf175.htm#HDRFSTRACE_LSSET">fstrace lsset</A>
98 <P><A HREF="auarf176.htm#HDRFSTRACE_SETLOG">fstrace setlog</A>
99 <P>
100 <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="auarf173.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="auarf175.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> 
101 <!-- Begin Footer Records  ========================================== -->
102 <P><HR><B> 
103 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
104 </B> 
105 <!-- End Footer Records  ============================================ -->
106 <A NAME="Bot_Of_Page"></A>
107 </BODY></HTML>