X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-start.1.txt;h=b595b2f5ce2f804f605f99ebd350fe910d6ab1a4;hp=a5f8c2f50159d1efa663233a5b376344ffaf9a24;hb=e971184584781f70bbbfc52bbede8b9abf0436e5;hpb=484b2a0cbefcf0c7072622a5a411ea5ed849da28 diff --git a/doc/man/lttng-start.1.txt b/doc/man/lttng-start.1.txt index a5f8c2f50..b595b2f5c 100644 --- a/doc/man/lttng-start.1.txt +++ b/doc/man/lttng-start.1.txt @@ -1,11 +1,11 @@ lttng-start(1) ============== -:revdate: 21 April 2021 +:revdate: 14 June 2021 NAME ---- -lttng-start - Start an LTTng tracing session +lttng-start - Start an LTTng recording session SYNOPSIS @@ -16,37 +16,59 @@ SYNOPSIS DESCRIPTION ----------- -The `lttng start` command starts a tracing session, that is, it +The `lttng start` command starts a recording session, that is, it activates the LTTng tracers for: With the 'SESSION' argument:: - The tracing session named 'SESSION'. + The recording 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 recording session (see man:lttng-concepts(7) to learn + more about the current recording session). -The selected tracing session must be inactive (stopped). A tracing -session is inactive on creation (see man:lttng-create(1)). +See man:lttng-concepts(7) to learn more about recording sessions. -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. +The selected recording session must be inactive (stopped). A recording +session is inactive on creation (see man:lttng-create(1)). -A `start-session` trigger action can also start a tracing session +A `start-session` trigger action can also start a recording session (see man:lttng-add-trigger(1)). -Stop an active tracing session with the man:lttng-stop(1) command. +See the ``<>'' section below for usage examples. + +Stop an active recording session with the man:lttng-stop(1) command. + + +include::common-lttng-cmd-options-head.txt[] + + +include::common-lttng-cmd-help-options.txt[] -include::common-cmd-options-head.txt[] +include::common-lttng-cmd-after-options.txt[] -include::common-cmd-help-options.txt[] +[[examples]] +EXAMPLES +-------- +.Start the current recording session. +==== +[role="term"] +---- +$ lttng start +---- +==== + +.Start a specific recording 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)