.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "FSTRACE 8"
.TH FSTRACE 8 2024-03-20 OpenAFS "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
fstrace \- Introduction to the fstrace command suite
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The commands in the \fBfstrace\fR 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 \fBls\fR command.
.PP
The \fBfstrace\fR command interpreter defines an extensive set of Cache
Manager operations as the \f(CW\*(C`cm\*(C'\fR \fIevent set\fR.  When the event set is
activated, the Cache Manager writes a message to the \f(CW\*(C`cmfx\*(C'\fR \fItrace log\fR
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
\&\fIOpenAFS Administration Guide\fR.
.PP
There are several categories of commands in the \fBfstrace\fR command suite:
.IP \(bu 4
Commands to administer or display information about the trace log:
\&\fBfstrace clear\fR,
\&\fBfstrace lslog\fR,
and \fBfstrace setlog\fR.
.IP \(bu 4
Commands to set or display the status of the event set:
\&\fBfstrace lsset\fR
and \fBfstrace setset\fR.
.IP \(bu 4
A command to display the contents of the trace log:
\&\fBfstrace dump\fR.
.IP \(bu 4
Commands to obtain help:
\&\fBfstrace apropos\fR
and \fBfstrace help\fR.
.SH OPTIONS
.IX Header "OPTIONS"
All \fBfstrace\fR commands accept the following optional flag.  It is listed
in the command descriptions and described in detail here:
.IP \fB\-help\fR 4
.IX Item "-help"
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.
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
To issue most \fBfstrace\fR commands, the issuer must be logged on as the
local superuser \f(CW\*(C`root\*(C'\fR on the machine that is generating the trace log.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBfstrace_apropos\fR\|(8),
\&\fBfstrace_clear\fR\|(8),
\&\fBfstrace_dump\fR\|(8),
\&\fBfstrace_help\fR\|(8),
\&\fBfstrace_lslog\fR\|(8),
\&\fBfstrace_lsset\fR\|(8),
\&\fBfstrace_setlog\fR\|(8),
\&\fBfstrace_setset\fR\|(8)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
.PP
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.