From: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Date: Mon, 11 Feb 2019 17:19:58 +0000 (-0500)
Subject: Doc: lttng-clear(8) man page
X-Git-Tag: v2.12.0-rc1~112
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=73b818e72d64f3553bad06f63924d8118e9f859a;p=lttng-tools.git

Doc: lttng-clear(8) man page

Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Change-Id: I6d981a1e17a2a3fdd20a4c61b8c2216bc6517f3f
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index ccd76f746..552b0888d 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -33,7 +33,8 @@ MAN1_NAMES = \
 	lttng-regenerate \
 	lttng-rotate \
 	lttng-enable-rotation \
-	lttng-disable-rotation
+	lttng-disable-rotation \
+	lttng-clear
 MAN3_NAMES =
 MAN8_NAMES = lttng-sessiond lttng-relayd
 MAN1_NO_ASCIIDOC_NAMES =
diff --git a/doc/man/lttng-clear.1.txt b/doc/man/lttng-clear.1.txt
new file mode 100644
index 000000000..8b63d6c0c
--- /dev/null
+++ b/doc/man/lttng-clear.1.txt
@@ -0,0 +1,58 @@
+lttng-clear(1)
+===============
+:revdate: 6 November 2019
+
+NAME
+----
+lttng-clear - Clear a tracing session
+
+
+SYNOPSIS
+--------
+[verse]
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *clear* [option:--all | 'SESSION']
+
+
+DESCRIPTION
+-----------
+The `lttng clear` command clears one or more tracing sessions.
+
+If no options are specified, the current tracing session is cleared
+(see man:lttng-create(1) for more information about the current
+tracing session).
+
+If 'SESSION' is specified, the existing tracing session named 'SESSION'
+is cleared.
+
+If the option:--all option is used, *all* the tracing sessions, as listed
+in the output of `lttng list`, are cleared.
+
+Clearing a tracing session deletes the contents of the tracing buffers and
+all local or streamed trace data.
+
+If a session is configured in snapshot mode, only the tracing buffers are cleared.
+
+If at least one rotation occurred, only the tracing buffers and the current
+trace chunks are cleared. Previous trace chunks are not cleared.
+
+Note that a lttng-relayd daemon can be configured to disallow clear operations
+using LTTNG_RELAYD_DISALLOW_CLEAR. Clear commands performed on a streaming
+session utilizing such lttng-relayd daemon will fail.
+
+include::common-cmd-options-head.txt[]
+
+
+option:-a, option:--all::
+    Clear all tracing sessions.
+
+include::common-cmd-help-options.txt[]
+
+
+include::common-cmd-footer.txt[]
+
+
+SEE ALSO
+--------
+man:lttng-rotate(1),
+man:lttng-set-session(1),
+man:lttng(1)