X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-start.1.txt;h=f3ee0e785053792c5e11575802b75fb626fc0e22;hb=HEAD;hp=53b1c8aa74f4b32c46774547111047f4bc3e56db;hpb=26f0c7794376456fcb5b13d4eae91c0ccf0dfe66;p=lttng-tools.git diff --git a/doc/man/lttng-start.1.txt b/doc/man/lttng-start.1.txt index 53b1c8aa7..f3ee0e785 100644 --- a/doc/man/lttng-start.1.txt +++ b/doc/man/lttng-start.1.txt @@ -1,56 +1,106 @@ 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 -------- [verse] -*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *start* ['SESSION'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *start* [option::--all | option::--glob 'SESSION' | 'SESSION' ] 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[] +option:-a, option:--all:: + Start all sessions. + +option:-g, option:--glob:: + Interpret SESSION as a globbing pattern. + +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 +---- +==== + +.Start all sessions. +==== +See the option::--all option. + +[role="term"] +---- +$ lttng start --all +---- +==== + +.Start all sessions with the suffix foo. +==== +See the option::--glob option. + +[role="term"] +---- +$ lttng start --glob '*foo' +---- +==== + + +include::common-footer.txt[] SEE ALSO -------- man:lttng(1), man:lttng-add-trigger(1), -man:lttng-concepts(7), man:lttng-create(1), man:lttng-enable-event(1), -man:lttng-stop(1) +man:lttng-stop(1), +man:lttng-concepts(7)