From 0715718480d432a198e48272a0a580bdb4be265d Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Mon, 17 May 2021 14:04:21 -0400 Subject: [PATCH] lttng-clear(1): add usage examples 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 Change-Id: Id410c79fddb88de87edda333bec9ef59b6f5afc9 --- doc/man/lttng-clear.1.txt | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/doc/man/lttng-clear.1.txt b/doc/man/lttng-clear.1.txt index 4fb52671a..a74bee0ed 100644 --- a/doc/man/lttng-clear.1.txt +++ b/doc/man/lttng-clear.1.txt @@ -1,6 +1,6 @@ lttng-clear(1) ============== -:revdate: 3 May 2021 +:revdate: 17 May 2021 NAME ---- @@ -54,6 +54,8 @@ man:lttng-relayd(8) can disable remote clearing operations. If LTTng sends tracing data over the network for the selected tracing session(s) to an LTTng relay daemon configured as such, the `clear` command fails. +See the <> section below for usage examples. + include::common-lttng-cmd-options-head.txt[] @@ -73,6 +75,36 @@ include::common-lttng-cmd-help-options.txt[] include::common-lttng-cmd-after-options.txt[] +[[examples]] +EXAMPLES +-------- +.Clear the current tracing session. +==== +[role="term"] +---- +$ lttng clear +---- +==== + +.Clear a specific tracing session. +==== +[role="term"] +---- +$ lttng clear my-session +---- +==== + +.Clear all tracing sessions. +==== +See the option:--all option. + +[role="term"] +---- +$ lttng clear --all +---- +==== + + include::common-footer.txt[] -- 2.34.1