lttng-destroy(1): add usage examples

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

diff --git a/doc/man/lttng-destroy.1.txt b/doc/man/lttng-destroy.1.txt
index 5084485fd2a8ce0103929a39e3bdddcb5c059d98..7ab13a7f67fc237aacaa5c1823090cdc37ca2784 100644 (file)
--- a/doc/man/lttng-destroy.1.txt
+++ b/doc/man/lttng-destroy.1.txt
@@ -1,6 +1,6 @@
 lttng-destroy(1)
 ================
-:revdate: 3 May 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -64,8 +64,10 @@ 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.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
 
-include::common-cmd-options-head.txt[]
+
+include::common-lttng-cmd-options-head.txt[]
 
 
 option:-a, option:--all::
@@ -79,15 +81,58 @@ option:-n, option:--no-wait::
     destroy is valid before exiting.
 
 
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-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-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
 man:lttng-create(1),
-man:lttng-list(1)
+man:lttng-list(1),
+man:lttng-concepts(7)