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

lttng-view(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: I9324b0733ebbaabb824efca4a11330fe3a5c1d0f
---

diff --git a/doc/man/lttng-view.1.txt b/doc/man/lttng-view.1.txt
index 15465c9db..a91e5dff6 100644
--- a/doc/man/lttng-view.1.txt
+++ b/doc/man/lttng-view.1.txt
@@ -1,6 +1,6 @@
 lttng-view(1)
 =============
-:revdate: 29 April 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -38,6 +38,8 @@ By default, the `view` command attempts to launch man:babeltrace2(1) or,
 if it's not available, man:babeltrace(1). Override which trace reader to
 launch with the option:--viewer option.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 
 include::common-lttng-cmd-options-head.txt[]
 
@@ -63,6 +65,29 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Read the traces of the current tracing session with Babeltrace.
+====
+[role="term"]
+----
+$ lttng view
+----
+====
+
+.Read the traces of a specific tracing session with a custom trace reader.
+====
+See the option:--viewer option.
+
+[role="term"]
+----
+$ lttng view --viewer='/usr/bin/my-reader -zK --details=3' \
+             my-session
+----
+====
+
+
 include::common-footer.txt[]