lttng-{enable,disable}-event(1): document default channel limitation

[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 6874aad3cd27545821334e844b4e43fb4cac1658..a91e5dff6931bacfac2b94b84d580ceb5a828bdc 100644 (file)
--- a/doc/man/lttng-view.1.txt
+++ b/doc/man/lttng-view.1.txt
@@ -1,6 +1,6 @@
 lttng-view(1)
 =============
-:revdate: 21 April 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -27,9 +27,8 @@ With the option:--trace-path='DIR' option::
     The local file system directory 'DIR'.
 
 Otherwise::
-    The current tracing session (see man:lttng-create(1) and
-    man:lttng-set-session(1) to learn more about the current tracing
-    session).
+    The current tracing session (see man:concepts(1) to learn more about
+    the current tracing session).
 
 With the option:--session option or without the option:--trace-path
 option, the mode of the selected tracing session may :not: be network
@@ -39,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'::
@@ -58,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