X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-start.1.txt;h=de90fa05a9bd4a413448cf6d6fe9e0d9c5c1beec;hb=42a431087301e3ce41ef1e8e8a709523b443e351;hp=fff2cf9e2eaf1dbd125902d251a5f908b57e08cd;hpb=30ec772c97087214bfc7df4cdf19dd8e8dbee807;p=lttng-tools.git diff --git a/doc/man/lttng-start.1.txt b/doc/man/lttng-start.1.txt index fff2cf9e2..de90fa05a 100644 --- a/doc/man/lttng-start.1.txt +++ b/doc/man/lttng-start.1.txt @@ -1,51 +1,59 @@ lttng-start(1) ============== +:revdate: 29 April 2021 NAME ---- -lttng-start - Start LTTng tracers +lttng-start - Start an LTTng tracing session SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *start* ['SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *start* ['SESSION'] DESCRIPTION ----------- -The `lttng start` command starts the various LTTng tracers for a -given inactive tracing session. +The `lttng start` command starts a tracing session, that is, it +activates the LTTng tracers for: -Starting the LTTng tracers has the effect that all enabled event rules -within enabled channels can make their target event sources _emit_ trace -events. Whether they are recorded to the local file system, sent over -the network, or not recorded at all depends on the specific -configuration of the tracing session in which tracing is started. See -linklttng:lttng-create(1) for different session modes. +With the 'SESSION' argument:: + The tracing session named 'SESSION'. -A tracing session with running tracers is said to be _active_. Active -tracing sessions can return to the inactive state using the -linklttng:lttng-stop(1) command. +Without the 'SESSION' argument:: + The current tracing session (see man:lttng-concepts(7) to learn more + about the current tracing session). -If 'SESSION' is omitted, the LTTng tracers are started for the current -tracing session (see linklttng:lttng-create(1) for more information -about the current tracing session). Otherwise, they are started for the -existing tracing session named 'SESSION'. `lttng list` -outputs all the existing tracing sessions (see linklttng:lttng-list(1)). +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)). -include::common-cmd-options-head.txt[] +A `start-session` trigger action can also start a tracing session +(see man:lttng-add-trigger(1)). +Stop an active tracing session with the man:lttng-stop(1) command. -include::common-cmd-help-options.txt[] +include::common-lttng-cmd-options-head.txt[] -include::common-cmd-footer.txt[] + +include::common-lttng-cmd-help-options.txt[] + + +include::common-lttng-cmd-after-options.txt[] + + +include::common-footer.txt[] SEE ALSO -------- -linklttng:lttng-stop(1), -linklttng:lttng(1) +man:lttng(1), +man:lttng-add-trigger(1), +man:lttng-create(1), +man:lttng-enable-event(1), +man:lttng-stop(1), +man:lttng-concepts(7)