doc/man: create lttng-destroy(1) and update/fix content
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Wed, 11 Nov 2015 20:35:03 +0000 (15:35 -0500)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Thu, 17 Mar 2016 21:37:49 +0000 (17:37 -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-destroy.1.txt [new file with mode: 0644]

index 5f57456538f4c136b9da0ea88795fa2d2240f7e4..c8997b78999cabc2818162850b3cc7b7d043d276 100644 (file)
@@ -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 (file)
index 0000000..d23d094
--- /dev/null
@@ -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)
This page took 0.028231 seconds and 5 git commands to generate.