tests: Move to kernel style SPDX license identifiers
[lttng-tools.git] / doc / man / lttng-destroy.1.txt
CommitLineData
7bf169bd 1lttng-destroy(1)
4605890e
PP
2================
3:revdate: 18 January 2018
7bf169bd
PP
4
5
6NAME
7----
8lttng-destroy - Destroy an LTTng tracing session
9
10
11SYNOPSIS
12--------
13[verse]
d0d2c3e4 14*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *destroy* [option:--no-wait] [option:--all | 'SESSION']
7bf169bd
PP
15
16
17DESCRIPTION
18-----------
19The `lttng destroy` command destroys one or more tracing sessions.
20
21If no options are specified, the current tracing session is destroyed
7c1a4458 22(see man:lttng-create(1) for more information about the current
7bf169bd
PP
23tracing session).
24
25If 'SESSION' is specified, the existing tracing session named 'SESSION'
26is destroyed. `lttng list` outputs all the existing tracing sessions
7c1a4458 27(see man:lttng-list(1)).
7bf169bd
PP
28
29If the option:--all option is used, *all* the tracing sessions, as listed
30in the output of `lttng list`, are destroyed.
31
d0d2c3e4
PP
32Destroying a tracing session stops any tracing running within the
33latter. By default, the implicit man:lttng-stop(1) command invoked by
34the `lttng destroy` command ensures that the tracing session's trace
35data is valid before returning. With the option:--no-wait option, the
36man:lttng-stop(1) command finishes immediately, hence a local trace
37might not be valid when the command is done. In this case, there is no
38way to know when the trace becomes valid.
7bf169bd
PP
39
40Destroying a tracing session does not destroy the recorded trace data,
41if any; it frees resources acquired by the session daemon and tracer
42side, making sure to flush all trace data.
43
980bb5fd
PP
44If at least one rotation occurred during the chosen tracing session's
45lifetime (see man:lttng-rotate(1) and man:lttng-enable-rotation(1)), and
46without the option:--no-wait option, all the tracing session's output
47directory's subdirectories are considered trace chunk archives once the
48command returns: it is safe to read them, modify them, move them, or
49remove them.
50
7bf169bd
PP
51
52include::common-cmd-options-head.txt[]
53
54
55option:-a, option:--all::
56 Destroy all tracing sessions.
57
d0d2c3e4
PP
58option:-n, option:--no-wait::
59 Do not ensure that the chosen tracing session's trace data is valid
60 before returning to the prompt.
61
7bf169bd
PP
62
63include::common-cmd-help-options.txt[]
64
65
66include::common-cmd-footer.txt[]
67
68
69SEE ALSO
70--------
7c1a4458
PP
71man:lttng-create(1),
72man:lttng-set-session(1),
73man:lttng(1)
This page took 0.054337 seconds and 5 git commands to generate.