common: move copy_filter_bytecode to bytecode.c and rename it

[lttng-tools.git] / doc / man / README.md

diff --git a/doc/man/README.md b/doc/man/README.md
index fc8c81c77527a05f308b46fa07205ced42d71638..c904d77a6d5d9696b29e8d5f6df76377f7f028a2 100644 (file)
--- 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
 --------