doc/man-pages/pod/fstrace.pod

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