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

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


NAME
----
lttng-destroy - Destroy an LTTng tracing session


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


DESCRIPTION
-----------
The `lttng destroy` command destroys one or more tracing sessions.

If no options are specified, the current tracing session is destroyed
(see man:lttng-create(1) for more information about the current
tracing session).

If 'SESSION' is specified, the existing tracing session named 'SESSION'
is destroyed. `lttng list` outputs all the existing tracing sessions
(see man:lttng-list(1)).

If the option:--all option is used, *all* the tracing sessions, as listed
in the output of `lttng list`, are destroyed.

Destroying a tracing session stops any tracing running within the
latter. By default, the implicit man:lttng-stop(1) command invoked by
the `lttng destroy` command ensures that the tracing session's trace
data is valid before returning. With the option:--no-wait option, the
man:lttng-stop(1) 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.

Destroying a tracing session does not destroy the recorded trace data,
if any; it frees resources acquired by the session daemon and tracer
side, making sure to flush all trace data.


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


option:-a, option:--all::
    Destroy all tracing sessions.

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-create(1),
man:lttng-set-session(1),
man:lttng(1)
Commit	Line	Data
	1	lttng-destroy(1)
	2	================
	3	:revdate: 18 January 2018
	4
	5
	6	NAME
	7	----
	8	lttng-destroy - Destroy an LTTng tracing session
	9
	10
	11	SYNOPSIS
	12	--------
	13	[verse]
	14	lttng ['linkgenoptions:(GENERAL OPTIONS)'] destroy [option:--no-wait] [option:--all \| 'SESSION']
	15
	16
	17	DESCRIPTION
	18	-----------
	19	The `lttng destroy` command destroys one or more tracing sessions.
	20
	21	If no options are specified, the current tracing session is destroyed
	22	(see man:lttng-create(1) for more information about the current
	23	tracing session).
	24
	25	If 'SESSION' is specified, the existing tracing session named 'SESSION'
	26	is destroyed. `lttng list` outputs all the existing tracing sessions
	27	(see man:lttng-list(1)).
	28
	29	If the option:--all option is used, all the tracing sessions, as listed
	30	in the output of `lttng list`, are destroyed.
	31
	32	Destroying a tracing session stops any tracing running within the
	33	latter. By default, the implicit man:lttng-stop(1) command invoked by
	34	the `lttng destroy` command ensures that the tracing session's trace
	35	data is valid before returning. With the option:--no-wait option, the
	36	man:lttng-stop(1) command finishes immediately, hence a local trace
	37	might not be valid when the command is done. In this case, there is no
	38	way to know when the trace becomes valid.
	39
	40	Destroying a tracing session does not destroy the recorded trace data,
	41	if any; it frees resources acquired by the session daemon and tracer
	42	side, making sure to flush all trace data.
	43
	44
	45	include::common-cmd-options-head.txt[]
	46
	47
	48	option:-a, option:--all::
	49	Destroy all tracing sessions.
	50
	51	option:-n, option:--no-wait::
	52	Do not ensure that the chosen tracing session's trace data is valid
	53	before returning to the prompt.
	54
	55
	56	include::common-cmd-help-options.txt[]
	57
	58
	59	include::common-cmd-footer.txt[]
	60
	61
	62	SEE ALSO
	63	--------
	64	man:lttng-create(1),
	65	man:lttng-set-session(1),
	66	man:lttng(1)