X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2FREADME.md;h=21513ba0dc5976e3dfebd56a05cf0c578371c0ac;hb=790e4a4c3a7bb09ee6d9786b704424ba5dcbf90e;hp=eb73ded2c2ebaf114065bc0afa0e5788f6788c33;hpb=d4f093aa457acf5492c099f40badcc8379c95fe9;p=lttng-tools.git diff --git a/doc/man/README.md b/doc/man/README.md index eb73ded2c..21513ba0d 100644 --- a/doc/man/README.md +++ b/doc/man/README.md @@ -32,13 +32,38 @@ 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_.