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