From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Wed, 11 Nov 2015 21:13:25 +0000 (-0500)
Subject: doc/man: create lttng-view(1) and update/fix content
X-Git-Tag: v2.8.0-rc1~46
X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=commitdiff_plain;h=79e094df4202ac51f57926d6563de87ff29c91b1;hp=e85eccc8d6ec0064d723a08260f23936e8143e2e

doc/man: create lttng-view(1) and update/fix content

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

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index a6ce6cd53..ed6791ea2 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -16,7 +16,8 @@ MAN1_NAMES = \
 	lttng-load \
 	lttng-start \
 	lttng-stop \
-	lttng-version
+	lttng-version \
+	lttng-view
 MAN3_NAMES =
 MAN8_NAMES =
 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
diff --git a/doc/man/lttng-view.1.txt b/doc/man/lttng-view.1.txt
new file mode 100644
index 000000000..184328b51
--- /dev/null
+++ b/doc/man/lttng-view.1.txt
@@ -0,0 +1,55 @@
+lttng-view(1)
+=============
+
+
+NAME
+----
+lttng-view - View the traces of an LTTng tracing session
+
+
+SYNOPSIS
+--------
+[verse]
+*lttng* ['GENERAL OPTIONS'] *view* [option:--viewer='CMD'] [option:--trace-path='PATH' | 'SESSION']
+
+
+DESCRIPTION
+-----------
+The `lttng view` command launches an external trace viewer to view the
+current trace of a tracing session.
+
+If 'SESSION' is omitted, the viewer is launched for the current tracing
+session (see linklttng:lttng-create(1) for more information
+about the current tracing session). Otherwise, it is launched for the
+existing tracing session named 'SESSION'. `lttng list`
+outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
+
+By default, the linklttng:babeltrace(1) trace viewer is launched.
+Another trace viewer command can be specified using the
+option:--viewer option.
+
+By default, the trace path of the chosen tracing session is given
+as the first positional argument to the trace viewer. This path can
+be overridden using the option:--trace-path option.
+
+
+include::common-cmd-options-head.txt[]
+
+
+option:-t, option:--trace-path='PATH'::
+    View trace at path 'PATH' instead of using the chosen tracing
+    session's trace path.
+
+option:-e, option:--viewer='CMD'::
+    Use 'CMD' as the trace viewer.
+
+
+include::common-cmd-help-options.txt[]
+
+
+include::common-cmd-footer.txt[]
+
+
+SEE ALSO
+--------
+linklttng:lttng(1)