Doc: lttng clear man page
[lttng-tools.git] / doc / man / lttng-clear.1.txt
CommitLineData
7b30f09f
JR
1lttng-clear(1)
2===============
3
4
5NAME
6----
7lttng-clear - Clear an LTTng tracing session
8
9
10SYNOPSIS
11--------
12[verse]
13*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *clear* [option:--all | 'SESSION']
14
15
16DESCRIPTION
17-----------
18The `lttng clear` command clears one or more tracing sessions.
19
20If no options are specified, the current tracing session is cleared
21(see man:lttng-create(1) for more information about the current
22tracing session).
23
24If 'SESSION' is specified, the existing tracing session named 'SESSION'
25is cleared.
26
27If the option:--all option is used, *all* the tracing sessions, as listed
28in the output of `lttng list`, are cleared.
29
30Clearing a tracing session removes all tracing data from the tracing buffers and
31remove all local or streamed trace data.
32
33If a session is configured in snapshot mode only the tracing buffers are cleared.
34
35If at least one rotation occurred, only the tracing buffers and the current
36trace chunk is cleared. Previous trace chunks are not cleared.
37
38include::common-cmd-options-head.txt[]
39
40
41option:-a, option:--all::
42 Clear all tracing sessions.
43
44include::common-cmd-help-options.txt[]
45
46
47include::common-cmd-footer.txt[]
48
49
50SEE ALSO
51--------
52man:lttng-rotate(1),
53man:lttng-set-session(1),
54man:lttng(1)
This page took 0.025218 seconds and 5 git commands to generate.