From fb58d65962522bcce00b34f847d490695d51b9cc Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Wed, 11 Nov 2015 15:37:38 -0500 Subject: [PATCH] doc/man: create lttng-stop(1) and update/fix content MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- doc/man/Makefile.am | 3 +- doc/man/lttng-stop.1.txt | 59 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 doc/man/lttng-stop.1.txt diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 6c62c4a63..90d7f9f03 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -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 index 000000000..10ed6b60e --- /dev/null +++ b/doc/man/lttng-stop.1.txt @@ -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) -- 2.34.1