Signed-off-by: David Goulet <dgoulet@efficios.com>
-lttng-sessiond is distributed under the GNU public license version 2. See the
+lttng-sessiond is distributed under the GNU General Public License version 2. See the
file COPYING for details.
.PP
A Web site is available at http://lttng.org for more information on the LTTng
file COPYING for details.
.PP
A Web site is available at http://lttng.org for more information on the LTTng
Special thanks to Michel Dagenais and the DORSAL laboratory at Polytechnique de
Montreal for the LTTng journey.
Special thanks to Michel Dagenais and the DORSAL laboratory at Polytechnique de
Montreal for the LTTng journey.
Show summary of possible options and commands.
.TP
Show summary of possible options and commands.
.TP
-FIXME : details (-v : sessiond verbose, -vv : consumerd verbose, etc) ?
+FIXME : details (\-v : sessiond verbose, \-vv : consumerd verbose, etc) ?
Suppress all messages (even errors).
.TP
Suppress all messages (even errors).
.TP
+.BR "\-g, \-\-group NAME"
Set unix tracing group name. (default: tracing)
.TP
Set unix tracing group name. (default: tracing)
.TP
+.BR "\-n, \-\-no-sessiond"
Don't automatically spawn a session daemon.
.TP
Don't automatically spawn a session daemon.
.TP
+.BR "\-\-sessiond\-path"
Set session daemon full binary path.
.TP
Set session daemon full binary path.
.TP
Simple listing of lttng options.
.TP
Simple listing of lttng options.
.TP
+.BR "\-\-list\-commands"
Simple listing of lttng commands.
.SH "COMMANDS"
Simple listing of lttng commands.
.SH "COMMANDS"
counters (hardware branch misses and cache misses), to all events in the trace
data output:
counters (hardware branch misses and cache misses), to all events in the trace
data output:
-# lttng add-context -k -t prio -t perf:branch-misses -t perf:cache-misses
+# lttng add-context \-k \-t prio \-t perf:branch-misses \-t perf:cache-misses
-Please take a look at the help (-h/--help) for a detailed list of available
+Please take a look at the help (\-h/\-\-help) for a detailed list of available
-If no channel and no event is given (-c/-e), the context is added to all
+If no channel and no event is given (\-c/\-e), the context is added to all
channels (which applies automatically to all events in that channel). Otherwise
channels (which applies automatically to all events in that channel). Otherwise
-the context will be added only to the channel (-c) and/or event (-e) indicated.
+the context will be added only to the channel (\-c) and/or event (\-e) indicated.
-If \fB-s, --session\fP is omitted, the session name is taken from the .lttngrc
+If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
file.
.fi
.B OPTIONS:
.nf
file.
.fi
.B OPTIONS:
.nf
Show summary of possible options and commands.
Show summary of possible options and commands.
Apply for the kernel tracer
Apply for the kernel tracer
Apply for the user-space tracer
Apply for the user-space tracer
Context type. You can repeat this option on the command line. Please
Context type. You can repeat this option on the command line. Please
- use "lttng add-context -h" to list all available types.
+ use "lttng add-context \-h" to list all available types.
This sequence of commands will gather a trace executing a kretprobe hooked on
an empty function, gathering PMU counters LLC (Last Level Cache) misses
This sequence of commands will gather a trace executing a kretprobe hooked on
an empty function, gathering PMU counters LLC (Last Level Cache) misses
-information (see lttng add-context --help to see the list of available PMU
+information (see lttng add-context \-\-help to see the list of available PMU
counters).
# lttng create calibrate-function
counters).
# lttng create calibrate-function
-# lttng enable-event calibrate --kernel --function lttng_calibrate_kretprobe
-# lttng add-context --kernel -t perf:LLC-load-misses -t perf:LLC-store-misses \\
- -t perf:LLC-prefetch-misses
+# lttng enable-event calibrate \-\-kernel \-\-function lttng_calibrate_kretprobe
+# lttng add-context \-\-kernel \-t perf:LLC-load-misses \-t perf:LLC-store-misses \\
+ \-t perf:LLC-prefetch-misses
# lttng start
# for a in $(seq 1 10); do \\
# lttng start
# for a in $(seq 1 10); do \\
- lttng calibrate --kernel --function;
+ lttng calibrate \-\-kernel \-\-function;
-# babeltrace $(ls -1drt ~/lttng-traces/calibrate-function-* | tail -n 1)
+# babeltrace $(ls \-1drt ~/lttng-traces/calibrate-function-* | tail \-n 1)
The output from babeltrace can be saved to a text file and opened in a
spreadsheet (e.g. oocalc) to focus on the per-PMU counter delta between
The output from babeltrace can be saved to a text file and opened in a
spreadsheet (e.g. oocalc) to focus on the per-PMU counter delta between
Show summary of possible options and commands.
Show summary of possible options and commands.
Apply for the kernel tracer
Apply for the kernel tracer
Apply for the user-space tracer
Apply for the user-space tracer
Dynamic function entry/return probe (default)
.fi
Dynamic function entry/return probe (default)
.fi
containing the current session name. If NAME is omitted, a session name is
automatically created having this form: 'auto-yyyymmdd-hhmms'.
containing the current session name. If NAME is omitted, a session name is
automatically created having this form: 'auto-yyyymmdd-hhmms'.
-If no \fB-o, --output\fP is specified, the traces will be written in
+If no \fB\-o, \-\-output\fP is specified, the traces will be written in
$HOME/lttng-traces.
.fi
.B OPTIONS:
.nf
$HOME/lttng-traces.
.fi
.B OPTIONS:
.nf
Show summary of possible options and commands.
Show summary of possible options and commands.
Simple listing of options
Simple listing of options
Specify output path for traces
.fi
Specify output path for traces
.fi
Show summary of possible options and commands.
Show summary of possible options and commands.
Simple listing of options
.fi
Simple listing of options
.fi
.nf
Enable tracing channel
.nf
Enable tracing channel
-If \fB-s, --session\fP is omitted, the session name is taken from the .lttngrc
+If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
file.
.fi
.B OPTIONS:
.nf
file.
.fi
.B OPTIONS:
.nf
Simple listing of options
Simple listing of options
Apply to the kernel tracer
Apply to the kernel tracer
Apply to the user-space tracer
Apply to the user-space tracer
Discard event when subbuffers are full (default)
Discard event when subbuffers are full (default)
Flight recorder mode : overwrites events when subbuffers are full
Flight recorder mode : overwrites events when subbuffers are full
Subbuffer size in bytes (default: 4096, kernel default: 262144)
Subbuffer size in bytes (default: 4096, kernel default: 262144)
Number of subbufers (default: 8, kernel default: 4)
Number of subbufers (default: 8, kernel default: 4)
Switch subbuffer timer interval in usec (default: 0)
Switch subbuffer timer interval in usec (default: 0)
Read timer interval in usec (default: 200)
.fi
Read timer interval in usec (default: 200)
.fi
-A tracing event is always assigned to a channel. If \fB-c, --channel\fP is
+A tracing event is always assigned to a channel. If \fB\-c, \-\-channel\fP is
omitted, a default channel named '\fBchannel0\fP' is created and the event is
omitted, a default channel named '\fBchannel0\fP' is created and the event is
-added to it. For the user-space tracer, using \fB-a, --all\fP is the same as
+added to it. For the user-space tracer, using \fB\-a, \-\-all\fP is the same as
-If \fB-s, --session\fP is omitted, the session name is taken from the .lttngrc
+If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
file.
.fi
.B OPTIONS:
.nf
file.
.fi
.B OPTIONS:
.nf
Show summary of possible options and commands.
Show summary of possible options and commands.
Simple listing of options
Simple listing of options
Apply for the kernel tracer
Apply for the kernel tracer
Apply for the user-space tracer
Apply for the user-space tracer
Tracepoint event (default)
- userspace tracer supports wildcards at end of string. Don't forget to
quote to deal with bash expansion.
e.g.:
"*"
"app_component:na*"
Tracepoint event (default)
- userspace tracer supports wildcards at end of string. Don't forget to
quote to deal with bash expansion.
e.g.:
"*"
"app_component:na*"
---probe [addr | symbol | symbol+offset]
+\-\-probe [addr | symbol | symbol+offset]
Dynamic probe. Addr and offset can be octal (0NNN...), decimal (NNN...)
or hexadecimal (0xNNN...)
Dynamic probe. Addr and offset can be octal (0NNN...), decimal (NNN...)
or hexadecimal (0xNNN...)
---function [addr | symbol | symbol+offset]
+\-\-function [addr | symbol | symbol+offset]
Dynamic function entry/return probe. Addr and offset can be octal
(0NNN...), decimal (NNN...) or hexadecimal (0xNNN...)
Dynamic function entry/return probe. Addr and offset can be octal
(0NNN...), decimal (NNN...) or hexadecimal (0xNNN...)
System call event
Enabling syscalls tracing (kernel tracer), you will not be able to disable them
with disable-event. This is a known limitation. You can disable the entire
channel to do the trick.
.fi
System call event
Enabling syscalls tracing (kernel tracer), you will not be able to disable them
with disable-event. This is a known limitation. You can disable the entire
channel to do the trick.
.fi
-.IP "\fBdisable-channel\fP NAME[,NAME2,...] [-k|-u] [OPTIONS]"
+.IP "\fBdisable-channel\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]"
.nf
Disable tracing channel
Disabling a channel makes all event(s) in that channel to stop tracing. You can
enable it back by calling \fBlttng enable-channel NAME\fP again.
.nf
Disable tracing channel
Disabling a channel makes all event(s) in that channel to stop tracing. You can
enable it back by calling \fBlttng enable-channel NAME\fP again.
-If \fB-s, --session\fP is omitted, the session name is taken from the .lttngrc
+If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
file.
.fi
.B OPTIONS:
.nf
file.
.fi
.B OPTIONS:
.nf
Show summary of possible options and commands.
Show summary of possible options and commands.
Simple listing of options
Simple listing of options
Apply for the kernel tracer
Apply for the kernel tracer
Apply for the user-space tracer
.fi
Apply for the user-space tracer
.fi
-.IP "\fBdisable-event\fP NAME[,NAME2,...] [-k|-u] [OPTIONS]"
+.IP "\fBdisable-event\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]"
.nf
Disable tracing event
The event, once disabled, can be re-enabled by calling \fBlttng enable-event
NAME\fP again.
.nf
Disable tracing event
The event, once disabled, can be re-enabled by calling \fBlttng enable-event
NAME\fP again.
-If \fB-s, --session\fP is omitted, the session name is taken from the .lttngrc
+If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
file.
.fi
.B OPTIONS:
.nf
file.
.fi
.B OPTIONS:
.nf
Show summary of possible options and commands.
Show summary of possible options and commands.
Simple listing of options
Simple listing of options
Apply for the kernel tracer
Apply for the kernel tracer
Apply for the user-space tracer
.fi
Apply for the user-space tracer
.fi
-.IP "\fBlist\fP [-k|-u] [SESSION [SESSION_OPTIONS]]"
+.IP "\fBlist\fP [\-k|\-u] [SESSION [SESSION_OPTIONS]]"
-List tracing session informations.
+List tracing session information.
With no arguments, it will list available tracing session(s).
With no arguments, it will list available tracing session(s).
-With -k alone, it will list all available kernel events (except the system
+With \-k alone, it will list all available kernel events (except the system
-With -u alone, it will list all available user-space events from registered
-applications. Here is an example of 'lttng list -u':
+With \-u alone, it will list all available user-space events from registered
+applications. Here is an example of 'lttng list \-u':
PID: 7448 - Name: /tmp/lttng-ust/tests/hello/.libs/lt-hello
ust_tests_hello:tptest_sighandler (type: tracepoint)
PID: 7448 - Name: /tmp/lttng-ust/tests/hello/.libs/lt-hello
ust_tests_hello:tptest_sighandler (type: tracepoint)
Show summary of possible options and commands.
Show summary of possible options and commands.
Simple listing of options
Simple listing of options
Select kernel domain (FIXME : apparition de la notion de "domain" ici)
Select kernel domain (FIXME : apparition de la notion de "domain" ici)
Select user-space domain.
Session options:
Select user-space domain.
Session options:
List details of a channel
List details of a channel
List available domain(s)
.fi
List available domain(s)
.fi
Show summary of possible options and commands.
Show summary of possible options and commands.
Simple listing of options
.fi
Simple listing of options
.fi
Show summary of possible options and commands.
Show summary of possible options and commands.
Simple listing of options
.fi
Simple listing of options
.fi
Show summary of possible options and commands.
Show summary of possible options and commands.
Simple listing of options
.fi
Simple listing of options
.fi
Show summary of possible options and commands.
Show summary of possible options and commands.
Simple listing of options
.fi
Simple listing of options
.fi
Simple listing of options
Simple listing of options
+\-t, \-\-trace-path PATH
Trace directory path for the viewer
Trace directory path for the viewer
Specify viewer and/or options to use
This will completely override the default viewers so
please make sure to specify the full command. The trace
Specify viewer and/or options to use
This will completely override the default viewers so
please make sure to specify the full command. The trace
.PP
.IP "LTTNG_SESSIOND_PATH_ENV"
.PP
.IP "LTTNG_SESSIOND_PATH_ENV"
-Allows to specify the full session daemon binary path to lttng command line
-tool. You can also use --sessiond-path option having the same effect.
+Allows one to specify the full session daemon binary path to lttng command line
+tool. You can also use \-\-sessiond-path option having the same effect.
-lttng is distributed under the GNU public license version 2. See the file
+lttng is distributed under the GNU General Public License version 2. See the file
COPYING for details.
.PP
A Web site is available at http://lttng.org for more information on the LTTng
COPYING for details.
.PP
A Web site is available at http://lttng.org for more information on the LTTng
Special thanks to Michel Dagenais and the DORSAL laboratory at Polytechnique de
Montreal for the LTTng journey.
Special thanks to Michel Dagenais and the DORSAL laboratory at Polytechnique de
Montreal for the LTTng journey.