lttng-start(1): add usage examples

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

diff --git a/doc/man/lttng-start.1.txt b/doc/man/lttng-start.1.txt
index 53b1c8aa74f4b32c46774547111047f4bc3e56db..d4f52cbacfbf4ffdca9f9a7af00edda78143be5b 100644 (file)
--- a/doc/man/lttng-start.1.txt
+++ b/doc/man/lttng-start.1.txt
@@ -1,6 +1,6 @@
 lttng-start(1)
 ==============
-:revdate: 29 April 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -34,23 +34,48 @@ session is inactive on creation (see man:lttng-create(1)).
 A `start-session` trigger action can also start a tracing session
 (see man:lttng-add-trigger(1)).
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 Stop an active tracing session with the man:lttng-stop(1) command.
 
 
-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]
+
+
+include::common-lttng-cmd-help-options.txt[]
 
 
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+[[examples]]
+EXAMPLES
+--------
+.Start the current tracing session.
+====
+[role="term"]
+----
+$ lttng start
+----
+====
+
+.Start a specific tracing session.
+====
+[role="term"]
+----
+$ lttng start my-session
+----
+====
 
 
-include::common-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO
 --------
 man:lttng(1),
 man:lttng-add-trigger(1),
-man:lttng-concepts(7),
 man:lttng-create(1),
 man:lttng-enable-event(1),
-man:lttng-stop(1)
+man:lttng-stop(1),
+man:lttng-concepts(7)