X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-clear.1.txt;h=34714f699fac5c39437eca761973ba895fc739d0;hb=26f0c7794376456fcb5b13d4eae91c0ccf0dfe66;hp=6a84ae08465b6baa047a5bccc7d12406c487a0e8;hpb=dab6a2a3b6e66e1fb613b59ff56d853f1df601a7;p=lttng-tools.git diff --git a/doc/man/lttng-clear.1.txt b/doc/man/lttng-clear.1.txt index 6a84ae084..34714f699 100644 --- a/doc/man/lttng-clear.1.txt +++ b/doc/man/lttng-clear.1.txt @@ -1,10 +1,10 @@ lttng-clear(1) -=============== -:revdate: 2 April 2020 +============== +:revdate: 3 May 2021 NAME ---- -lttng-clear - Clear a tracing session +lttng-clear - Clear an LTTng tracing session SYNOPSIS @@ -16,43 +16,55 @@ SYNOPSIS DESCRIPTION ----------- The `lttng clear` command clears one or more tracing sessions, that is, -it deletes the contents of their tracing buffers and all their local and -streamed trace data. +it deletes the contents of their tracing buffers and of all their local +and streamed trace data. -If no options are specified, the current tracing session is cleared -(see man:lttng-create(1) for more information about the current -tracing session). +See man:lttng-concepts(7) to learn more about tracing sessions. -If 'SESSION' is specified, the existing tracing session named 'SESSION' -is cleared. +The `clear` command clears: -With the option:--all option, *all* the tracing sessions, as listed in -the output of `lttng list` (see man:lttng-list(1)), are cleared. +Without any option:: + The current tracing session. ++ +See man:lttng-concepts(7) to learn more about the current tracing +session. + +With the 'SESSION' argument:: + The tracing session named 'SESSION'. + +With the option:--all option:: + *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 -man:lttng-create(1) command's nloption:--snapshot option), only the -tracing buffers are cleared. +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)), only its tracing buffers and its current trace -chunk are cleared; its archived trace chunks are :not: cleared. +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 `LTTNG_RELAYD_DISALLOW_CLEAR` environment variable of man:lttng-relayd(8) can disable remote clearing operations. If LTTng -sends tracing data over the network for 'SESSION' (or for any tracing -session with the option:--all option) to a relay daemon configured as -such, `lttng clear` fails. +sends tracing data over the network for the selected tracing session(s) +to an LTTng relay daemon configured as such, the `clear` command fails. include::common-cmd-options-head.txt[] -Target -~~~~~~ +Recording target +~~~~~~~~~~~~~~~~ option:-a, option:--all:: - Clear all the tracing sessions 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[] @@ -63,8 +75,7 @@ include::common-cmd-footer.txt[] SEE ALSO -------- +man:lttng(1), +man:lttng-concepts(7), man:lttng-create(1), -man:lttng-rotate(1), -man:lttng-set-session(1), -man:lttng-relayd(8), -man:lttng(1) +man:lttng-relayd(8)