lttng-clear(1): add usage examples
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Mon, 17 May 2021 18:04:21 +0000 (14:04 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Wed, 19 May 2021 15:21:38 +0000 (11:21 -0400)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: Id410c79fddb88de87edda333bec9ef59b6f5afc9

doc/man/lttng-clear.1.txt

index 4fb52671aca669ce5cd79e07e9cb89c993a25066..a74bee0ed0cd52598be041ccb68d0691a1b10722 100644 (file)
@@ -1,6 +1,6 @@
 lttng-clear(1)
 ==============
-:revdate: 3 May 2021
+:revdate: 17 May 2021
 
 NAME
 ----
@@ -54,6 +54,8 @@ 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-lttng-cmd-options-head.txt[]
 
@@ -73,6 +75,36 @@ include::common-lttng-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-footer.txt[]
 
 
This page took 0.026113 seconds and 4 git commands to generate.