X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-disable-channel.1.txt;h=ccfb1a9fa7e1135e680a8804401044b467b9a1f5;hb=HEAD;hp=be845e65d68a589d8e8314f6c31d673aa3371943;hpb=484b2a0cbefcf0c7072622a5a411ea5ed849da28;p=lttng-tools.git diff --git a/doc/man/lttng-disable-channel.1.txt b/doc/man/lttng-disable-channel.1.txt index be845e65d..244e9c4b1 100644 --- a/doc/man/lttng-disable-channel.1.txt +++ b/doc/man/lttng-disable-channel.1.txt @@ -1,6 +1,7 @@ lttng-disable-channel(1) ======================== -:revdate: 21 April 2021 +:revdate: 14 June 2021 + NAME ---- @@ -17,23 +18,29 @@ SYNOPSIS DESCRIPTION ----------- The `lttng disable-channel` command disables one or more channels -previously enabled with the man:lttng-enable-channel(1) command. +previously enabled with the man:lttng-enable-channel(1) command +which belong to: + +With the option:--session='SESSION' option:: + The recording session named 'SESSION'. -A channel always belongs to a tracing session (see man:lttng-create(1) -to create a tracing session). Without the option:--session option, the -`disable-channel` command disables one or more channels of the current -tracing session (see man:lttng-create(1) and man:lttng-set-session(1) to -learn more about the current tracing session). +Without the option:--session option:: + 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 channels. The `disable-channel` command disables one channel per 'CHANNEL' argument. As of LTTng{nbsp}{lttng_version}, you may :not: enable a disabled -channel once its tracing session has ben started (see +channel once its recording session has been started (see man:lttng-start(1)) at least once. +See the ``<>'' section below for usage examples. + -include::common-cmd-options-head.txt[] +include::common-lttng-cmd-options-head.txt[] Tracing domain @@ -47,20 +54,47 @@ option:-u, option:--userspace:: Disable one or more user space channels. -Target -~~~~~~ +Recording target +~~~~~~~~~~~~~~~~ option:-s 'SESSION', option:--session='SESSION':: - Disable one or more channels of the tracing session named 'SESSION' - instead of the current tracing session. + Disable one or more channels of the recording session named + 'SESSION' instead of the current recording session. + + +include::common-lttng-cmd-help-options.txt[] + + +include::common-lttng-cmd-after-options.txt[] -include::common-cmd-help-options.txt[] +[[examples]] +EXAMPLES +-------- +.Disable one Linux kernel channel of the current recording session. +==== +[role="term"] +---- +$ lttng disable-channel --kernel my-channel +---- +==== + +.Disable two user space channels of a specific recording session. +==== +See the option:--session option. + +[role="term"] +---- +$ lttng disable-channel --kernel --session=my-session \ + little,box +---- +==== -include::common-cmd-footer.txt[] +include::common-footer.txt[] SEE ALSO -------- man:lttng(1), -man:lttng-enable-channel(1) +man:lttng-enable-channel(1), +man:lttng-concepts(7)