diff options
Diffstat (limited to 'Documentation/trace-cmd-extract.txt')
-rw-r--r-- | Documentation/trace-cmd-extract.txt | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/Documentation/trace-cmd-extract.txt b/Documentation/trace-cmd-extract.txt new file mode 100644 index 0000000..1eaea3c --- /dev/null +++ b/Documentation/trace-cmd-extract.txt | |||
@@ -0,0 +1,66 @@ | |||
1 | TRACE-CMD-EXTRACT(1) | ||
2 | =================== | ||
3 | |||
4 | NAME | ||
5 | ---- | ||
6 | trace-cmd-extract - extract out the data from the Ftrace Linux tracer. | ||
7 | |||
8 | SYNOPSIS | ||
9 | -------- | ||
10 | *trace-cmd extract ['OPTIONS']* | ||
11 | |||
12 | DESCRIPTION | ||
13 | ----------- | ||
14 | The trace-cmd(1) extract is usually used after 'trace-cmd-start(1)' and | ||
15 | 'trace-cmd-stop(1)'. It can be used after the Ftrace tracer has been started | ||
16 | manually through the Ftrace pseudo file system. | ||
17 | |||
18 | The extract command creates a trace.dat file that can be used by | ||
19 | 'trace-cmd-report(1)' to read from. It reads the kernel internal ring buffer | ||
20 | to produce the trace.dat file. | ||
21 | |||
22 | OPTIONS | ||
23 | ------- | ||
24 | *-p* 'plugin':: | ||
25 | Although *extract* does not start any traces, some of the plugins require | ||
26 | just reading the output in ASCII format. These are the latency tracers, | ||
27 | since the latency tracers have a separate internal buffer. The plugin | ||
28 | option is therefore only necessary for the 'wakeup', 'wakeup-rt', | ||
29 | 'irqsoff', 'preemptoff' and 'preemptirqsoff' plugins. | ||
30 | |||
31 | With out this option, the extract command will extract from the internal | ||
32 | Ftrace buffers. | ||
33 | |||
34 | *-O* 'option':: | ||
35 | If a latency tracer is being extracted, and the *-p* option is used, then | ||
36 | there are some Ftrace options that can change the format. This will update | ||
37 | those options before extracting. To see the list of options see | ||
38 | 'trace-cmd-list'. To enable an option, write its name, to disable the | ||
39 | option append the characters 'no' to it. For example: 'noprint-parent' | ||
40 | will disable the 'print-parent' option that prints the parent function in | ||
41 | printing a function event. | ||
42 | |||
43 | *-o* 'outputfile':: | ||
44 | By default, the extract command will create a 'trace.dat' file. This | ||
45 | option will change where the file is written to. | ||
46 | |||
47 | |||
48 | SEE ALSO | ||
49 | -------- | ||
50 | trace-cmd(1), trace-cmd-record(1), trace-cmd-report(1), trace-cmd-start(1), | ||
51 | trace-cmd-stop(1), trace-cmd-reset(1), trace-cmd-split(1), | ||
52 | trace-cmd-list(1), trace-cmd-listen(1) | ||
53 | |||
54 | AUTHOR | ||
55 | ------ | ||
56 | Written by Steven Rostedt, <rostedt@goodmis.org> | ||
57 | |||
58 | RESOURCES | ||
59 | --------- | ||
60 | git://git.kernel.org/pub/scm/linux/kernel/git/rostedt/trace-cmd.git | ||
61 | |||
62 | COPYING | ||
63 | ------- | ||
64 | Copyright \(C) 2010 Red Hat, Inc. Free use of this software is granted under | ||
65 | the terms of the GNU Public License (GPL). | ||
66 | |||