macro definitions used everywhere in the man page sources.
-### linklttng
+### man
-The linklttng macro is used to link to another LTTng man page. Its
-output is different depending on the back-end. In troff, the man page
-name is rendered in bold, whereas the HTML5 output renders a hyperlink.
+The man macro is used to link to another man page. In troff, the man
+page name is rendered in bold.
-Usage example: `linklttng:lttng-enable-channel(1)`.
+Usage example: `man: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
--------
- * `common-cmd-footer.txt`: common `lttng` command footer.
- * `common-cmd-help-options.txt`: common program information section
- of `lttng` command options.
+ * `common-lttng-cmd-after-options.txt`: common part after the options
+ section of an `lttng` command.
+ * `common-lttng-cmd-help-options.txt`: common program information
+ section of `lttng` command options.
* `common-cmd-options-head.txt`: common `lttng` command head of
options section.
* `common-footer.txt`: common footer for all commands.
* 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.