doc/man: add escwc macro and use it

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

diff --git a/doc/man/README.md b/doc/man/README.md
index eb73ded2c2ebaf114065bc0afa0e5788f6788c33..316c4d58ca2aa751afd5261c3d85b6a62998179b 100644 (file)
--- a/doc/man/README.md
+++ b/doc/man/README.md
@@ -32,18 +32,49 @@ name is rendered in bold, whereas the HTML5 output renders a hyperlink.
 Usage example: `linklttng: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
 
-The option macro is used to write a command-line option.
+The option macro is used to write a command-line option which is
+defined in the same man page.
 
 Usage example: `option:--no-output`, `option:--loglevel=TRACE_WARNING`
 
 
+### nloption
+
+Command-line option generating no link. This is used when talking
+about a generic option which is defined in many man pages.
+
+Usage example: `nloption:--jul`
+
+
+### genoption
+
+General (`lttng(1)`) command-line option, for generating the appropriate
+cross-man-page link.
+
+Usage example: `genoption:--group`, `genoption:--sessiond-path`
+
+
 ### not
 
 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
 --------