Clean-up: modernize pretty_xml.cpp

[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 15465c9db42e50e98ef315848bc4dcd108e43b8e..02d788c5e72b2ebf5fc2e9638fc0ed79f9ba5b07 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: 14 June 2021
 
 
 NAME
@@ -21,30 +21,32 @@ The `lttng view` command launches an external trace reader to read the
 current traces of:
 
 With the option:--session='SESSION' option::
-    The tracing session named 'SESSION'.
+    The recording session named 'SESSION'.
 
 With the option:--trace-path='DIR' option::
     The local file system directory 'DIR'.
 
 Otherwise::
-    The current tracing session (see man:concepts(1) to learn more about
-    the current tracing session).
+    The current recording session (see man:concepts(1) to learn more
+    about the current recording session).
 
 With the option:--session option or without the option:--trace-path
-option, the mode of the selected tracing session may :not: be network
+option, the mode of the selected recording session may :not: be network
 streaming or live.
 
 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[]
 
 
 option:-t 'DIR', option:--trace-path='DIR'::
     Pass 'DIR' as the last argument of the trace reader command instead
-    of the output directory of the selected tracing session.
+    of the output directory of the selected recording session.
 
 option:-e 'READER', option:--viewer='READER'::
     Use the trace reader 'READER' to read the traces.
@@ -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 recording session with Babeltrace.
+====
+[role="term"]
+----
+$ lttng view
+----
+====
+
+.Read the traces of a specific recording 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[]