541c4aedee71d8927377017e1cb396efb2061c84
[lttng-tools.git] / doc / man / lttng-start.1.txt
1 lttng-start(1)
2 ==============
3
4
5 NAME
6 ----
7 lttng-start - Start LTTng tracers
8
9
10 SYNOPSIS
11 --------
12 [verse]
13 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *start* ['SESSION']
14
15
16 DESCRIPTION
17 -----------
18 The `lttng start` command starts the various LTTng tracers for a
19 given inactive tracing session.
20
21 Starting the LTTng tracers has the effect that all enabled event rules
22 within enabled channels can make their target event sources _emit_ trace
23 events. Whether they are recorded to the local file system, sent over
24 the network, or not recorded at all depends on the specific
25 configuration of the tracing session in which tracing is started. See
26 man:lttng-create(1) for different session modes.
27
28 A tracing session with running tracers is said to be _active_. Active
29 tracing sessions can return to the inactive state using the
30 man:lttng-stop(1) command.
31
32 If 'SESSION' is omitted, the LTTng tracers are started for the current
33 tracing session (see man:lttng-create(1) for more information
34 about the current tracing session). Otherwise, they are started for the
35 existing tracing session named 'SESSION'. `lttng list`
36 outputs all the existing tracing sessions (see man:lttng-list(1)).
37
38
39 include::common-cmd-options-head.txt[]
40
41
42 include::common-cmd-help-options.txt[]
43
44
45 include::common-cmd-footer.txt[]
46
47
48 SEE ALSO
49 --------
50 man:lttng-stop(1),
51 man:lttng(1)
This page took 0.039616 seconds and 3 git commands to generate.