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