doc/man: remove lttng.1 (built from lttng.1.txt)
[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]
13*lttng* ['GENERAL OPTIONS'] *start* ['SESSION']
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
26linklttng:lttng-create(1) for different session modes.
27
28A tracing session with running tracers is said to be _active_. Active
29tracing sessions can return to the inactive state using the
30linklttng:lttng-stop(1) command.
31
32If 'SESSION' is omitted, the LTTng tracers are started for the current
33tracing session (see linklttng:lttng-create(1) for more information
34about the current tracing session). Otherwise, they are started for the
35existing tracing session named 'SESSION'. `lttng list`
36outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
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--------
50linklttng:lttng-stop(1),
51linklttng:lttng(1)
This page took 0.033765 seconds and 5 git commands to generate.