X-Git-Url: https://git.liburcu.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-clear.1.txt;h=34714f699fac5c39437eca761973ba895fc739d0;hp=7cec7f44e13282b747e75f1cd3bf2dd90a3b3d87;hb=26f0c7794376456fcb5b13d4eae91c0ccf0dfe66;hpb=65750bcdda3dd71b72683573d35a662c0b467a8f diff --git a/doc/man/lttng-clear.1.txt b/doc/man/lttng-clear.1.txt index 7cec7f44e..34714f699 100644 --- a/doc/man/lttng-clear.1.txt +++ b/doc/man/lttng-clear.1.txt @@ -1,10 +1,10 @@ lttng-clear(1) ============== -:revdate: 8 April 2021 +:revdate: 3 May 2021 NAME ---- -lttng-clear - Clear a tracing session +lttng-clear - Clear an LTTng tracing session SYNOPSIS @@ -19,27 +19,33 @@ The `lttng clear` command clears one or more tracing sessions, that is, it deletes the contents of their tracing buffers and of all their local and streamed trace data. +See man:lttng-concepts(7) to learn more about tracing sessions. + The `clear` command clears: Without any option:: The current tracing session. + -See man:lttng-create(1) and man:lttng-set-session(1) to learn more about -the current tracing session. +See man:lttng-concepts(7) to learn more about the current tracing +session. With the 'SESSION' argument:: - The existing tracing session named 'SESSION'. + The tracing session named 'SESSION'. With the option:--all option:: - *All* the tracing sessions of your Unix user, as listed in the - output of `lttng list` (see man:lttng-list(1)). + *All* the tracing sessions of the connected session daemon for your + Unix user, or for all users if your Unix user is `root`, as listed + in the output of `lttng list` (see man:lttng-list(1)). ++ +See the ``Session daemon connection'' section of man:lttng(1) to learn +how a user application connects to a session daemon. If a tracing session is configured in snapshot mode (see the nloption:--snapshot option of the man:lttng-create(1) command), the `clear` command only clears the tracing buffers. For a given tracing session, if at least one rotation occurred (see -man:lttng-rotate(1)), the `clear` command only clears its tracing +man:lttng-concepts(7)), the `clear` command only clears its tracing buffers and its current trace chunk, :not: its archived trace chunks. NOTE: The nloption:--disallow-clear option and the @@ -55,9 +61,10 @@ include::common-cmd-options-head.txt[] Recording target ~~~~~~~~~~~~~~~~ option:-a, option:--all:: - Clear all the tracing sessions of your Unix user, as listed in the - output of man:lttng-list(1), instead of the current tracing session - or the tracing session named 'SESSION'. + Clear all the tracing sessions of your Unix user, or of all users if + your Unix user is `root`, as listed in the output of + man:lttng-list(1), instead of the current tracing session or the + tracing session named 'SESSION'. include::common-cmd-help-options.txt[] @@ -69,7 +76,6 @@ include::common-cmd-footer.txt[] SEE ALSO -------- man:lttng(1), +man:lttng-concepts(7), man:lttng-create(1), -man:lttng-relayd(8), -man:lttng-rotate(1), -man:lttng-set-session(1) +man:lttng-relayd(8)