doc/man: create lttng-destroy(1) and update/fix content
[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* ['GENERAL OPTIONS'] *destroy* [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 linklttng: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 linklttng: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 latter.
32
33 Destroying a tracing session does not destroy the recorded trace data,
34 if any; it frees resources acquired by the session daemon and tracer
35 side, making sure to flush all trace data.
36
37
38 include::common-cmd-options-head.txt[]
39
40
41 option:-a, option:--all::
42 Destroy all tracing sessions.
43
44
45 include::common-cmd-help-options.txt[]
46
47
48 include::common-cmd-footer.txt[]
49
50
51 SEE ALSO
52 --------
53 linklttng:lttng-create(1),
54 linklttng:lttng-set-session(1),
55 linklttng:lttng(1)
This page took 0.032468 seconds and 6 git commands to generate.