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