update man with keybindings
[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
85d37ab2
JD
59.SH "KEY BINDINGS"
60
61.TP 7
62\ \ \'\fBF2\fR\': \fICPUTop \fR
63Switch to the CPUTop view which displays the CPU usage of each process
64.TP 7
65\ \ \'\fBF3\fR\': \fIPerfTop \fR
66Switch to the PerfTop view which displays the performance counters (PMU) value of each process (if enabled during tracing)
67.TP 7
68\ \ \'\fBF4\fR\': \fIIOTop \fR
69Switch to the IOTop view which displays the I/O usage of each process (as of now read and writes on any file descriptor network or disk)
70.TP 7
71\ \ \'\fBEnter\fR\': \fIProcess details \fR
72Display all relevant information for the process selected
73.TP 7
74\ \ \'\fBSpace\fR\': \fIHighlight \fR
75Highlights the process under the blue line to make it easy to find it across all views or toggle view in preference panel\fR
76.TP 7
77\ \ \'\fBq\fR\': \fIQuit \fR
78Exit the program
79.TP 7
80\ \ \'\fBr\fR\': \fIPreferences \fR
81Display the preference menu for the current view, this menu helps select the column displayed (only in PerfTop view for now) and the column to sort, use 's' to sort and 'space' to toggle the view
82.TP 7
83\ \ \'\fBs\fR\': \fISort \fR
84In preference view, sort on the currently selected line
85.TP 7
86\ \ \'\fBp\fR\': \fIPause/Resume \fR
87Pause the display, hit again to resume the refresh (only works when the trace has not been fully displayed)
88.TP 7
89\ \ \'\fBRight arrow\fR\': \fIMove forward in time \fR
90Display the next second of data, can be hit several time to bypass the default 1 second refresh period to fast forward
91.TP 7
92\ \ \'\fBLeft arrow\fR\': \fIMove backward in time \fR
93Display the previous second of data, automatically switch to pause if not already enabled
94.TP 7
95\ \ \'\fBUp arrow\' / \'k\'\fR: \fIMove UP the cursor \fR
96Move up the blue line to select processes \fR
97.TP 7
98\ \ \'\fBDown arrow\' / \'j\'\fR: \fIMove DOWN the cursor \fR
99Move down the blue line to select processes
100
661ad2e0
JD
101.SH "SEE ALSO"
102
103.PP
104babeltrace(1), babeltrace-log(1), lttng(1), lttng-ust(3), lttng-sessiond(8)
105.PP
106.SH "BUGS"
107
108.PP
109No knows bugs at this point.
110
111If you encounter any issues or usability problem, please report it on
112our mailing list <lttng-dev@lists.lttng.org> to help improve this
113project.
114.SH "CREDITS"
115
116LTTngTop is distributed under the GPLv2 license. See the LICENSE file
117in the source tree for details.
118
119.PP
120A Web site is available at http://www.efficios.com/babeltrace for more
121information on Babeltrace and the Common Trace Format. See
122http://lttng.org for more information on the LTTng project.
123.PP
124Mailing list for support and development: <lttng-dev@lists.lttng.org>.
125.PP
126You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
127.PP
128
129.SH "AUTHORS"
130
131.PP
132LTTngTop was originally written by Julien Desfossez, with contribution
133from Mathieu Bain for the I/O bandwidth view, and suggestions and ideas
134from the team working with the LTTng project. It is currently
135maintained by Julien Desfossez <jdesfossez@efficios.com>
136.PP
This page took 0.037814 seconds and 4 git commands to generate.