Remove server logging globals
[openafs.git] / doc / man-pages / pod8 / fstrace_setlog.pod
1 =head1 NAME
2
3 fstrace_setlog - Sets the size of a trace log
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fstrace setlog> S<<< [B<-log> <I<log name>>+] >>>
11     S<<< B<-buffersize> <I<1-kilobyte units>> >>> [B<-help>]
12
13 B<fstrace setl> S<<< [B<-l> <I<log name>>+] >>>
14     S<<< B<-b> <I<1-kilobyte units>> >>> [B<-h>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
21 The B<fstrace setlog> command defines the number of kilobytes of kernel
22 memory allocated for the C<cmfx> trace log. If kernel memory is currently
23 allocated, the command clears the current log and creates a new log buffer
24 of the specified size.
25
26 To display the current defined size of the log buffer, issue the B<fstrace
27 lslog> command with the B<-long> argument. To control whether the
28 indicated amount of space is actually allocated, use the B<fstrace setset>
29 command to set the status of the C<cm> event set; to display the event
30 set's status, use the B<fstrace lsset> command.
31
32 =head1 OPTIONS
33
34 =over 4
35
36 =item B<-log> <I<log name>>+
37
38 Names trace log for which to set the size. The only acceptable
39 value is C<cmfx>, which is also the default if this argument is
40 omitted.
41
42 =item B<-buffersize> <I<1-kilobyte units>>
43
44 Specifies the number of 1-kilobyte blocks of kernel memory to allocate for
45 the trace log.
46
47 =item B<-help>
48
49 Prints the online help for this command. All other valid options are
50 ignored.
51
52 =back
53
54 =head1 EXAMPLES
55
56 The following command allocated 80 KB of kernel memory for the C<cmfx>
57 trace log:
58
59    # fstrace setlog -log cmfx -buffersize 80
60
61 =head1 PRIVILEGE REQUIRED
62
63 The issuer must be logged in as the local superuser C<root>.
64
65 =head1 SEE ALSO
66
67 L<fstrace(8)>,
68 L<fstrace_lslog(8)>,
69 L<fstrace_lsset(8)>,
70 L<fstrace_setset(8)>
71
72 =head1 COPYRIGHT
73
74 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
75
76 This documentation is covered by the IBM Public License Version 1.0.  It was
77 converted from HTML to POD by software written by Chas Williams and Russ
78 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.