From 747361fe44653a9b63b0f481e2891635648afd27 Mon Sep 17 00:00:00 2001 From: Mathieu Desnoyers Date: Thu, 18 Jul 2013 10:23:47 -0400 Subject: [PATCH] Manpage: cleanup layout of list Signed-off-by: Mathieu Desnoyers --- doc/man/lttng.1 | 43 +++++++++++++++++++++-------------- src/bin/lttng/commands/list.c | 2 +- 2 files changed, 27 insertions(+), 18 deletions(-) diff --git a/doc/man/lttng.1 b/doc/man/lttng.1 index 2023cae94..f98a24c1a 100644 --- a/doc/man/lttng.1 +++ b/doc/man/lttng.1 @@ -621,8 +621,9 @@ Apply for the user-space tracer .RE .PP -.IP "\fBlist\fP [\-k|\-u] [SESSION [SESSION_OPTIONS]]" -.nf +.PP +\fBlist\fP [OPTIONS] [SESSION [SESSION OPTIONS]] +.RS List tracing session information. With no arguments, it will list available tracing session(s). @@ -636,33 +637,41 @@ calls events). With \-u alone, it will list all available user-space events from registered applications. Here is an example of 'lttng list \-u': +.nf PID: 7448 - Name: /tmp/lttng-ust/tests/hello/.libs/lt-hello ust_tests_hello:tptest_sighandler (type: tracepoint) ust_tests_hello:tptest (type: tracepoint) +.fi You can now enable any event listed by using the name : \fBust_tests_hello:tptest\fP. -.fi .B OPTIONS: -.nf -\-h, \-\-help - Show summary of possible options and commands. -\-\-list-options - Simple listing of options -\-k, \-\-kernel - Select kernel domain -\-u, \-\-userspace - Select user-space domain. +.TP +.BR "\-h, \-\-help" +Show summary of possible options and commands. +.TP +.BR "\-\-list-options" +Simple listing of options +.TP +.BR "\-k, \-\-kernel" +Select kernel domain +.TP +.BR "\-u, \-\-userspace" +Select user-space domain. +.PP .B SESSION OPTIONS: -\-c, \-\-channel NAME - List details of a channel -\-d, \-\-domain - List available domain(s) -.fi +.TP +.BR "\-c, \-\-channel NAME" +List details of a channel +.TP +.BR "\-d, \-\-domain" +List available domain(s) +.RE +.PP .IP "\fBset-session\fP NAME" .nf diff --git a/src/bin/lttng/commands/list.c b/src/bin/lttng/commands/list.c index 75862ffb4..1c7085dd7 100644 --- a/src/bin/lttng/commands/list.c +++ b/src/bin/lttng/commands/list.c @@ -71,7 +71,7 @@ static struct poptOption long_options[] = { */ static void usage(FILE *ofp) { - fprintf(ofp, "usage: lttng list [OPTIONS] [SESSION []]\n"); + fprintf(ofp, "usage: lttng list [OPTIONS] [SESSION [SESSION OPTIONS]]\n"); fprintf(ofp, "\n"); fprintf(ofp, "With no arguments, list available tracing session(s)\n"); fprintf(ofp, "\n"); -- 2.34.1