LTTNG-RELAYD(8): document the --fd-pool-size option
[lttng-tools.git] / doc / man / lttng-clear.1.txt
CommitLineData
73b818e7
JR
1lttng-clear(1)
2===============
3:revdate: 6 November 2019
4
5NAME
6----
7lttng-clear - Clear a 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 deletes the contents of the tracing buffers and
31all 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 chunks are cleared. Previous trace chunks are not cleared.
37
38Note that a lttng-relayd daemon can be configured to disallow clear operations
39using LTTNG_RELAYD_DISALLOW_CLEAR. Clear commands performed on a streaming
40session utilizing such lttng-relayd daemon will fail.
41
42include::common-cmd-options-head.txt[]
43
44
45option:-a, option:--all::
46 Clear all tracing sessions.
47
48include::common-cmd-help-options.txt[]
49
50
51include::common-cmd-footer.txt[]
52
53
54SEE ALSO
55--------
56man:lttng-rotate(1),
57man:lttng-set-session(1),
58man:lttng(1)
This page took 0.0239 seconds and 4 git commands to generate.