From ac1c08bfc6b4cabc0225bd2076c4b9b6d3099d63 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Mon, 17 May 2021 14:21:06 -0400 Subject: [PATCH] lttng-list(1): add usage examples MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau Change-Id: Id52a51f4daeef2266885d25240699ee921bb041b --- doc/man/lttng-list.1.txt | 64 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 62 insertions(+), 2 deletions(-) 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[] -- 2.34.1