X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-list.1.txt;fp=doc%2Fman%2Flttng-list.1.txt;h=7256f4a9aeeaa478772151d0051f9e67962dc3f2;hp=749d66e3f55d1133cd7f080f1b7f322b2017e694;hb=ac1c08bfc6b4cabc0225bd2076c4b9b6d3099d63;hpb=b0b692950b0b6ea98a40fddea2a1ab9d125c1a8c diff --git a/doc/man/lttng-list.1.txt b/doc/man/lttng-list.1.txt index 749d66e3f..7256f4a9a 100644 --- a/doc/man/lttng-list.1.txt +++ b/doc/man/lttng-list.1.txt @@ -1,6 +1,6 @@ lttng-list(1) ============= -:revdate: 3 May 2021 +:revdate: 17 May 2021 NAME @@ -15,7 +15,7 @@ List the tracing sessions: [verse] *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* -List the tracing domains with at least one channel of a tracing session: +List the tracing domains of a tracing session with at least one channel: [verse] *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *list* option:--domain 'SESSION' @@ -87,6 +87,8 @@ option:--fields option. See man:lttng-concept(7) to learn more about tracing sessions, tracing domains, channels, recording event rules, and instrumentation points. +See the <> section below for usage examples. + List the channels and recording event rules of the current tracing session (see man:lttng-concept(7) to learn more) with the man:lttng-status(1) command. @@ -159,6 +161,64 @@ include::common-lttng-cmd-help-options.txt[] include::common-lttng-cmd-after-options.txt[] +[[examples]] +EXAMPLES +-------- +.List the tracing sessions. +==== +[role="term"] +---- +$ lttng list +---- +==== + +.Show the details of a specific tracing session. +==== +[role="term"] +---- +$ lttng list my-session +---- +==== + +.List the available Linux kernel system call instrumentation points. +==== +[role="term"] +---- +$ lttng list --kernel --syscall +---- +==== + +.List the available user space tracepoints with their fields. +==== +See the option:--fields option. + +[role="term"] +---- +$ lttng list --userspace --fields +---- +==== + +.List the tracing domains of a specific tracing session having at least one channel. +==== +See the option:--domain option. + +[role="term"] +---- +$ lttng list --domain my-session +---- +==== + +.Show the details of a specific channel in a specific tracing session. +==== +See the option:--channel option. + +[role="term"] +---- +$ lttng list my-session --channel=channel0 +---- +==== + + include::common-footer.txt[]