X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2FREADME.md;h=c904d77a6d5d9696b29e8d5f6df76377f7f028a2;hb=adc4b5c84ab187cafb8b5368bdfd4b6be5b1faf5;hp=fc8c81c77527a05f308b46fa07205ced42d71638;hpb=b5217c86b634aeb62d9b37614a2d0081b3c7a981;p=lttng-tools.git

diff --git a/doc/man/README.md b/doc/man/README.md
index fc8c81c77..c904d77a6 100644
--- a/doc/man/README.md
+++ b/doc/man/README.md
@@ -23,13 +23,20 @@ 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
+
+The linkgenoptions macro is used to link to the general options
+section of the `lttng(1)` command.
+
+Usage example: `See the linkgenoptions:(general options).`.
 
 
 ### option
@@ -61,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
 --------