X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-help.1.txt;h=ede7b88f4d866586e49e6973ebf48189d454800c;hp=132c5d62d9fe77ce239c8bb63f22aaf1e57e322c;hb=db0f7697361017ef0d00b2faf322b131b138fca5;hpb=afaad15a0af7051bf4f0d4e80d5f1f606b74576e diff --git a/doc/man/lttng-help.1.txt b/doc/man/lttng-help.1.txt index 132c5d62d..ede7b88f4 100644 --- a/doc/man/lttng-help.1.txt +++ b/doc/man/lttng-help.1.txt @@ -10,7 +10,7 @@ lttng-help - Display help information about an LTTng command SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *help* ['COMMAND'] +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *help* ['COMMAND'] DESCRIPTION @@ -20,13 +20,14 @@ command. This command is the equivalent of: --------------------- -lttng COMMAND --help --------------------- +[role="term"] +---- +$ 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. +man: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 @@ -44,4 +45,4 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -linklttng:lttng(1) +man:lttng(1)