lttng-start(1): add usage examples
[lttng-tools.git] / doc / man / lttng-start.1.txt
CommitLineData
30ec772c
PP
1lttng-start(1)
2==============
2be25270 3:revdate: 17 May 2021
30ec772c
PP
4
5
6NAME
7----
484b2a0c 8lttng-start - Start an LTTng tracing session
30ec772c
PP
9
10
11SYNOPSIS
12--------
13[verse]
ce19b9ed 14*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *start* ['SESSION']
30ec772c
PP
15
16
17DESCRIPTION
18-----------
484b2a0c
PP
19The `lttng start` command starts a tracing session, that is, it
20activates the LTTng tracers for:
30ec772c 21
484b2a0c
PP
22With the 'SESSION' argument::
23 The tracing session named 'SESSION'.
30ec772c 24
484b2a0c 25Without the 'SESSION' argument::
188419c4
PP
26 The current tracing session (see man:lttng-concepts(7) to learn more
27 about the current tracing session).
28
29See man:lttng-concepts(7) to learn more about tracing sessions.
30ec772c 30
484b2a0c
PP
31The selected tracing session must be inactive (stopped). A tracing
32session is inactive on creation (see man:lttng-create(1)).
33
484b2a0c
PP
34A `start-session` trigger action can also start a tracing session
35(see man:lttng-add-trigger(1)).
36
2be25270
PP
37See the <<examples,EXAMPLES>> section below for usage examples.
38
484b2a0c 39Stop an active tracing session with the man:lttng-stop(1) command.
30ec772c
PP
40
41
55e06994 42include::common-lttng-cmd-options-head.txt[]
30ec772c
PP
43
44
55e06994 45include::common-lttng-cmd-help-options.txt[]
30ec772c
PP
46
47
55e06994
PP
48include::common-lttng-cmd-after-options.txt[]
49
50
2be25270
PP
51[[examples]]
52EXAMPLES
53--------
54.Start the current tracing session.
55====
56[role="term"]
57----
58$ lttng start
59----
60====
61
62.Start a specific tracing session.
63====
64[role="term"]
65----
66$ lttng start my-session
67----
68====
69
70
55e06994 71include::common-footer.txt[]
30ec772c
PP
72
73
74SEE ALSO
75--------
484b2a0c
PP
76man:lttng(1),
77man:lttng-add-trigger(1),
78man:lttng-create(1),
79man:lttng-enable-event(1),
21b35b3a
PP
80man:lttng-stop(1),
81man:lttng-concepts(7)
This page took 0.049203 seconds and 5 git commands to generate.