From afaad15a0af7051bf4f0d4e80d5f1f606b74576e Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Sat, 14 Nov 2015 00:29:39 -0500 Subject: [PATCH] doc/man: create lttng-help(1) and update/fix content 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 --- doc/man/Makefile.am | 3 ++- doc/man/lttng-help.1.txt | 47 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 doc/man/lttng-help.1.txt diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index d856276f4..27225dd27 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -25,7 +25,8 @@ MAN1_NAMES = \ lttng-calibrate \ lttng-track \ lttng-untrack \ - lttng-status + lttng-status \ + lttng-help MAN3_NAMES = MAN8_NAMES = MAN1_NO_ASCIIDOC_NAMES = lttng-crash diff --git a/doc/man/lttng-help.1.txt b/doc/man/lttng-help.1.txt new file mode 100644 index 000000000..132c5d62d --- /dev/null +++ b/doc/man/lttng-help.1.txt @@ -0,0 +1,47 @@ +lttng-help(1) +============= + + +NAME +---- +lttng-help - Display help information about an LTTng command + + +SYNOPSIS +-------- +[verse] +*lttng* ['GENERAL OPTIONS'] *help* ['COMMAND'] + + +DESCRIPTION +----------- +The `lttng help` command displays help information about an LTTng +command. + +This command is the equivalent of: + +-------------------- +lttng COMMAND --help +-------------------- + +where `COMMAND` is the name of the command about which to get help. If +'COMMAND' is omitted, `lttng help` shows general help about the +linklttng:lttng(1) command. + +The `lttng help` command attempts to launch `/usr/bin/man` to view +the command's man page. The path to the man pager can be overridden +by the `LTTNG_MAN_BIN_PATH` environment variable. + + +include::common-cmd-options-head.txt[] + + +include::common-cmd-help-options.txt[] + + +include::common-cmd-footer.txt[] + + +SEE ALSO +-------- +linklttng:lttng(1) -- 2.34.1