doc/man-pages/pod8/fstrace_lslog.pod

   1 =head1 NAME
   2
   3 fstrace lslog - Displays information about a log
   4
   5 =head1 SYNOPSIS
   6
   7 B<fstrace lslog> [B<-set> <I<set_name>>+]  [B<-log> <I<log_name>>]  [B<-long>]  [-help]
   8
   9 B<fstrace lsl> [B<-s> <I<set_name>>+]  [B<-log> <I<log_name>>]  [B<-lon>]  [-h]
  10
  11 =head1 DESCRIPTION
  12
  13 The B<fstrace lslog> command reports whether the cmfx
  14 log is available for use. If the B<-long> argument is included,
  15 the output reports the log's defined size, and whether that amount of
  16 space is currently allocated in kernel memory or not.
  17
  18 To change the B<cmfx> trace log's size, use the fstrace
  19 setlog command. To display or set whether space is allocated for
  20 it in kernel memory, use the B<fstrace lsset> or B<fstrace
  21 setset> command to display or set the state of the corresponding
  22 B<cm> event set, respectively.
  23
  24 =head1 OPTIONS
  25
  26 =over 4
  27
  28 =item -set
  29
  30 Names the event set for which to display information about the
  31 corresponding trace log. The only acceptable value is B<cm>
  32 (for which the associated trace log is B<cmfx>). Provide either
  33 this argument or the B<-log> argument, or omit both to display
  34 information about the B<cmfx> log by default.
  35
  36 =item -log
  37
  38 Names the trace log about which to report. The only acceptable
  39 value is B<cmfx>. Provide either this argument or the
  40 B<-set> argument, or omit both to report on the B<cmfx> log by
  41 default.
  42
  43 =item -long
  44
  45 Reports the defined size of the log in kilobyte units and whether that
  46 amount of space is currently allocated in kernel memory.
  47
  48 =item -help
  49
  50 Prints the online help for this command. All other valid options
  51 are ignored.
  52
  53 =back
  54
  55 =head1 OUTPUT
  56
  57 By default, the fstrace lslog command displays only the name of
  58 the available log, B<cmfx>, in the following format:
  59
  60    Available logs:
  61    cmfx
  62
  63 When the -long flag is included, the output also reports the
  64 defined size of the log in kilobytes, and whether or not that amount of space
  65 is currently allocated in kernel memory, in the following format:
  66
  67    Available logs:
  68    cmfx : I<log_size> kbytes (allocated  |  unallocated)
  69
  70 The C<allocated> state indicates that the indicated number of
  71 kilobytes is reserved for the B<cmfx> trace log in kernel
  72 memory. The B<cm> event set's state is either
  73 C<active> or C<inactive>, as reported by the B<fstrace
  74 lsset> command, and set by the B<fstrace setset> command's
  75 B<-active> or B<-inactive> flags respectively.
  76
  77 The C<unallocated> state indicates that no kernel memory is
  78 currently reserved for the B<cmfx> trace log. The B<cm>
  79 event set's state is C<dormant>, as reported by the B<fstrace
  80 lsset> command and set by the B<fstrace setset> command's
  81 B<-dormant> flag. If the event set's state is later
  82 changed to active or inactive, the number of kilobytes indicated as
  83 I<log_size> are again allocated in kernel memory.
  84
  85 =head1 EXAMPLES
  86
  87 The following example uses the -long flag to display information
  88 about the B<cmfx> log:
  89
  90    # fstrace lslog -log cmfx -long
  91    Available logs:
  92    cmfx : 60 kbytes (allocated)
  93
  94 =head1 PRIVILEGE REQUIRED
  95
  96 The issuer must be logged in as the local superuser root.
  97
  98 =head1 SEE ALSO
  99
 100 L<fstrace(1)>,
 101 L<fstrace_lsset(1)>,
 102 L<fstrace_setlog(1)>
 103
 104 =head1 COPYRIGHT
 105
 106 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 107
 108 This documentation is covered by the IBM Public License Version 1.0.  It was
 109 converted from HTML to POD by software written by Chas Williams and Russ
 110 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.