Commit | Line | Data |
---|---|---|
805e021f CE |
1 | =head1 NAME |
2 | ||
3 | fs_trace - Enable or disable AFS Cache Manager tracing | |
4 | ||
5 | =head1 SYNOPSIS | |
6 | ||
7 | =for html | |
8 | <div class="synopsis"> | |
9 | ||
10 | B<fs trace> S<<< [B<-on>|B<-off>] >>> [B<-reset>] [B<-dump>] | |
11 | ||
12 | =for html | |
13 | </div> | |
14 | ||
15 | =head1 DESCRIPTION | |
16 | ||
17 | This command enables or disables AFS Cache Manager tracing, resets the | |
18 | trace log, or dumps the log. When you dump the log, two files are created | |
19 | in the Windows Temporary directory: F<afs-buffer.log> and F<afsd.log>. | |
20 | Any existing files with those names will be replaced. | |
21 | ||
22 | =head1 CAUTIONS | |
23 | ||
24 | This command is only available on Windows. | |
25 | ||
26 | =head1 OPTIONS | |
27 | ||
28 | Any combination of the following options may be specified, except that | |
29 | both B<-on> and B<-off> cannot be specified at the same time. | |
30 | ||
31 | =over 4 | |
32 | ||
33 | =item B<-on> | |
34 | ||
35 | Turn tracing on. | |
36 | ||
37 | =item B<-off> | |
38 | ||
39 | Turn tracing off. | |
40 | ||
41 | =item B<-reset> | |
42 | ||
43 | Resets the tracing information, discarding any trace-information collected | |
44 | up to this time. | |
45 | ||
46 | =item B<-dump> | |
47 | ||
48 | Creates a dump file containing the trace information. | |
49 | ||
50 | =back | |
51 | ||
52 | =head1 OUTPUT | |
53 | ||
54 | If successful, the output of this command (for any option) will be: | |
55 | ||
56 | AFS tracing enabled | |
57 | ||
58 | If unsuccessful: | |
59 | ||
60 | AFS tracing disabled | |
61 | ||
62 | =head1 EXAMPLES | |
63 | ||
64 | The following command starts tracing: | |
65 | ||
66 | % fs trace -on | |
67 | ||
68 | The following dumps the current contents and resets the trace log, then | |
69 | turns tracing off: | |
70 | ||
71 | % fs trace -dump -reset -off | |
72 | ||
73 | =head1 PRIVILEGE REQUIRED | |
74 | ||
75 | The issuer must be have AFS Client Administrator access to issue this | |
76 | command. | |
77 | ||
78 | =head1 SEE ALSO | |
79 | ||
80 | L<fs(1)> | |
81 | ||
82 | =head1 COPYRIGHT | |
83 | ||
84 | Copyright 2008. This documentation is covered by the BSD License as | |
85 | written in the doc/LICENSE file. This man page was written by Mike | |
86 | Robinson (L<mike@endpoint.com>) for OpenAFS. |