doc: Edits to the 'afsd -volume-ttl' manpage
[openafs.git] / doc / man-pages / pod8 / fstrace_clear.pod
1 =head1 NAME
2
3 fstrace_clear - Clears the trace log
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fstrace clear> S<<< [B<-set> <I<set name>>+] >>>
11     S<<< [B<-log> <I<log name>>+] >>>
12     [B<-help>]
13
14 B<fstrace c> S<<< [B<-s> <I<set name>>+] >>>
15     S<<< [B<-l> <I<log name>>+] >>> [B<-h>]
16
17 =for html
18 </div>
19
20 =head1 DESCRIPTION
21
22 The B<fstrace clear> command erases the contents of the trace log from
23 kernel memory, but leaves kernel memory allocated for the log.
24
25 =head1 OPTIONS
26
27 =over 4
28
29 =item B<-set> <I<set name>>+
30
31 Names the event set for which to clear the associated trace log.  The only
32 acceptable value is C<cm> (for which the associated trace log is
33 C<cmfx>). Provide either this argument or the B<-log> argument, or omit
34 both to clear the C<cmfx> log by default.
35
36 =item B<-log> <I<log name>>+
37
38 Names the trace log to clear. The only acceptable value is
39 C<cmfx>. Provide either this argument or the B<-set> argument, or omit
40 both to clear the C<cmfx> log by default.
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 clears the C<cmfx> trace log on the local machine:
52
53    # fstrace clear
54
55 =head1 PRIVILEGE REQUIRED
56
57 The issuer must be logged in as the local superuser C<root>.
58
59 =head1 SEE ALSO
60
61 L<fstrace(8)>,
62 L<fstrace_lslog(8)>,
63 L<fstrace_lsset(8)>
64
65 =head1 COPYRIGHT
66
67 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
68
69 This documentation is covered by the IBM Public License Version 1.0.  It was
70 converted from HTML to POD by software written by Chas Williams and Russ
71 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.