doc/man: add nloption and genoption AsciiDoc macros

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

diff --git a/doc/man/README.md b/doc/man/README.md
index eb73ded2c2ebaf114065bc0afa0e5788f6788c33..fc8c81c77527a05f308b46fa07205ced42d71638 100644 (file)
--- a/doc/man/README.md
+++ b/doc/man/README.md
@@ -34,11 +34,28 @@ Usage example: `linklttng:lttng-enable-channel(1)`.
 
 ### 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_.