X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-stop.1.txt;h=d0371c74d8ee9cd7aadfe703317075c3a3d2521d;hb=4182cfea302ab5c0233d45433e7dc85697c4016d;hp=5c21c6ce404e467f3e4b2192635e67e49aa41261;hpb=484b2a0cbefcf0c7072622a5a411ea5ed849da28;p=lttng-tools.git diff --git a/doc/man/lttng-stop.1.txt b/doc/man/lttng-stop.1.txt index 5c21c6ce4..d0371c74d 100644 --- a/doc/man/lttng-stop.1.txt +++ b/doc/man/lttng-stop.1.txt @@ -1,6 +1,6 @@ lttng-stop(1) ============= -:revdate: 21 April 2021 +:revdate: 17 May 2021 NAME @@ -23,18 +23,15 @@ With the 'SESSION' argument:: The tracing session named 'SESSION'. Without the 'SESSION' argument:: - The current tracing session (see man:lttng-create(1) and - man:lttng-set-session(1) to learn more about the current tracing - session). + The current tracing session (see man:lttng-concepts(7) to learn more + about the current tracing session). + +See man:lttng-concepts(7) to learn more about tracing sessions. The selected tracing session must be active (started; see man:lttng-start(1)). A tracing session is inactive on creation (see man:lttng-create(1)). -An active tracing session is an implicit recording event rule condition -(see man:lttng-enable-event(1)). In other words, a recording event rule -cannot match an event when its tracing session is inactive. - A `stop-session` trigger action can also stop a tracing session (see man:lttng-add-trigger(1)). @@ -55,8 +52,10 @@ 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-cmd-options-head.txt[] +include::common-lttng-cmd-options-head.txt[] option:-n, option:--no-wait:: @@ -64,10 +63,43 @@ option:-n, option:--no-wait:: is valid before exiting. -include::common-cmd-help-options.txt[] +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-cmd-footer.txt[] +include::common-footer.txt[] SEE ALSO @@ -77,4 +109,5 @@ man:lttng-add-trigger(1), man:lttng-create(1), man:lttng-enable-event(1), man:lttng-rotate(1), -man:lttng-start(1) +man:lttng-start(1), +man:lttng-concepts(7)