X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-start.1.txt;h=d4f52cbacfbf4ffdca9f9a7af00edda78143be5b;hb=29545453559d2de44bf3a6ea731c1cc48a6dd97f;hp=a5f8c2f50159d1efa663233a5b376344ffaf9a24;hpb=484b2a0cbefcf0c7072622a5a411ea5ed849da28;p=lttng-tools.git diff --git a/doc/man/lttng-start.1.txt b/doc/man/lttng-start.1.txt index a5f8c2f50..d4f52cbac 100644 --- a/doc/man/lttng-start.1.txt +++ b/doc/man/lttng-start.1.txt @@ -1,6 +1,6 @@ lttng-start(1) ============== -:revdate: 21 April 2021 +:revdate: 17 May 2021 NAME @@ -23,30 +23,52 @@ 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 inactive (stopped). 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 `start-session` trigger action can also start a tracing session (see man:lttng-add-trigger(1)). +See the <> section below for usage examples. + Stop an active tracing session with the man:lttng-stop(1) command. -include::common-cmd-options-head.txt[] +include::common-lttng-cmd-options-head.txt[] + + +include::common-lttng-cmd-help-options.txt[] + + +include::common-lttng-cmd-after-options.txt[] -include::common-cmd-help-options.txt[] +[[examples]] +EXAMPLES +-------- +.Start the current tracing session. +==== +[role="term"] +---- +$ lttng start +---- +==== + +.Start a specific tracing session. +==== +[role="term"] +---- +$ lttng start my-session +---- +==== -include::common-cmd-footer.txt[] +include::common-footer.txt[] SEE ALSO @@ -55,4 +77,5 @@ man:lttng(1), man:lttng-add-trigger(1), man:lttng-create(1), man:lttng-enable-event(1), -man:lttng-stop(1) +man:lttng-stop(1), +man:lttng-concepts(7)