Update some manual pages for LTTng-tools 2.13

[lttng-tools.git] / doc / man / lttng-clear.1.txt

lttng-clear(1)
==============
:revdate: 8 April 2021

NAME
----
lttng-clear - Clear a tracing session


SYNOPSIS
--------
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *clear* ['SESSION' | option:--all]


DESCRIPTION
-----------
The `lttng clear` command clears one or more tracing sessions, that is,
it deletes the contents of their tracing buffers and of all their local
and streamed trace data.

The `clear` command clears:

Without any option::
    The current tracing session.
+
See man:lttng-create(1) and man:lttng-set-session(1) to learn more about
the current tracing session.

With the 'SESSION' argument::
    The existing tracing session named 'SESSION'.

With the option:--all option::
    *All* the tracing sessions of your Unix user, as listed in the
    output of `lttng list` (see man:lttng-list(1)).

If a tracing session is configured in snapshot mode (see the
nloption:--snapshot option of the man:lttng-create(1) command), the
`clear` command only clears the tracing buffers.

For a given tracing session, if at least one rotation occurred (see
man:lttng-rotate(1)), the `clear` command only clears its tracing
buffers and its current trace chunk, :not: its archived trace chunks.

NOTE: The nloption:--disallow-clear option and the
`LTTNG_RELAYD_DISALLOW_CLEAR` environment variable of
man:lttng-relayd(8) can disable remote clearing operations. If LTTng
sends tracing data over the network for the selected tracing session(s)
to an LTTng relay daemon configured as such, the `clear` command fails.


include::common-cmd-options-head.txt[]


Recording target
~~~~~~~~~~~~~~~~
option:-a, option:--all::
    Clear all the tracing sessions of your Unix user, as listed in the
    output of man:lttng-list(1), instead of the current tracing session
    or the tracing session named 'SESSION'.


include::common-cmd-help-options.txt[]


include::common-cmd-footer.txt[]


SEE ALSO
--------
man:lttng(1),
man:lttng-create(1),
man:lttng-relayd(8),
man:lttng-rotate(1),
man:lttng-set-session(1)