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

lttng-stop(1)
=============
:revdate: 18 January 2018


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