man/README.md: Update asciidoc url to asciidoc.org

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

diff --git a/doc/man/README.md b/doc/man/README.md
index fc8c81c77527a05f308b46fa07205ced42d71638..ef1cd655580e93741f38f935840d8f26ee599e5b 100644 (file)
--- a/doc/man/README.md
+++ b/doc/man/README.md
@@ -4,7 +4,7 @@ LTTng-tools man pages
 This directory contains the sources of the LTTng-tools man pages.
 
 LTTng-tools man pages are written in
-[AsciiDoc](http://www.methods.co.nz/asciidoc/), and then converted to
+[AsciiDoc](https://asciidoc.org/), and then converted to
 DocBook (XML) using the `asciidoc` command, and finally to troff using
 the appropriate DocBook XSL stylesheet (using the `xmlto` command).
 
@@ -23,13 +23,20 @@ AsciiDoc is configured with `asciidoc.conf` which contains a few
 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
@@ -61,12 +68,19 @@ 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
 --------
 
-  * `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.