From a9c09e6e5ac93cf63c190a86636c0882bc12964c Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Mon, 17 May 2021 16:23:59 -0400 Subject: [PATCH] lttng-view(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: I9324b0733ebbaabb824efca4a11330fe3a5c1d0f --- doc/man/lttng-view.1.txt | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/doc/man/lttng-view.1.txt b/doc/man/lttng-view.1.txt index 15465c9db..a91e5dff6 100644 --- a/doc/man/lttng-view.1.txt +++ b/doc/man/lttng-view.1.txt @@ -1,6 +1,6 @@ lttng-view(1) ============= -:revdate: 29 April 2021 +:revdate: 17 May 2021 NAME @@ -38,6 +38,8 @@ By default, the `view` command attempts to launch man:babeltrace2(1) or, if it's not available, man:babeltrace(1). Override which trace reader to launch with the option:--viewer option. +See the <> section below for usage examples. + include::common-lttng-cmd-options-head.txt[] @@ -63,6 +65,29 @@ include::common-lttng-cmd-help-options.txt[] include::common-lttng-cmd-after-options.txt[] +[[examples]] +EXAMPLES +-------- +.Read the traces of the current tracing session with Babeltrace. +==== +[role="term"] +---- +$ lttng view +---- +==== + +.Read the traces of a specific tracing session with a custom trace reader. +==== +See the option:--viewer option. + +[role="term"] +---- +$ lttng view --viewer='/usr/bin/my-reader -zK --details=3' \ + my-session +---- +==== + + include::common-footer.txt[] -- 2.34.1