X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2FREADME.md;h=1b0233b8e9975c2b1658b0f54723bc2e522d1c6e;hb=efacf910532303b8208a2e68a002e54c8b810f6b;hp=316c4d58ca2aa751afd5261c3d85b6a62998179b;hpb=bca82bfe61d7b17cd46891072a5bb0b2680a285d;p=lttng-tools.git diff --git a/doc/man/README.md b/doc/man/README.md index 316c4d58c..1b0233b8e 100644 --- a/doc/man/README.md +++ b/doc/man/README.md @@ -23,13 +23,12 @@ AsciiDoc is configured with `asciidoc.conf` which contains a few macro definitions used everywhere in the man page sources. -### linklttng +### man -The linklttng macro is used to link to another LTTng man page. Its -output is different depending on the back-end. In troff, the man page -name is rendered in bold, whereas the HTML5 output renders a hyperlink. +The man macro is used to link to another man page. In troff, the man +page name is rendered in bold. -Usage example: `linklttng:lttng-enable-channel(1)`. +Usage example: `man:lttng-enable-channel(1)`. ### linkgenoptions @@ -78,9 +77,10 @@ which is not so easy to do otherwise. Includes -------- - * `common-cmd-footer.txt`: common `lttng` command footer. - * `common-cmd-help-options.txt`: common program information section - of `lttng` command options. + * `common-lttng-cmd-after-options.txt`: common part after the options + section of an `lttng` command. + * `common-lttng-cmd-help-options.txt`: common program information + section of `lttng` command options. * `common-cmd-options-head.txt`: common `lttng` command head of options section. * `common-footer.txt`: common footer for all commands.