X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng.1.txt;fp=doc%2Fman%2Flttng.1.txt;h=1b5d5ee31c996a699ad4024c176f81e5520e3b4f;hp=06f3a362ad11a409061ee41011b06ff759464e8d;hb=26f0c7794376456fcb5b13d4eae91c0ccf0dfe66;hpb=65750bcdda3dd71b72683573d35a662c0b467a8f diff --git a/doc/man/lttng.1.txt b/doc/man/lttng.1.txt index 06f3a362a..1b5d5ee31 100644 --- a/doc/man/lttng.1.txt +++ b/doc/man/lttng.1.txt @@ -1,17 +1,17 @@ lttng(1) ======== -:revdate: 16 October 2019 +:revdate: 3 May 2021 NAME ---- -lttng - LTTng 2 tracer control command-line tool +lttng - Control LTTng tracing SYNOPSIS -------- [verse] -*lttng* [option:--group='GROUP'] [option:--mi=xml] [option:--no-sessiond | option:--sessiond-path='PATH'] +*lttng* [option:--group='GROUP'] [option:--mi=**xml**] [option:--no-sessiond | option:--sessiond-path='PATH'] [option:--quiet | option:-verbose...] '<>' ['COMMAND OPTIONS'] @@ -24,7 +24,7 @@ with the LTTng control library (`liblttng-ctl`), sends commands to a listening LTTng session daemon (man:lttng-sessiond(8)). A session daemon: -* Manages tracing sessions (see man:lttng-create(1) to learn more +* Manages tracing sessions (see man:lttng-concepts(7) to learn more about tracing sessions). * Controls the various components (like tracers and consumer daemons) of @@ -41,6 +41,12 @@ daemon with the option:--no-sessiond option. NOTE: The LTTng project recommends that you start the session daemon at boot time for stable and long-term tracing. +See man:lttng-concepts(7) to learn more about the foundational concepts +of LTTng. + +The `lttng` tool offers a subcommand-based command-line interface. The +<> section below lists the available commands. + Session daemon connection ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -80,9 +86,9 @@ Without the nloption:--group option of the root session daemon:: `tracing` LTTng-instrumented user applications automatically register to both the -root session daemon and the user session daemon. This makes it possible -for both session daemons to list the available traceable applications -and known instrumentation points (see man:lttng-list(1)). +root and user session daemons. This makes it possible for both session +daemons to list the available instrumented applications and their +instrumentation points (see man:lttng-list(1)). OPTIONS @@ -244,6 +250,6 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -man:babeltrace2(1), +man:lttng-concepts(7) man:lttng-relayd(8), man:lttng-sessiond(8)