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