Doc: lttng clear man page

[lttng-tools.git] / doc / man / lttng-clear.1.txt

diff --git a/doc/man/lttng-clear.1.txt b/doc/man/lttng-clear.1.txt
new file mode 100644 (file)
index 0000000..fcce289
--- /dev/null
+++ b/doc/man/lttng-clear.1.txt
@@ -0,0 +1,54 @@
+lttng-clear(1)
+===============
+
+
+NAME
+----
+lttng-clear - Clear an LTTng 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 removes all tracing data from the tracing buffers and
+remove 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 chunk is cleared. Previous trace chunks are not cleared.
+
+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)