From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Mon, 17 May 2021 20:05:30 +0000 (-0400)
Subject: lttng-start(1): add usage examples
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=29545453559d2de44bf3a6ea731c1cc48a6dd97f;p=lttng-tools.git

lttng-start(1): add usage examples

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I893a9e26ac69269150cf0a68ec6968cb5fa9bdbf
---

diff --git a/doc/man/lttng-start.1.txt b/doc/man/lttng-start.1.txt
index de90fa05a..d4f52cbac 100644
--- 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,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[]