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