=head1 NAME

fstrace - Introduction to the C<fstrace> command suite

=head1 DESCRIPTION

The commands in the C<fstrace> 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> command.

The C<fstrace> command interpreter defines an extensive set of Cache
Manager operations as the B<cm> I<event set>. When the event set is
activated, the Cache Manager writes a message to the B<cmfx> I<trace log> 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 IBM AFS Administration Guide.

There are several categories of commands in the C<fstrace> command suite:

=over

=item *

Commands to administer or display information about the trace log:
C<fstrace clear>, C<fstrace lslog>, C<fstrace setlog>

=item *

Commands to set or display the status of the event set:
C<fstrace lsset> and C<fstrace setset>

=item *

A command to display the contents of the trace log: C<fstrace dump>

=item *

Commands to obtain help: C<fstrace apropos> and C<fstrace help>

=back

=head1 OPTIONS

All C<fstrace> commands accept the following optional flag. It is listed
in the command descriptions and described in detail here:

=over 4

=item B<-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.

=back

=head1 PRIVILEGE REQUIRED

To issue most C<fstrace> commands, the issuer must be logged on as the
local superuser B<root> on the machine that is generating the trace log.

=head1 COPYRIGHT

IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
Stanford Linear Accelerator Center, a department of Stanford University.

=head1 SEE ALSO

L<fstrace_apropos(1)>,
L<fstrace_clear(1)>,
L<fstrace_dump(1)>,
L<fstrace_help(1)>,
L<fstrace_lslog(1)>,
L<fstrace_lsset(1)>,
L<fstrace_setlog(1)>,
L<fstrace_setset(1)>

=cut
