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