X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2FREADME.md;h=fc8c81c77527a05f308b46fa07205ced42d71638;hp=4a5cbdfc6eeb62dcd7785615279b0081b0e9b215;hb=b5217c86b634aeb62d9b37614a2d0081b3c7a981;hpb=f8cdcb88f924fa5b68782f58e5dd22ff1ba7808a diff --git a/doc/man/README.md b/doc/man/README.md index 4a5cbdfc6..fc8c81c77 100644 --- 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_. @@ -63,7 +80,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.