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

lttng-start(1)
==============
:revdate: 7 April 2016


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