lttng-disable-rotation(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 34714f699fac5c39437eca761973ba895fc739d0..a74bee0ed0cd52598be041ccb68d0691a1b10722 100644 (file)
--- a/doc/man/lttng-clear.1.txt
+++ b/doc/man/lttng-clear.1.txt
@@ -1,6 +1,6 @@
 lttng-clear(1)
 ==============
-:revdate: 3 May 2021
+:revdate: 17 May 2021
 
 NAME
 ----
@@ -54,8 +54,10 @@ 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
@@ -67,15 +69,48 @@ option:-a, option:--all::
     tracing session named 'SESSION'.
 
 
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]
+
+
+include::common-lttng-cmd-after-options.txt[]
 
 
-include::common-cmd-footer.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-footer.txt[]
 
 
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
 man:lttng-create(1),
+man:lttng-concepts(7),
 man:lttng-relayd(8)