lttng-start(1): add usage examples
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Mon, 17 May 2021 20:05:30 +0000 (16:05 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Wed, 19 May 2021 15:23:28 +0000 (11:23 -0400)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I893a9e26ac69269150cf0a68ec6968cb5fa9bdbf

doc/man/lttng-start.1.txt

index de90fa05a9bd4a413448cf6d6fe9e0d9c5c1beec..d4f52cbacfbf4ffdca9f9a7af00edda78143be5b 100644 (file)
@@ -1,6 +1,6 @@
 lttng-start(1)
 ==============
-:revdate: 29 April 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -34,6 +34,8 @@ 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.
 
 
@@ -46,6 +48,26 @@ include::common-lttng-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-footer.txt[]
 
 
This page took 0.025553 seconds and 4 git commands to generate.