lttng-destroy(1): add usage examples
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Mon, 17 May 2021 18:04:43 +0000 (14:04 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Thu, 27 May 2021 21:31:35 +0000 (17:31 -0400)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: If16dcd4197c6af734b1147c9463ae2255b0a1c1f

doc/man/lttng-destroy.1.txt

index 9792924778ad8dd98f369120d772fa74b98f6190..7ab13a7f67fc237aacaa5c1823090cdc37ca2784 100644 (file)
@@ -1,6 +1,6 @@
 lttng-destroy(1)
 ================
 lttng-destroy(1)
 ================
-:revdate: 3 May 2021
+:revdate: 17 May 2021
 
 
 NAME
 
 
 NAME
@@ -64,6 +64,8 @@ Then all the subdirectories of the output directory of{nbsp}__TS__
 command exits. In other words, it's safe to read them, modify them, move
 them, or remove then.
 
 command exits. In other words, it's safe to read them, modify them, move
 them, or remove then.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 
 include::common-lttng-cmd-options-head.txt[]
 
 
 include::common-lttng-cmd-options-head.txt[]
 
@@ -85,6 +87,46 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Destroy the current tracing session.
+====
+[role="term"]
+----
+$ lttng destroy
+----
+====
+
+.Destroy the current tracing session without waiting for completion.
+====
+See the option:--no-wait option.
+
+[role="term"]
+----
+$ lttng destroy --no-wait
+----
+====
+
+.Destroy a specific tracing session.
+====
+[role="term"]
+----
+$ lttng destroy my-session
+----
+====
+
+.Destroy all tracing sessions.
+====
+See the option:--all option.
+
+[role="term"]
+----
+$ lttng destroy --all
+----
+====
+
+
 include::common-footer.txt[]
 
 
 include::common-footer.txt[]
 
 
This page took 0.029639 seconds and 5 git commands to generate.