doc/man: use double quotes when referring to internal section

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

diff --git a/doc/man/lttng-view.1.txt b/doc/man/lttng-view.1.txt
index afb39fe0a349869683fefd0632015459eb915091..0eccb30d1b95e65d2b3b8c9a773c98936772c087 100644 (file)
--- 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,8 +38,10 @@ 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-cmd-options-head.txt[]
+
+include::common-lttng-cmd-options-head.txt[]
 
 
 option:-t 'DIR', option:--trace-path='DIR'::
@@ -57,10 +59,36 @@ Without this option, the `view` command uses man:babeltrace2(1) if it's
 available. Otherwise, it tries to use man:babeltrace(1).
 
 
-include::common-cmd-help-options.txt[]
+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-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO