Add disable-event to man page and clarify enable-event
[lttng-tools.git] / doc / man / lttng.1
CommitLineData
391b9c72 1.TH "LTTNG" "1" "December 3rd, 2012" "" ""
6991b181
DG
2
3.SH "NAME"
391b9c72 4lttng \(em LTTng 2.1.x tracer control command line tool
6991b181
DG
5
6.SH "SYNOPSIS"
7
8.PP
9.nf
10lttng [OPTIONS] <COMMAND>
11.fi
12.SH "DESCRIPTION"
13
14.PP
15The LTTng project aims at providing highly efficient tracing tools for Linux.
16It's tracers help tracking down performance issues and debugging problems
17involving multiple concurrent processes and threads. Tracing across multiple
18systems is also possible.
19
fa072eae 20The \fBlttng\fP command line tool from the lttng-tools package is used to control
6991b181
DG
21both kernel and user-space tracing. Every interactions with the tracer should
22be done by this tool or by the liblttng-ctl provided with the lttng-tools
23package.
24
25LTTng uses a session daemon (lttng-sessiond(8)), acting as a tracing registry,
50a3b92a 26which allows you to interact with multiple tracers (kernel and user-space)
6991b181
DG
27inside the same container, a tracing session. Traces can be gathered from the
28kernel and/or instrumented applications (lttng-ust(3)). Aggregating and reading
29those traces is done using the babeltrace(1) text viewer.
30
50a3b92a
DG
31We introduce the notion of \fBtracing domains\fP which is essentially a type of
32tracer (kernel or user space for now). In the future, we could see a third
33tracer being for instance an hypervisor. For some commands, you'll need to
34specify on which domain the command applies (-u or -k). For instance, enabling
35a kernel event, you must specify the kernel domain to the command so we know
36for which tracer this event is for.
37
6991b181
DG
38In order to trace the kernel, the session daemon needs to be running as root.
39LTTng provides the use of a \fBtracing group\fP (default: tracing). Whomever is
40in that group can interact with the root session daemon and thus trace the
41kernel. Session daemons can co-exist meaning that you can have a session daemon
fa072eae
YB
42running as Alice that can be used to trace her applications along side with a
43root daemon or even a Bob daemon. We highly recommend to start the session
6991b181
DG
44daemon at boot time for stable and long term tracing.
45
46Every user-space applications instrumented with lttng-ust(3), will
47automatically register to the session daemon. This feature gives you the
48ability to list available traceable applications and tracepoints on a per user
49basis. (See \fBlist\fP command).
50.SH "OPTIONS"
51
52.PP
53This program follow the usual GNU command line syntax with long options starting with
54two dashes. Below is a summary of the available options.
55.PP
56
57.TP
c9e32613 58.BR "\-h, \-\-help"
6991b181
DG
59Show summary of possible options and commands.
60.TP
c9e32613 61.BR "\-v, \-\-verbose"
6991b181 62Increase verbosity.
d829b38c 63Three levels of verbosity are available which are triggered by putting additional v to
fa072eae 64the option (\-vv or \-vvv)
6991b181 65.TP
c9e32613 66.BR "\-q, \-\-quiet"
6991b181
DG
67Suppress all messages (even errors).
68.TP
c9e32613 69.BR "\-g, \-\-group NAME"
6991b181
DG
70Set unix tracing group name. (default: tracing)
71.TP
c9e32613 72.BR "\-n, \-\-no-sessiond"
6991b181
DG
73Don't automatically spawn a session daemon.
74.TP
391b9c72 75.BR "\-\-sessiond\-path PATH"
6991b181
DG
76Set session daemon full binary path.
77.TP
c9e32613 78.BR "\-\-list\-options"
6991b181
DG
79Simple listing of lttng options.
80.TP
c9e32613 81.BR "\-\-list\-commands"
6991b181
DG
82Simple listing of lttng commands.
83.SH "COMMANDS"
84
85.TP
86\fBadd-context\fP
87.nf
88Add context to event(s) and/or channel(s).
89
391b9c72
DG
90A context is basically extra information appended to a channel. For instance,
91you could ask the tracer to add the PID information for all events in a
92channel. You can also add performance monitoring unit counters (perf PMU) using
93the perf kernel API).
6991b181
DG
94
95For example, this command will add the context information 'prio' and two perf
96counters (hardware branch misses and cache misses), to all events in the trace
97data output:
98
c9e32613 99# lttng add-context \-k \-t prio \-t perf:branch-misses \-t perf:cache-misses
6991b181 100
c9e32613 101Please take a look at the help (\-h/\-\-help) for a detailed list of available
6991b181
DG
102contexts.
103
391b9c72
DG
104If no channel is given (\-c), the context is added to all channels. Otherwise
105the context will be added only to the given channel (\-c).
6991b181 106
c9e32613 107If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181
DG
108file.
109.fi
110
111.B OPTIONS:
112
113.nf
c9e32613 114\-h, \-\-help
6991b181 115 Show summary of possible options and commands.
c9e32613 116\-s, \-\-session NAME
6991b181 117 Apply on session name.
c9e32613 118\-c, \-\-channel NAME
6991b181 119 Apply on channel name.
c9e32613 120\-k, \-\-kernel
6991b181 121 Apply for the kernel tracer
c9e32613 122\-u, \-\-userspace
6991b181 123 Apply for the user-space tracer
c9e32613 124\-t, \-\-type TYPE
6991b181 125 Context type. You can repeat this option on the command line. Please
c9e32613 126 use "lttng add-context \-h" to list all available types.
6991b181
DG
127.fi
128
129.IP
130
131.IP "\fBcalibrate\fP"
132.nf
133Quantify LTTng overhead
134
135The LTTng calibrate command can be used to find out the combined average
136overhead of the LTTng tracer and the instrumentation mechanisms used. This
137overhead can be calibrated in terms of time or using any of the PMU performance
138counter available on the system.
139
140For now, the only calibration implemented is that of the kernel function
141instrumentation (kretprobes).
142
143* Calibrate kernel function instrumentation
144
145Let's use an example to show this calibration. We use an i7 processor with 4
146general-purpose PMU registers. This information is available by issuing dmesg,
147looking for "generic registers".
148
149This sequence of commands will gather a trace executing a kretprobe hooked on
150an empty function, gathering PMU counters LLC (Last Level Cache) misses
c9e32613 151information (see lttng add-context \-\-help to see the list of available PMU
6991b181
DG
152counters).
153
154# lttng create calibrate-function
c9e32613
DG
155# lttng enable-event calibrate \-\-kernel \-\-function lttng_calibrate_kretprobe
156# lttng add-context \-\-kernel \-t perf:LLC-load-misses \-t perf:LLC-store-misses \\
157 \-t perf:LLC-prefetch-misses
6991b181
DG
158# lttng start
159# for a in $(seq 1 10); do \\
c9e32613 160 lttng calibrate \-\-kernel \-\-function;
6991b181
DG
161 done
162# lttng destroy
c9e32613 163# babeltrace $(ls \-1drt ~/lttng-traces/calibrate-function-* | tail \-n 1)
6991b181
DG
164
165The output from babeltrace can be saved to a text file and opened in a
166spreadsheet (e.g. oocalc) to focus on the per-PMU counter delta between
167consecutive "calibrate_entry" and "calibrate_return" events. Note that these
168counters are per-CPU, so scheduling events would need to be present to account
169for migration between CPU. Therefore, for calibration purposes, only events
170staying on the same CPU must be considered.
171
172The average result, for the i7, on 10 samples:
173
174 Average Std.Dev.
175perf_LLC_load_misses: 5.0 0.577
176perf_LLC_store_misses: 1.6 0.516
177perf_LLC_prefetch_misses: 9.0 14.742
178
179As we can notice, the load and store misses are relatively stable across runs
180(their standard deviation is relatively low) compared to the prefetch misses.
181We can conclude from this information that LLC load and store misses can be
182accounted for quite precisely, but prefetches within a function seems to behave
183too erratically (not much causality link between the code executed and the CPU
184prefetch activity) to be accounted for.
185.fi
186
187.B OPTIONS:
188
189.nf
c9e32613 190\-h, \-\-help
6991b181 191 Show summary of possible options and commands.
c9e32613 192\-k, \-\-kernel
6991b181 193 Apply for the kernel tracer
c9e32613 194\-u, \-\-userspace
6991b181 195 Apply for the user-space tracer
c9e32613 196\-\-function
6991b181
DG
197 Dynamic function entry/return probe (default)
198.fi
199
200.IP
201
6b8f2e64 202.IP "\fBcreate\fP [NAME] [OPTIONS]
6991b181
DG
203.nf
204Create tracing session.
205
206A tracing session contains channel(s) which contains event(s). It is domain
207agnostic meaning that you can enable channels and events for either the
208user-space tracer and/or the kernel tracer. It acts like a container
209aggregating multiple tracing sources.
210
211On creation, a \fB.lttngrc\fP file is created in your $HOME directory
212containing the current session name. If NAME is omitted, a session name is
fa072eae 213automatically created having this form: 'auto-yyyymmdd-hhmmss'.
6991b181 214
c9e32613 215If no \fB\-o, \-\-output\fP is specified, the traces will be written in
6991b181
DG
216$HOME/lttng-traces.
217.fi
218
219.B OPTIONS:
220
221.nf
c9e32613 222\-h, \-\-help
6991b181 223 Show summary of possible options and commands.
c9e32613 224\-\-list-options
6991b181 225 Simple listing of options
c9e32613 226\-o, \-\-output PATH
6991b181 227 Specify output path for traces
6b8f2e64
DG
228
229Using these options, each API call can be controlled individually. For
230instance, \-C does not enable the consumer automatically. You'll need the \-e
231option for that.
232
233\-U, \-\-set-uri=URL
234 Set URL for the enable-consumer destination. It is persistent for the
235 session lifetime. Redo the command to change it. This will set both
236 data and control URL for network.
237\-C, \-\-ctrl-url=URL
238 Set control path URL. (Must use -D also)
239\-D, \-\-data-url=URL
240 Set data path URL. (Must use -C also)
241 \-\-no-consumer
242 Don't activate a consumer for this session.
243 \-\-disable-consumer
244 Disable consumer for this session.
245
246See \fBenable-consumer\fP command below for the supported URL format.
247
248.B EXAMPLES:
249
250# lttng create -U net://192.168.1.42
251Uses TCP and default ports for the given destination.
252
253# lttng create -U net6://[fe80::f66d:4ff:fe53:d220]
254Uses TCP, default ports and IPv6.
255
256# lttng create s1 -U net://myhost.com:3229
257Create session s1 and set its consumer to myhost.com on port 3229 for control.
6991b181
DG
258.fi
259
260.IP
261
262.IP "\fBdestroy\fP [OPTIONS] [NAME]"
263.nf
264Teardown tracing session
265
266Free memory on the session daemon and tracer side. It's gone!
267
268If NAME is omitted, the session name is taken from the .lttngrc file.
269.fi
270
271.B OPTIONS:
272
273.nf
c9e32613 274\-h, \-\-help
6991b181 275 Show summary of possible options and commands.
a3c5b534
FG
276\-a, \-\-all
277 Destroy all sessions
c9e32613 278\-\-list-options
6991b181
DG
279 Simple listing of options
280.fi
281
282.IP
283
284.IP "\fBenable-channel\fP NAME[,NAME2,...] [-k|-u] [OPTIONS]"
285.nf
286Enable tracing channel
287
b883c01b
DG
288To enable event, you must first enable a channel which contains event(s).
289
c9e32613 290If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181
DG
291file.
292.fi
293
294.B OPTIONS:
295
296.nf
c9e32613 297\-h, \-\-help
6991b181 298 Show this help
c9e32613 299\-\-list-options
6991b181 300 Simple listing of options
391b9c72 301\-s, \-\-session NAME
6991b181 302 Apply on session name
c9e32613 303\-k, \-\-kernel
6991b181 304 Apply to the kernel tracer
c9e32613 305\-u, \-\-userspace
6991b181
DG
306 Apply to the user-space tracer
307
c9e32613 308\-\-discard
6991b181 309 Discard event when subbuffers are full (default)
c9e32613 310\-\-overwrite
6991b181 311 Flight recorder mode : overwrites events when subbuffers are full
391b9c72 312\-\-subbuf-size SIZE
6991b181 313 Subbuffer size in bytes (default: 4096, kernel default: 262144)
391b9c72 314\-\-num-subbuf NUM
d829b38c 315 Number of subbuffers (default: 4)
93e6c8a0 316 Needs to be a power of 2 for kernel and ust tracers
391b9c72 317\-\-switch-timer USEC
6991b181 318 Switch subbuffer timer interval in usec (default: 0)
93e6c8a0 319 Needs to be a power of 2 for kernel and ust tracers
391b9c72 320\-\-read-timer USEC
6991b181 321 Read timer interval in usec (default: 200)
391b9c72
DG
322\-\-output TYPE
323 Channel output type. Possible values: mmap, splice
6991b181
DG
324.fi
325
326.IP
327
6b8f2e64
DG
328.IP "\fBenable-consumer\fP [-u|-k] [URL] [OPTIONS]"
329.nf
330Enable a consumer for the tracing session and domain.
331
332By default, every tracing session has a consumer attached to it using the local
333filesystem as output. The trace is written in $HOME/lttng-traces. This command
334allows the user to specify a specific URL after the session was created for a
335specific domain. If no domain is specified, the consumer is applied on all
336domains.
337
338Without options, the behavior is to enable a consumer to the current URL. The
339default URL is the local filesystem at the path of the session mentioned above.
340
341The enable-consumer feature supports both local and network transport. You must
342have a running \fBlttng-relayd(8)\fP for network transmission or any other daemon
343that can understand the streaming protocol of LTTng.
344.fi
345
346.B OPTIONS:
347
348.nf
349\-h, \-\-help
350 Show summary of possible options and commands.
351\-\-list-options
352 Simple listing of options
391b9c72 353\-s, \-\-session NAME
6b8f2e64
DG
354 Apply on session name
355\-k, \-\-kernel
356 Apply for the kernel tracer
357\-u, \-\-userspace
358 Apply for the user-space tracer
359
360Using these options, each API call can be controlled individually. For
361instance, \-C does not enable the consumer automatically. You'll need the \-e
362option for that.
363
364\-U, \-\-set-uri=URL
365 Set URL for the enable-consumer destination. It is persistent for the
366 session lifetime. Redo the command to change it. This will set both
367 data and control URL for network.
368\-C, \-\-ctrl-url=URL
369 Set control path URL. (Must use -D also)
370\-D, \-\-data-url=URL
371 Set data path URL. (Must use -C also)
372\-e, \-\-enable
373 Enable consumer
374
375.B URL FORMAT:
376
377proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]
378
379Supported protocols are (proto):
380> file://...
381 Local filesystem full path.
382
391b9c72 383> net://...
6b8f2e64
DG
384 This will use the default network transport layer which is TCP for both
385 control (PORT1) and data port (PORT2). The default ports are
391b9c72 386 respectively 5342 and 5343. Note that net[6]:// is not yet supported.
6b8f2e64
DG
387
388> tcp[6]://...
389 Can only be used with -C and -D together
390
391NOTE: IPv6 address MUST be enclosed in brackets '[]' (rfc2732)
392
393.B EXAMPLES:
394
395$ lttng enable-consumer -u net://192.168.1.42
396
397Uses TCP and default ports for user space tracing (-u) where the IP address
398above is the destination machine where the traces will be streamed and a
399\fBlttng-relayd(8)\fP is listening.
400.fi
401
6991b181
DG
402.IP "\fBenable-event\fP NAME[,NAME2,...] [-k|-u] [OPTIONS]"
403.nf
404Enable tracing event
405
c9e32613 406A tracing event is always assigned to a channel. If \fB\-c, \-\-channel\fP is
6991b181 407omitted, a default channel named '\fBchannel0\fP' is created and the event is
c9e32613 408added to it. For the user-space tracer, using \fB\-a, \-\-all\fP is the same as
6991b181
DG
409using the wildcard "*".
410
c9e32613 411If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181
DG
412file.
413.fi
414
415.B OPTIONS:
416
417.nf
c9e32613 418\-h, \-\-help
6991b181 419 Show summary of possible options and commands.
c9e32613 420\-\-list-options
6991b181 421 Simple listing of options
391b9c72 422\-s, \-\-session NAME
6991b181 423 Apply on session name
391b9c72 424\-c, \-\-channel NAME
6991b181 425 Apply on channel name
c9e32613 426\-a, \-\-all
c5650942
DG
427 Enable all tracepoints and syscalls. This actually enable a single
428 wildcard event "*".
c9e32613 429\-k, \-\-kernel
6991b181 430 Apply for the kernel tracer
c9e32613 431\-u, \-\-userspace
6991b181
DG
432 Apply for the user-space tracer
433
c9e32613 434\-\-tracepoint
6991b181
DG
435 Tracepoint event (default)
436 - userspace tracer supports wildcards at end of string. Don't forget to
437 quote to deal with bash expansion.
438 e.g.:
439 "*"
440 "app_component:na*"
391b9c72
DG
441\-\-loglevel NAME
442 Tracepoint loglevel range from 0 to loglevel. Listed in the help (\-h).
443\-\-loglevel-only NAME
444 Tracepoint loglevel (only this loglevel).
445
446 The loglevel or loglevel-only options should be combined with a
447 tracepoint name or tracepoint wildcard.
c9e32613 448\-\-probe [addr | symbol | symbol+offset]
6991b181
DG
449 Dynamic probe. Addr and offset can be octal (0NNN...), decimal (NNN...)
450 or hexadecimal (0xNNN...)
c9e32613 451\-\-function [addr | symbol | symbol+offset]
6991b181
DG
452 Dynamic function entry/return probe. Addr and offset can be octal
453 (0NNN...), decimal (NNN...) or hexadecimal (0xNNN...)
c9e32613 454\-\-syscall
6b8f2e64
DG
455 System call event. Enabling syscalls tracing (kernel tracer), you will
456 not be able to disable them with disable-event. This is a known
457 limitation. You can disable the entire channel to do the trick.
9bd578f5 458
919e300c 459\-\-filter 'expression'
6b8f2e64
DG
460 Set a filter on a newly enabled event. Filter expression on event
461 fields, event recording depends on evaluation. Only specify on first
462 activation of a given event within a session. Filter only allowed when
463 enabling events within a session before tracing is started. If the
464 filter fails to link with the event within the traced domain, the event
465 will be discarded. Currently, filter is only implemented for the
466 user-space tracer.
467
468 Expression examples:
469
470 'intfield > 500 && intfield < 503'
471 '(stringfield == "test" || intfield != 10) && intfield > 33'
472 'doublefield > 1.1 && intfield < 5.3'
473
474 Wildcards are allowed at the end of strings:
475 'seqfield1 == "te*"'
476 In string literals, the escape character is a '\\'. Use '\\*' for
477 the '*' character, and '\\\\' for the '\\' character.
6991b181
DG
478.fi
479
c9e32613 480.IP "\fBdisable-channel\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]"
6991b181
DG
481.nf
482Disable tracing channel
483
484Disabling a channel makes all event(s) in that channel to stop tracing. You can
485enable it back by calling \fBlttng enable-channel NAME\fP again.
486
c9e32613 487If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181
DG
488file.
489.fi
490
491.B OPTIONS:
492
493.nf
c9e32613 494\-h, \-\-help
6991b181 495 Show summary of possible options and commands.
c9e32613 496\-\-list-options
6991b181 497 Simple listing of options
6b8f2e64
DG
498\-s, \-\-session NAME
499 Apply on session name
500\-k, \-\-kernel
501 Apply for the kernel tracer
502\-u, \-\-userspace
503 Apply for the user-space tracer
504.fi
505
506.IP "\fBdisable-consumer\fP [\-k|\-u] [OPTIONS]"
507.nf
508Disable the consumer of a tracing session.
509
510This call MUST be done BEFORE tracing has started.
511.fi
512
513.B OPTIONS:
514
515.nf
516\-h, \-\-help
517 Show summary of possible options and commands.
518\-\-list-options
519 Simple listing of options
520\-s, \-\-session NAME
6991b181 521 Apply on session name
c9e32613 522\-k, \-\-kernel
6991b181 523 Apply for the kernel tracer
c9e32613 524\-u, \-\-userspace
6991b181
DG
525 Apply for the user-space tracer
526.fi
527
c9e32613 528.IP "\fBdisable-event\fP NAME[,NAME2,...] [\-k|\-u] [OPTIONS]"
6991b181
DG
529.nf
530Disable tracing event
531
532The event, once disabled, can be re-enabled by calling \fBlttng enable-event
533NAME\fP again.
534
c9e32613 535If \fB\-s, \-\-session\fP is omitted, the session name is taken from the .lttngrc
6991b181
DG
536file.
537.fi
538
539.B OPTIONS:
540
541.nf
c9e32613 542\-h, \-\-help
6991b181 543 Show summary of possible options and commands.
c9e32613 544\-\-list-options
6991b181 545 Simple listing of options
391b9c72 546\-s, \-\-session NAME
6991b181 547 Apply on session name
c5650942
DG
548\-a, \-\-all-events
549 Disable all events. This does NOT disable "*" but rather
550 every known events of the session.
c9e32613 551\-k, \-\-kernel
6991b181 552 Apply for the kernel tracer
c9e32613 553\-u, \-\-userspace
6991b181
DG
554 Apply for the user-space tracer
555.fi
556
c9e32613 557.IP "\fBlist\fP [\-k|\-u] [SESSION [SESSION_OPTIONS]]"
6991b181 558.nf
c9e32613 559List tracing session information.
6991b181
DG
560
561With no arguments, it will list available tracing session(s).
562
fa072eae
YB
563With the session name, it will display the details of the session including
564the trace file path, the associated channels and their state (activated
d829b38c 565and deactivated), the activated events and more.
fa072eae 566
c9e32613 567With \-k alone, it will list all available kernel events (except the system
6991b181 568calls events).
c9e32613
DG
569With \-u alone, it will list all available user-space events from registered
570applications. Here is an example of 'lttng list \-u':
6991b181
DG
571
572PID: 7448 - Name: /tmp/lttng-ust/tests/hello/.libs/lt-hello
573 ust_tests_hello:tptest_sighandler (type: tracepoint)
574 ust_tests_hello:tptest (type: tracepoint)
575
576You can now enable any event listed by using the name :
577\fBust_tests_hello:tptest\fP.
578.fi
579
580.B OPTIONS:
581
582.nf
c9e32613 583\-h, \-\-help
6991b181 584 Show summary of possible options and commands.
c9e32613 585\-\-list-options
6991b181 586 Simple listing of options
c9e32613 587\-k, \-\-kernel
d829b38c 588 Select kernel domain
c9e32613 589\-u, \-\-userspace
6991b181
DG
590 Select user-space domain.
591
6b8f2e64
DG
592.B SESSION OPTIONS:
593
c9e32613 594\-c, \-\-channel NAME
6991b181 595 List details of a channel
c9e32613 596\-d, \-\-domain
6991b181
DG
597 List available domain(s)
598.fi
599
600.IP "\fBset-session\fP NAME"
601.nf
602Set current session name
603
604Will change the session name in the .lttngrc file.
605.fi
606
607.B OPTIONS:
608
609.nf
c9e32613 610\-h, \-\-help
6991b181 611 Show summary of possible options and commands.
c9e32613 612\-\-list-options
6991b181
DG
613 Simple listing of options
614.fi
615
616.IP
617
6b8f2e64 618.IP "\fBstart\fP [NAME] [OPTIONS]"
6991b181
DG
619.nf
620Start tracing
621
622It will start tracing for all tracers for a specific tracing session.
623
624If NAME is omitted, the session name is taken from the .lttngrc file.
625.fi
626
627.B OPTIONS:
628
629.nf
c9e32613 630\-h, \-\-help
6991b181 631 Show summary of possible options and commands.
c9e32613 632\-\-list-options
6991b181
DG
633 Simple listing of options
634.fi
635
636.IP
637
6b8f2e64 638.IP "\fBstop\fP [NAME] [OPTIONS]"
6991b181
DG
639.nf
640Stop tracing
641
391b9c72
DG
642It will stop tracing for all tracers for a specific tracing session. Before
643returning, the command checks for data availability meaning that it will wait
644until the trace is readable for the session. Use \-\-no-wait to avoid this
645behavior.
6991b181
DG
646
647If NAME is omitted, the session name is taken from the .lttngrc file.
648.fi
649
650.B OPTIONS:
651
652.nf
c9e32613 653\-h, \-\-help
6991b181 654 Show summary of possible options and commands.
c9e32613 655\-\-list-options
6991b181 656 Simple listing of options
391b9c72
DG
657\-\-no-wait
658 Don't wait for data availability.
6991b181
DG
659.fi
660
661.IP
662
663.IP "\fBversion\fP"
664.nf
665Show version information
666.fi
667
668.B OPTIONS:
669
670.nf
c9e32613 671\-h, \-\-help
6991b181 672 Show summary of possible options and commands.
c9e32613 673\-\-list-options
6991b181
DG
674 Simple listing of options
675.fi
676
677.IP
678
679.IP "\fBview\fP [SESSION_NAME] [OPTIONS]"
680.nf
681View traces of a tracing session
682
683By default, the babeltrace viewer will be used for text viewing.
684
fa072eae
YB
685If SESSION_NAME is omitted, the session name is taken from the .lttngrc file.
686
6991b181
DG
687.fi
688
689.B OPTIONS:
690
691.nf
c9e32613 692\-h, \-\-help
6991b181 693 Show this help
c9e32613 694\-\-list-options
6991b181 695 Simple listing of options
c9e32613 696\-t, \-\-trace-path PATH
6991b181 697 Trace directory path for the viewer
c9e32613 698\-e, \-\-viewer CMD
6991b181
DG
699 Specify viewer and/or options to use
700 This will completely override the default viewers so
701 please make sure to specify the full command. The trace
702 directory path of the session will be appended at the end
703 to the arguments
704.fi
705
c206d957 706.SH "EXIT VALUES"
6b8f2e64
DG
707On success 0 is returned and a positive value on error. Value of 1 means a command
708error, 2 an undefined command, 3 a fatal error and 4 a command warning meaning that
709something went wrong during the command.
c206d957 710
6b8f2e64
DG
711Any other value above 10, please refer to
712.BR <lttng/lttng-error.h>
713for a detailed list or use lttng_strerror() to get a human readable string of
714the error code.
c206d957 715
c206d957 716.PP
6991b181
DG
717.SH "ENVIRONMENT VARIABLES"
718
719.PP
720Note that all command line options override environment variables.
721.PP
722
723.PP
05833633 724.IP "LTTNG_SESSIOND_PATH"
c9e32613
DG
725Allows one to specify the full session daemon binary path to lttng command line
726tool. You can also use \-\-sessiond-path option having the same effect.
6991b181 727.SH "SEE ALSO"
6b8f2e64
DG
728.BR babeltrace(1),
729.BR lttng-ust(3),
730.BR lttng-sessiond(8),
731.BR lttng-relayd(8),
732.BR lttng-health-check(3)
6991b181
DG
733.SH "BUGS"
734
6991b181 735If you encounter any issues or usability problem, please report it on our
6b8f2e64
DG
736mailing list <lttng-dev@lists.lttng.org> to help improve this project or
737at https://bugs.lttng.org which is a bugtracker.
6991b181
DG
738.SH "CREDITS"
739
740.PP
c9e32613 741lttng is distributed under the GNU General Public License version 2. See the file
6991b181
DG
742COPYING for details.
743.PP
744A Web site is available at http://lttng.org for more information on the LTTng
745project.
746.PP
747You can also find our git tree at http://git.lttng.org.
748.PP
749Mailing lists for support and development: <lttng-dev@lists.lttng.org>.
750.PP
751You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
752.PP
753.SH "THANKS"
754
755.PP
756Thanks to Yannick Brosseau without whom this project would never have been so
757lean and mean! Also thanks to the Ericsson teams working on tracing which
fa072eae 758helped us greatly with detailed bug reports and unusual test cases.
6991b181
DG
759
760Thanks to our beloved packager Alexandre Montplaisir-Goncalves (Ubuntu and PPA
761maintainer) and Jon Bernard for our Debian packages.
762
763Special thanks to Michel Dagenais and the DORSAL laboratory at Polytechnique de
764Montreal for the LTTng journey.
c9e32613 765.PP
6991b181
DG
766.SH "AUTHORS"
767
768.PP
769lttng-tools was originally written by Mathieu Desnoyers, Julien Desfossez and
770David Goulet. More people have since contributed to it. It is currently
771maintained by David Goulet <dgoulet@efficios.com>.
772.PP
This page took 0.09439 seconds and 4 git commands to generate.