X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2FREADME.md;h=316c4d58ca2aa751afd5261c3d85b6a62998179b;hp=fc8c81c77527a05f308b46fa07205ced42d71638;hb=bca82bfe61d7b17cd46891072a5bb0b2680a285d;hpb=b5217c86b634aeb62d9b37614a2d0081b3c7a981 diff --git a/doc/man/README.md b/doc/man/README.md index fc8c81c77..316c4d58c 100644 --- a/doc/man/README.md +++ b/doc/man/README.md @@ -32,6 +32,14 @@ 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 which is @@ -61,6 +69,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 --------