Update some manual pages for LTTng-tools 2.13

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

diff --git a/doc/man/lttng-clear.1.txt b/doc/man/lttng-clear.1.txt
index 8b63d6c0c54a8d4c11c0c187232fdac634e38881..7cec7f44e13282b747e75f1cd3bf2dd90a3b3d87 100644 (file)
--- a/doc/man/lttng-clear.1.txt
+++ b/doc/man/lttng-clear.1.txt
@@ -1,6 +1,6 @@
 lttng-clear(1)
-===============
-:revdate: 6 November 2019
+==============
+:revdate: 8 April 2021
 
 NAME
 ----
@@ -10,40 +10,55 @@ lttng-clear - Clear a tracing session
 SYNOPSIS
 --------
 [verse]
-*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *clear* [option:--all | 'SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *clear* ['SESSION' | option:--all]
 
 
 DESCRIPTION
 -----------
-The `lttng clear` command clears one or more tracing sessions.
+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.
 
-If no options are specified, the current tracing session is cleared
-(see man:lttng-create(1) for more information about the current
-tracing session).
+The `clear` command clears:
 
-If 'SESSION' is specified, the existing tracing session named 'SESSION'
-is cleared.
+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.
 
-If the option:--all option is used, *all* the tracing sessions, as listed
-in the output of `lttng list`, are cleared.
+With the 'SESSION' argument::
+    The existing tracing session named 'SESSION'.
 
-Clearing a tracing session deletes the contents of the tracing buffers and
-all local or streamed trace data.
+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 session is configured in snapshot mode, only the tracing buffers are cleared.
+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.
 
-If at least one rotation occurred, only the tracing buffers and the current
-trace chunks are cleared. Previous trace chunks are not cleared.
+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.
 
-Note that a lttng-relayd daemon can be configured to disallow clear operations
-using LTTNG_RELAYD_DISALLOW_CLEAR. Clear commands performed on a streaming
-session utilizing such lttng-relayd daemon will fail.
 
 include::common-cmd-options-head.txt[]
 
 
+Recording target
+~~~~~~~~~~~~~~~~
 option:-a, option:--all::
-    Clear all tracing sessions.
+    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[]
 
@@ -53,6 +68,8 @@ 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),
-man:lttng(1)
+man:lttng-set-session(1)