projects
/
lttng-tools.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
doc/man: add escwc macro and use it
[lttng-tools.git]
/
doc
/
man
/
README.md
diff --git
a/doc/man/README.md
b/doc/man/README.md
index fc8c81c77527a05f308b46fa07205ced42d71638..316c4d58ca2aa751afd5261c3d85b6a62998179b 100644
(file)
--- 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)`.
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
### 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_.
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
--------
Includes
--------
This page took
0.02294 seconds
and
4
git commands to generate.