doc/man-pages/pod8/fstrace_lsset.pod

   1 =head1 NAME
   2
   3 fstrace_lsset - Reports the status of an event set
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<fstrace lsset> S<<< [B<-set> <I<set name>>+] >>> [B<-help>]
  11
  12 B<fstrace lss> S<<< [B<-s> <I<set name>>+] >>> [B<-h>]
  13
  14 =for html
  15 </div>
  16
  17 =head1 DESCRIPTION
  18
  19 The B<fstrace lsset> command displays a list of the available event sets
  20 and reports their current status (active, inactive, or dormant).
  21
  22 To change an event set's status, use the B<fstrace setset> command.
  23
  24 =head1 OPTIONS
  25
  26 =over 4
  27
  28 =item B<-set> <I<set name>>+
  29
  30 Names the event set for which to display the status. The only acceptable
  31 value is C<cm>, which is also the default if this argument is omitted.
  32
  33 =item B<-help>
  34
  35 Prints the online help for this command. All other valid options are
  36 ignored.
  37
  38 =back
  39
  40 =head1 OUTPUT
  41
  42 The output lists the available event sets and the status of each, in the
  43 following format:
  44
  45    Available sets:
  46    cm (active | inactive | dormant)
  47
  48 where
  49
  50 =over 4
  51
  52 =item active
  53
  54 Indicates that tracing is enabled for the event set, and kernel memory
  55 allocated for the corresponding trace log.
  56
  57 =item inactive
  58
  59 Indicates that tracing is temporarily disabled for the event set, but
  60 kernel memory still allocated for the corresponding trace log.
  61
  62 =item dormant
  63
  64 Indicates that tracing is disabled for the event set, and no kernel memory
  65 allocated for the corresponding trace log.
  66
  67 =back
  68
  69 =head1 EXAMPLES
  70
  71 The following example displays the available event set and its status:
  72
  73    # fstrace lsset
  74    Available sets:
  75    cm active
  76
  77 =head1 PRIVILEGE REQUIRED
  78
  79 The issuer must be logged in as the local superuser C<root>.
  80
  81 =head1 SEE ALSO
  82
  83 L<fstrace(8)>,
  84 L<fstrace_setset(8)>
  85
  86 =head1 COPYRIGHT
  87
  88 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
  89
  90 This documentation is covered by the IBM Public License Version 1.0.  It was
  91 converted from HTML to POD by software written by Chas Williams and Russ
  92 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.