Update fstrace suite manpages
[openafs.git] / doc / man-pages / pod8 / fstrace.pod
1 =head1 NAME
2
3 fstrace - Introduction to the fstrace command suite
4
5 =head1 DESCRIPTION
6
7 The commands in the B<fstrace> command suite are the interface that system
8 administrators employ to trace Cache Manager operations for debugging
9 purposes. Examples of Cache Manager operations are fetching file data or
10 the status information used to produce output for the UNIX B<ls> command.
11
12 The B<fstrace> command interpreter defines an extensive set of Cache
13 Manager operations as the C<cm> I<event set>.  When the event set is
14 activated, the Cache Manager writes a message to the C<cmfx> I<trace log>
15 in kernel memory each time it performs one of the defined operations. The
16 log expands only to a defined size (by default, 60 KB), after which it is
17 overwritten in a circular fashion (new trace messages overwrite the oldest
18 ones). If an operation of particular interest occurs, the administrator
19 can afterward display the log on the standard output stream or write it to
20 a file for later study. For more specific procedural instructions, see the
21 I<IBM AFS Administration Guide>.
22
23 There are several categories of commands in the B<fstrace> command suite:
24
25 =over 4
26
27 =item *
28
29 Commands to administer or display information about the trace log:
30 L<B<fstrace clear>|fstrace_clear(8)>,
31 L<B<fstrace lslog>|fstrace_lslog(8)>,
32 and L<B<fstrace setlog>|fstrace_setlog(8)>.
33
34 =item *
35
36 Commands to set or display the status of the event set:
37 L<B<fstrace lsset>|fstrace_lsset(8)>
38 and L<B<fstrace setset>|fstrace_setset(8)>.
39
40 =item *
41
42 A command to display the contents of the trace log:
43 L<B<fstrace dump>|fstrace_dump(8)>.
44
45 =item *
46
47 Commands to obtain help:
48 L<B<fstrace apropos>|fstrace_apropos(8)>
49 and L<B<fstrace help>|fstrace_help(8)>.
50
51 =back
52
53 =head1 OPTIONS
54
55 All B<fstrace> commands accept the following optional flag.  It is listed
56 in the command descriptions and described in detail here:
57
58 =over 4
59
60 =item B<-help>
61
62 Prints a command's online help message on the standard output stream. Do
63 not combine this flag with any of the command's other options; when it is
64 provided, the command interpreter ignores all other options, and only
65 prints the help message.
66
67 =back
68
69 =head1 PRIVILEGE REQUIRED
70
71 To issue most B<fstrace> commands, the issuer must be logged on as the
72 local superuser C<root> on the machine that is generating the trace log.
73
74 =head1 SEE ALSO
75
76 L<fstrace_apropos(8)>,
77 L<fstrace_clear(8)>,
78 L<fstrace_dump(8)>,
79 L<fstrace_help(8)>,
80 L<fstrace_lslog(8)>,
81 L<fstrace_lsset(8)>,
82 L<fstrace_setlog(8)>,
83 L<fstrace_setset(8)>
84
85 =head1 COPYRIGHT
86
87 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
88
89 This documentation is covered by the IBM Public License Version 1.0.  It was
90 converted from HTML to POD by software written by Chas Williams and Russ
91 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.