X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2FREADME.md;h=316c4d58ca2aa751afd5261c3d85b6a62998179b;hp=4a5cbdfc6eeb62dcd7785615279b0081b0e9b215;hb=bca82bfe61d7b17cd46891072a5bb0b2680a285d;hpb=f8cdcb88f924fa5b68782f58e5dd22ff1ba7808a

diff --git a/doc/man/README.md b/doc/man/README.md
index 4a5cbdfc6..316c4d58c 100644
--- 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
 --------
 
@@ -63,7 +94,7 @@ writing new ones:
 
   * Always use macros when possible (link to other LTTng man page,
     command-line option, NOT, etc.).
-  * Use callouts for command-line examples.
+  * Use callouts with the `term` role for command-line examples.
   * Always refer to _long_ options in the text.
   * Use the `option:--option=parameter` format (with `=`) when providing
     a parameter to long options.