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