From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Wed, 11 Nov 2015 20:37:07 +0000 (-0500)
Subject: doc/man: create lttng-start(1) and update/fix content
X-Git-Tag: v2.8.0-rc1~49
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=30ec772c97087214bfc7df4cdf19dd8e8dbee807;p=lttng-tools.git

doc/man: create lttng-start(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 6e34f5bb3..6c62c4a63 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -13,7 +13,8 @@ MAN1_NAMES = \
 	lttng-destroy \
 	lttng-set-session \
 	lttng-save \
-	lttng-load
+	lttng-load \
+	lttng-start
 MAN3_NAMES =
 MAN8_NAMES =
 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
diff --git a/doc/man/lttng-start.1.txt b/doc/man/lttng-start.1.txt
new file mode 100644
index 000000000..fff2cf9e2
--- /dev/null
+++ b/doc/man/lttng-start.1.txt
@@ -0,0 +1,51 @@
+lttng-start(1)
+==============
+
+
+NAME
+----
+lttng-start - Start LTTng tracers
+
+
+SYNOPSIS
+--------
+[verse]
+*lttng* ['GENERAL OPTIONS'] *start* ['SESSION']
+
+
+DESCRIPTION
+-----------
+The `lttng start` command starts the various LTTng tracers for a
+given inactive tracing session.
+
+Starting the LTTng tracers has the effect that all enabled event rules
+within enabled channels can make their target event sources _emit_ trace
+events. Whether they are recorded to the local file system, sent over
+the network, or not recorded at all depends on the specific
+configuration of the tracing session in which tracing is started. See
+linklttng:lttng-create(1) for different session modes.
+
+A tracing session with running tracers is said to be _active_. Active
+tracing sessions can return to the inactive state using the
+linklttng:lttng-stop(1) command.
+
+If 'SESSION' is omitted, the LTTng tracers are started for the current
+tracing session (see linklttng:lttng-create(1) for more information
+about the current tracing session). Otherwise, they are started for the
+existing tracing session named 'SESSION'. `lttng list`
+outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
+
+
+include::common-cmd-options-head.txt[]
+
+
+include::common-cmd-help-options.txt[]
+
+
+include::common-cmd-footer.txt[]
+
+
+SEE ALSO
+--------
+linklttng:lttng-stop(1),
+linklttng:lttng(1)