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

lttng-stop(1)
=============


NAME
----
lttng-stop - Stop LTTng tracers


SYNOPSIS
--------
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *stop* [option:--no-wait] ['SESSION']


DESCRIPTION
-----------
The `lttng stop` command stops the various LTTng tracers for a given
active tracing session.

Stopping the LTTng tracers has the effect that all enabled event rules
within enabled channels cannot make event sources _emit_ trace events
anymore.

A tracing session with no running tracers is said to be _inactive_.
Inactive tracing sessions can be set active using the
man:lttng-start(1) command.

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

By default, the `lttng stop` command ensures that the tracing session's
trace data is valid before returning to the prompt. With the
option:--no-wait option, the command finishes immediately, hence a local
trace might not be valid when the command is done. In this case, there
is no way to know when the trace becomes valid.


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


option:-n, option:--no-wait::
    Do not ensure that the chosen tracing session's trace data is valid
    before returning to the prompt.


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


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


SEE ALSO
--------
man:lttng-start(1),
man:lttng(1)
Commit	Line	Data
	1	lttng-stop(1)
	2	=============
	3
	4
	5	NAME
	6	----
	7	lttng-stop - Stop LTTng tracers
	8
	9
	10	SYNOPSIS
	11	--------
	12	[verse]
	13	lttng ['linkgenoptions:(GENERAL OPTIONS)'] stop [option:--no-wait] ['SESSION']
	14
	15
	16	DESCRIPTION
	17	-----------
	18	The `lttng stop` command stops the various LTTng tracers for a given
	19	active tracing session.
	20
	21	Stopping the LTTng tracers has the effect that all enabled event rules
	22	within enabled channels cannot make event sources _emit_ trace events
	23	anymore.
	24
	25	A tracing session with no running tracers is said to be _inactive_.
	26	Inactive tracing sessions can be set active using the
	27	man:lttng-start(1) command.
	28
	29	If 'SESSION' is omitted, the LTTng tracers are stopped for the current
	30	tracing session (see man:lttng-create(1) for more information
	31	about the current tracing session). Otherwise, they are stopped for the
	32	existing tracing session named 'SESSION'. `lttng list`
	33	outputs all the existing tracing sessions (see man:lttng-list(1)).
	34
	35	By default, the `lttng stop` command ensures that the tracing session's
	36	trace data is valid before returning to the prompt. With the
	37	option:--no-wait option, the command finishes immediately, hence a local
	38	trace might not be valid when the command is done. In this case, there
	39	is no way to know when the trace becomes valid.
	40
	41
	42	include::common-cmd-options-head.txt[]
	43
	44
	45	option:-n, option:--no-wait::
	46	Do not ensure that the chosen tracing session's trace data is valid
	47	before returning to the prompt.
	48
	49
	50	include::common-cmd-help-options.txt[]
	51
	52
	53	include::common-cmd-footer.txt[]
	54
	55
	56	SEE ALSO
	57	--------
	58	man:lttng-start(1),
	59	man:lttng(1)