mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 15:30:14 +00:00
98 lines
4.5 KiB
XML
98 lines
4.5 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<refentry id="fstrace8">
|
|
<refmeta>
|
|
<refentrytitle>fstrace</refentrytitle>
|
|
<manvolnum>8</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>fstrace</refname>
|
|
<refpurpose>Introduction to the fstrace command suite</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>The commands in the <emphasis role="bold">fstrace</emphasis> 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 <emphasis role="bold">ls</emphasis> command.</para>
|
|
|
|
<para>The <emphasis role="bold">fstrace</emphasis> command interpreter defines an extensive set of Cache
|
|
Manager operations as the <computeroutput>cm</computeroutput> <emphasis>event set</emphasis>. When the event set is
|
|
activated, the Cache Manager writes a message to the <computeroutput>cmfx</computeroutput> <emphasis>trace log</emphasis>
|
|
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
|
|
<emphasis>IBM AFS Administration Guide</emphasis>.</para>
|
|
|
|
<para>There are several categories of commands in the <emphasis role="bold">fstrace</emphasis> command suite:</para>
|
|
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>Commands to administer or display information about the trace log:
|
|
<emphasis role="bold">fstrace clear</emphasis>, <emphasis role="bold">fstrace lslog</emphasis>, <emphasis role="bold">fstrace setlog</emphasis>.</para>
|
|
|
|
</listitem>
|
|
<listitem>
|
|
<para>Commands to set or display the status of the event set: <emphasis role="bold">fstrace lsset</emphasis>
|
|
and <emphasis role="bold">fstrace setset</emphasis>.</para>
|
|
|
|
</listitem>
|
|
<listitem>
|
|
<para>A command to display the contents of the trace log: <emphasis role="bold">fstrace dump</emphasis>.</para>
|
|
|
|
</listitem>
|
|
<listitem>
|
|
<para>Commands to obtain help: <emphasis role="bold">fstrace apropos</emphasis> and <emphasis role="bold">fstrace help</emphasis>.</para>
|
|
|
|
</listitem>
|
|
</itemizedlist>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Options</title>
|
|
<para>All <emphasis role="bold">fstrace</emphasis> commands accept the following optional flag. It is listed
|
|
in the command descriptions and described in detail here:</para>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><emphasis role="bold">-help</emphasis></term>
|
|
<listitem>
|
|
<para>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.</para>
|
|
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Privilege Required</title>
|
|
<para>To issue most <emphasis role="bold">fstrace</emphasis> commands, the issuer must be logged on as the
|
|
local superuser <computeroutput>root</computeroutput> on the machine that is generating the trace log.</para>
|
|
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>See Also</title>
|
|
<para><link linkend="fstrace_apropos8">fstrace_apropos(8)</link>,
|
|
<link linkend="fstrace_clear8">fstrace_clear(8)</link>,
|
|
<link linkend="fstrace_dump8">fstrace_dump(8)</link>,
|
|
<link linkend="fstrace_help8">fstrace_help(8)</link>,
|
|
<link linkend="fstrace_lslog8">fstrace_lslog(8)</link>,
|
|
<link linkend="fstrace_lsset8">fstrace_lsset(8)</link>,
|
|
<link linkend="fstrace_setlog8">fstrace_setlog(8)</link>,
|
|
<link linkend="fstrace_setset8">fstrace_setset(8)</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>
|