doc/man: create lttng-stop(1) and update/fix content
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Wed, 11 Nov 2015 20:37:38 +0000 (15:37 -0500)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Thu, 17 Mar 2016 21:58:15 +0000 (17:58 -0400)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
doc/man/Makefile.am
doc/man/lttng-stop.1.txt [new file with mode: 0644]

index 6c62c4a63f60991656106e805654ad8c357dc803..90d7f9f034f36fa512c7c54e1dcaf5fbce85b33e 100644 (file)
@@ -14,7 +14,8 @@ MAN1_NAMES = \
        lttng-set-session \
        lttng-save \
        lttng-load \
-       lttng-start
+       lttng-start \
+       lttng-stop
 MAN3_NAMES =
 MAN8_NAMES =
 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
diff --git a/doc/man/lttng-stop.1.txt b/doc/man/lttng-stop.1.txt
new file mode 100644 (file)
index 0000000..10ed6b6
--- /dev/null
@@ -0,0 +1,59 @@
+lttng-stop(1)
+=============
+
+
+NAME
+----
+lttng-stop - Stop LTTng tracers
+
+
+SYNOPSIS
+--------
+[verse]
+*lttng* ['GENERAL OPTIONS'] *stop* [option:--no-wait] ['SESSION']
+
+
+DESCRIPTION
+-----------
+The `lttng stop` command stops the various LTTng tracers for a given
+active tracing session.
+
+Stoping the LTTng tracers has the effect that all enabled event rules
+within enabled channels cannot make event sources _emit_ trace events
+anymore.
+
+A tracing session with no running tracers is said to be _inactive_.
+Inactive tracing sessions can be set active using the
+linklttng:lttng-start(1) command.
+
+If 'SESSION' is omitted, the LTTng tracers are stopped for the current
+tracing session (see linklttng:lttng-create(1) for more information
+about the current tracing session). Otherwise, they are stopped for the
+existing tracing session named 'SESSION'. `lttng list`
+outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
+
+By default, the `lttng stop` command ensures that the tracing session's
+trace data is valid before returning to the prompt. With the
+option:--no-wait option, the command finishes immediately, hence a local
+trace might not be valid when the command is done. In this case, there
+is no way to know when the trace becomes valid.
+
+
+include::common-cmd-options-head.txt[]
+
+
+option:-n, option:--no-wait::
+       Do not ensure that the chosen tracing session's trace data is valid
+       before returning to the prompt.
+
+
+include::common-cmd-help-options.txt[]
+
+
+include::common-cmd-footer.txt[]
+
+
+SEE ALSO
+--------
+linklttng:lttng-start(1),
+linklttng:lttng(1)
This page took 0.046702 seconds and 4 git commands to generate.