openafs/doc/html/AdminReference/auarf169.htm
Derrick Brashear d7da1acc31 initial-html-documentation-20010606
pull in all documentation from IBM
2001-06-06 19:09:07 +00:00

90 lines
5.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
<HTML><HEAD>
<TITLE>Administration Reference</TITLE>
<!-- Begin Header Records ========================================== -->
<!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID -->
<!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30 -->
<META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
<META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
<META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
</HEAD><BODY>
<!-- (C) IBM Corporation 2000. All Rights Reserved -->
<BODY bgcolor="ffffff">
<!-- End Header Records ============================================ -->
<A NAME="Top_Of_Page"></A>
<H1>Administration Reference</H1>
<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="auarf168.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="auarf170.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>
<P>
<H2><A NAME="HDRFSTRACE_INTRO" HREF="auarf002.htm#ToC_183">fstrace</A></H2>
<P><STRONG>Purpose</STRONG>
<A NAME="IDX5021"></A>
<A NAME="IDX5022"></A>
<A NAME="IDX5023"></A>
<A NAME="IDX5024"></A>
<A NAME="IDX5025"></A>
<A NAME="IDX5026"></A>
<P>Introduction to the <B>fstrace</B> command suite
<P><STRONG>Description</STRONG>
<P>The commands in the <B>fstrace</B> command suite are the interface that
system administrators employ to trace Cache Manager operations for debugging
purposes. Examples of Cache Manager operations are fetching file data
or the status information used to produce output for the UNIX <B>ls</B>
command.
<P>The <B>fstrace</B> command interpreter defines an extensive set of
Cache Manager operations as the <B>cm</B> <I>event set</I>.
When the event set is activated, the Cache Manager writes a message to the
<B>cmfx</B> <I>trace log</I> in kernel memory each time it performs
one of the defined operations. The log expands only to a defined size
(by default, 60 KB), after which it is overwritten in a circular fashion (new
trace messages overwrite the oldest ones). If an operation of
particular interest occurs, the administrator can afterward display the log on
the standard output stream or write it to a file for later study. For
more specific procedural instructions, see the <I>IBM AFS Administration
Guide</I>.
<P>There are several categories of commands in the <B>fstrace</B> command
suite:
<UL>
<P><LI>Commands to administer or display information about the trace log:
<P><B>fstrace clear</B>, <B>fstrace lslog</B>, <B>fstrace
setlog</B>
<P><LI>Commands to set or display the status of the event set:
<P><B>fstrace lsset</B> and <B>fstrace setset</B>
<P><LI>A command to display the contents of the trace log: <B>fstrace
dump</B>
<P><LI>Commands to obtain help: <B>fstrace apropos</B> and <B>fstrace
help</B>
</UL>
<P><STRONG>Options</STRONG>
<P>All <B>fstrace</B> commands accept the following optional flag.
It is listed in the command descriptions and described in detail here:
<A NAME="IDX5027"></A>
<DL>
<P><DT><B>-help
</B><DD>Prints a command's online help message on the standard output
stream. Do not combine this flag with any of the command's other
options; when it is provided, the command interpreter ignores all other
options, and only prints the help message.
</DL>
<P><STRONG>Privilege Required</STRONG>
<P>To issue most <B>fstrace</B> commands, the issuer must be logged on as
the local superuser <B>root</B> on the machine that is generating the
trace log.
<P><STRONG>Related Information</STRONG>
<P><A HREF="auarf170.htm#HDRFSTRACE_APROPOS">fstrace apropos</A>
<P><A HREF="auarf171.htm#HDRFSTRACE_CLEAR">fstrace clear</A>
<P><A HREF="auarf172.htm#HDRFSTRACE_DUMP">fstrace dump</A>
<P><A HREF="auarf173.htm#HDRFSTRACE_HELP">fstrace help</A>
<P><A HREF="auarf174.htm#HDRFSTRACE_LSLOG">fstrace lslog</A>
<P><A HREF="auarf175.htm#HDRFSTRACE_LSSET">fstrace lsset</A>
<P><A HREF="auarf176.htm#HDRFSTRACE_SETLOG">fstrace setlog</A>
<P><A HREF="auarf177.htm#HDRFSTRACE_SETSET">fstrace setset</A>
<P>
<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="auarf168.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="auarf170.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>
<!-- Begin Footer Records ========================================== -->
<P><HR><B>
<br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A> All Rights Reserved
</B>
<!-- End Footer Records ============================================ -->
<A NAME="Bot_Of_Page"></A>
</BODY></HTML>