lttng-enable-channel(1): add usage examples

[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 7cec7f44e13282b747e75f1cd3bf2dd90a3b3d87..a74bee0ed0cd52598be041ccb68d0691a1b10722 100644 (file)
--- a/doc/man/lttng-clear.1.txt
+++ b/doc/man/lttng-clear.1.txt
@@ -1,10 +1,10 @@
 lttng-clear(1)
 ==============
-:revdate: 8 April 2021
+:revdate: 17 May 2021
 
 NAME
 ----
-lttng-clear - Clear a tracing session
+lttng-clear - Clear an LTTng tracing session
 
 
 SYNOPSIS
@@ -19,27 +19,33 @@ 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.
 
+See man:lttng-concepts(7) to learn more about tracing sessions.
+
 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.
+See man:lttng-concepts(7) to learn more about the current tracing
+session.
 
 With the 'SESSION' argument::
-    The existing tracing session named 'SESSION'.
+    The 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)).
+    *All* the tracing sessions of the connected session daemon for your
+    Unix user, or for all users if your Unix user is `root`, as listed
+    in the output of `lttng list` (see man:lttng-list(1)).
++
+See the ``Session daemon connection'' section of man:lttng(1) to learn
+how a user application connects to a session daemon.
 
 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
+man:lttng-concepts(7)), 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
@@ -48,28 +54,63 @@ 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.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 
-include::common-cmd-options-head.txt[]
+include::common-lttng-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'.
+    Clear all the tracing sessions of your Unix user, or of all users if
+    your Unix user is `root`, as listed in the output of
+    man:lttng-list(1), instead of the current tracing session or the
+    tracing session named 'SESSION'.
+
+
+include::common-lttng-cmd-help-options.txt[]
 
 
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+[[examples]]
+EXAMPLES
+--------
+.Clear the current tracing session.
+====
+[role="term"]
+----
+$ lttng clear
+----
+====
+
+.Clear a specific tracing session.
+====
+[role="term"]
+----
+$ lttng clear my-session
+----
+====
+
+.Clear all tracing sessions.
+====
+See the option:--all option.
+
+[role="term"]
+----
+$ lttng clear --all
+----
+====
 
 
-include::common-cmd-footer.txt[]
+include::common-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-concepts(7),
+man:lttng-relayd(8)