From 7bf169bd18b92a75b0f0f1a412a83f39c934ac3e Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Wed, 11 Nov 2015 15:35:03 -0500 Subject: [PATCH] doc/man: create lttng-destroy(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-destroy.1.txt | 55 +++++++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 1 deletion(-) create mode 100644 doc/man/lttng-destroy.1.txt diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 5f5745653..c8997b789 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -9,7 +9,8 @@ manaddsuffix = $(addsuffix $(1),$(addprefix $(srcdir)/,$(2))) # List only the names without the .*.txt extension here: MAN1_NAMES = \ lttng \ - lttng-create + lttng-create \ + lttng-destroy MAN3_NAMES = MAN8_NAMES = MAN1_NO_ASCIIDOC_NAMES = lttng-crash diff --git a/doc/man/lttng-destroy.1.txt b/doc/man/lttng-destroy.1.txt new file mode 100644 index 000000000..d23d094eb --- /dev/null +++ b/doc/man/lttng-destroy.1.txt @@ -0,0 +1,55 @@ +lttng-destroy(1) +=============== + + +NAME +---- +lttng-destroy - Destroy an LTTng tracing session + + +SYNOPSIS +-------- +[verse] +*lttng* ['GENERAL OPTIONS'] *destroy* [option:--all | 'SESSION'] + + +DESCRIPTION +----------- +The `lttng destroy` command destroys one or more tracing sessions. + +If no options are specified, the current tracing session is destroyed +(see linklttng:lttng-create(1) for more information about the current +tracing session). + +If 'SESSION' is specified, the existing tracing session named 'SESSION' +is destroyed. `lttng list` outputs all the existing tracing sessions +(see linklttng:lttng-list(1)). + +If the option:--all option is used, *all* the tracing sessions, as listed +in the output of `lttng list`, are destroyed. + +Destroying a tracing session stops any tracing running within the latter. + +Destroying a tracing session does not destroy the recorded trace data, +if any; it frees resources acquired by the session daemon and tracer +side, making sure to flush all trace data. + + +include::common-cmd-options-head.txt[] + + +option:-a, option:--all:: + Destroy all tracing sessions. + + +include::common-cmd-help-options.txt[] + + +include::common-cmd-footer.txt[] + + +SEE ALSO +-------- +linklttng:lttng-create(1), +linklttng:lttng-set-session(1), +linklttng:lttng(1) -- 2.34.1