Update fstrace suite manpages
[openafs.git] / doc / man-pages / pod8 / fstrace_setset.pod
1 =head1 NAME
2
3 fstrace_setset - Sets the status of an event set
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fstrace setset> S<<< [B<-set> <I<set name>>+] >>>
11     [B<-active>] [B<-inactive>] [B<-dormant>] [B<-help>]
12
13 B<fs sets> S<<< [B<-s> <I<set name>>+] >>> [B<-a>] [B<-i>] [B<-d>] [B<-h>]
14
15 =for html
16 </div>
17
18 =head1 DESCRIPTION
19
20 The B<fstrace setset> command sets the status of the C<cm> kernel event
21 set on the local machine, which determines whether trace messages are
22 recorded in the log buffer in kernel memory.
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 set the status. The only acceptable value
31 C<cm>, which is also the default if this argument is omitted.
32
33 =item B<-active>
34
35 Enables tracing for the event set and allocates kernel memory for the
36 associated trace log buffer. Provide one of this flag, the B<-inactive>
37 flag, or the B<-dormant> flag.
38
39 =item B<-inactive>
40
41 Temporarily disables tracing for the event set, but does not change the
42 allocation of kernel memory for the associated trace log buffer.  Provide
43 one of this flag, the B<-active> flag, or the B<-dormant> flag.
44
45 =item B<-dormant>
46
47 Disables tracing for the event set and frees the kernel memory previously
48 allocated for the associated trace log buffer. Provide one of this flag,
49 the B<-active> flag, or the B<-inactive> flag.
50
51 =item B<-help>
52
53 Prints the online help for this command. All other valid options are
54 ignored.
55
56 =back
57
58 =head1 EXAMPLES
59
60 The following example sets the cm event set's status to inactive:
61
62    # fstrace setset -set cm -inactive
63
64 =head1 PRIVILEGE REQUIRED
65
66 The issuer must be logged in as the local superuser C<root>.
67
68 =head1 SEE ALSO
69
70 L<fstrace(8)>,
71 L<fstrace_lsset(8)>,
72 L<fstrace_setlog(8)>
73
74 =head1 COPYRIGHT
75
76 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
77
78 This documentation is covered by the IBM Public License Version 1.0.  It was
79 converted from HTML to POD by software written by Chas Williams and Russ
80 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.