From 4182cfea302ab5c0233d45433e7dc85697c4016d Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Mon, 17 May 2021 16:05:40 -0400 Subject: [PATCH] lttng-stop(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: I6794937457d4f34d649b9edb6a755e091a6af67e --- doc/man/lttng-stop.1.txt | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/doc/man/lttng-stop.1.txt b/doc/man/lttng-stop.1.txt index 9b1907c61..d0371c74d 100644 --- a/doc/man/lttng-stop.1.txt +++ b/doc/man/lttng-stop.1.txt @@ -1,6 +1,6 @@ lttng-stop(1) ============= -:revdate: 29 April 2021 +:revdate: 17 May 2021 NAME @@ -52,6 +52,8 @@ remains inactive, it's :not: a trace chunk archive: you need to destroy the tracing session with man:lttng-destroy(1) or perform a rotation with man:lttng-rotate(1) to archive it. +See the <> section below for usage examples. + include::common-lttng-cmd-options-head.txt[] @@ -67,6 +69,36 @@ include::common-lttng-cmd-help-options.txt[] include::common-lttng-cmd-after-options.txt[] +[[examples]] +EXAMPLES +-------- +.Stop the current tracing session. +==== +[role="term"] +---- +$ lttng stop +---- +==== + +.Stop a specific tracing session. +==== +[role="term"] +---- +$ lttng stop my-session +---- +==== + +.Stop the current tracing session without waiting for completion. +==== +See the option:--no-wait option. + +[role="term"] +---- +$ lttng stop --no-wait +---- +==== + + include::common-footer.txt[] -- 2.34.1