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