Manpage and updated doc
[lttngtop.git] / doc / lttngtop.1
CommitLineData
661ad2e0
JD
1.TH "LTTNGTOP" "1" "April 18, 2012" "" ""
2
3.SH "NAME"
4lttngtop \(em LTTng Trace Viewer
5
6.SH "SYNOPSIS"
7
8.PP
9.nf
10lttngtop INPUT
11.fi
12.SH "DESCRIPTION"
13
14.PP
15
16Lttngtop is a ncurses interface for reading and browsing traces recorded by the
17LTTng tracer and displaying various statistics. As of now, the cpu usage,
18performance counters and per process/file I/O bandwidth are displayed. This
19version currently only supports offline traces, but a live version is in alpha
20and will be available for testing soon.
21.SH "OPTIONS"
22
23.TP
24.BR "INPUT"
25Input trace path
26
27.SH "TRACE REQUIREMENTS"
28
29.PP
30
31LTTngTop requires that the pid, procname, tid and ppid context information
32are enabled during tracing.
33.PP
34
35.PP
36If you want the CPU activity view, you need the sched_switch event, if you
37want the I/O statistics, you need to enable the system call tracing, and if
38you want the performance counters, you need to enable them for the events you
39are interested in (or all of them). Note, there is a hardware limitation for the
40number of performance counter you can enable, check dmesg for information.
41.PP
42
43.PP
44The following example creates a trace with all events enabled, the mandatory context informations and
45three performance counters. It assumes that you are running as root or with a user part of the tracing group and a lttng-sessiond
46launched as root.
47.PP
48
49.nf
50lttng create lttngtop
51lttng enable-event -k -a
52lttng add-context -k -t pid -t procname -t tid -t ppid -t perf:cache-misses -t perf:major-faults -t perf:branch-load-misses
53lttng start
54sleep 10
55lttng stop
56lttng destroy
57.fi
58
59.SH "SEE ALSO"
60
61.PP
62babeltrace(1), babeltrace-log(1), lttng(1), lttng-ust(3), lttng-sessiond(8)
63.PP
64.SH "BUGS"
65
66.PP
67No knows bugs at this point.
68
69If you encounter any issues or usability problem, please report it on
70our mailing list <lttng-dev@lists.lttng.org> to help improve this
71project.
72.SH "CREDITS"
73
74LTTngTop is distributed under the GPLv2 license. See the LICENSE file
75in the source tree for details.
76
77.PP
78A Web site is available at http://www.efficios.com/babeltrace for more
79information on Babeltrace and the Common Trace Format. See
80http://lttng.org for more information on the LTTng project.
81.PP
82Mailing list for support and development: <lttng-dev@lists.lttng.org>.
83.PP
84You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
85.PP
86
87.SH "AUTHORS"
88
89.PP
90LTTngTop was originally written by Julien Desfossez, with contribution
91from Mathieu Bain for the I/O bandwidth view, and suggestions and ideas
92from the team working with the LTTng project. It is currently
93maintained by Julien Desfossez <jdesfossez@efficios.com>
94.PP
This page took 0.0342 seconds and 4 git commands to generate.