[lttng-tools.git] / doc / man / lttng-start.1.txt

lttng-start(1)
==============


NAME
----
lttng-start - Start LTTng tracers


SYNOPSIS
--------
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *start* ['SESSION']


DESCRIPTION
-----------
The `lttng start` command starts the various LTTng tracers for a
given inactive tracing session.

Starting the LTTng tracers has the effect that all enabled event rules
within enabled channels can make their target event sources _emit_ trace
events. Whether they are recorded to the local file system, sent over
the network, or not recorded at all depends on the specific
configuration of the tracing session in which tracing is started. See
man:lttng-create(1) for different session modes.

A tracing session with running tracers is said to be _active_. Active
tracing sessions can return to the inactive state using the
man:lttng-stop(1) command.

If 'SESSION' is omitted, the LTTng tracers are started for the current
tracing session (see man:lttng-create(1) for more information
about the current tracing session). Otherwise, they are started for the
existing tracing session named 'SESSION'. `lttng list`
outputs all the existing tracing sessions (see man:lttng-list(1)).


include::common-cmd-options-head.txt[]


include::common-cmd-help-options.txt[]


include::common-cmd-footer.txt[]


SEE ALSO
--------
man:lttng-stop(1),
man:lttng(1)
Commit	Line	Data
30ec772c PP	1	lttng-start(1)
	2	==============
	3
	4
	5	NAME
	6	----
	7	lttng-start - Start LTTng tracers
	8
	9
	10	SYNOPSIS
	11	--------
	12	[verse]
09693c6d	13	lttng ['linkgenoptions:(GENERAL OPTIONS)'] start ['SESSION']
30ec772c PP	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
74354842	26	man:lttng-create(1) for different session modes.
30ec772c PP	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
74354842	30	man:lttng-stop(1) command.
30ec772c PP	31
30ec772c PP	32	If 'SESSION' is omitted, the LTTng tracers are started for the current
74354842	33	tracing session (see man:lttng-create(1) for more information
30ec772c PP	34	about the current tracing session). Otherwise, they are started for the
30ec772c PP	35	existing tracing session named 'SESSION'. `lttng list`
74354842	36	outputs all the existing tracing sessions (see man:lttng-list(1)).
30ec772c PP	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	--------
74354842 PP	50	man:lttng-stop(1),
74354842 PP	51	man:lttng(1)