X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-start.1.txt;h=b595b2f5ce2f804f605f99ebd350fe910d6ab1a4;hb=47aa4f7bc50412db0818c83136814a9a1a0edf9a;hp=9cc721de75eecfb8d2ed769498d4e892ff37c7b0;hpb=af1c4164dd7bad940a84c29c2b429d76e3fc0e33;p=lttng-tools.git diff --git a/doc/man/lttng-start.1.txt b/doc/man/lttng-start.1.txt index 9cc721de7..b595b2f5c 100644 --- a/doc/man/lttng-start.1.txt +++ b/doc/man/lttng-start.1.txt @@ -1,11 +1,11 @@ lttng-start(1) ============== -:revdate: 29 April 2021 +:revdate: 14 June 2021 NAME ---- -lttng-start - Start an LTTng tracing session +lttng-start - Start an LTTng recording session SYNOPSIS @@ -16,34 +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-concepts(7) 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). -See man:lttng-concepts(7) to learn more about tracing sessions. +See man:lttng-concepts(7) to learn more about recording sessions. -The selected tracing session must be inactive (stopped). A tracing +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-cmd-options-head.txt[] +include::common-lttng-cmd-options-head.txt[] -include::common-cmd-help-options.txt[] +include::common-lttng-cmd-help-options.txt[] -include::common-cmd-footer.txt[] + +include::common-lttng-cmd-after-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-footer.txt[] SEE ALSO