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