X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2FREADME.md;h=c904d77a6d5d9696b29e8d5f6df76377f7f028a2;hp=21513ba0dc5976e3dfebd56a05cf0c578371c0ac;hb=763f0d4cef1438d3f1f5f5c5a232d72628bca550;hpb=8cfee8a59575abffbfced99788d3499235b828a9 diff --git a/doc/man/README.md b/doc/man/README.md index 21513ba0d..c904d77a6 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 @@ -69,6 +68,12 @@ Usage example: `genoption:--group`, `genoption:--sessiond-path` The `:not:` macro is used to emphasize on _not_. +### escwc + +The `:escwc:` macro is used to output `\*` literally in the man page, +which is not so easy to do otherwise. + + Includes --------