projects
/
babeltrace.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
doc: Rename to babeltrace2
[babeltrace.git]
/
doc
/
man
/
README.adoc
diff --git
a/doc/man/README.adoc
b/doc/man/README.adoc
index 1fc3bb073e358c76a9fae10ccf84c06ca8f1d4e0..1ebb48b0e3cfb729a4360ea83b9bad6101f4047f 100644
(file)
--- a/
doc/man/README.adoc
+++ b/
doc/man/README.adoc
@@
-15,17
+15,17
@@
the appropriate DocBook XSL stylesheet (using the `xmlto` command).
Main program::
+__program__.1.txt+
Main program::
+__program__.1.txt+
-`babeltrace(1)` command::
- +babeltrace-__command__.1.txt+
+`babeltrace
2
(1)` command::
+ +babeltrace
2
-__command__.1.txt+
Babeltrace introduction::
Babeltrace introduction::
- `babeltrace-intro.7.txt`
+ `babeltrace
2
-intro.7.txt`
Babeltrace plugin::
Babeltrace plugin::
- +babeltrace-plugin-__plugin__.7.txt+
+ +babeltrace
2
-plugin-__plugin__.7.txt+
Babeltrace plugin's component class::
Babeltrace plugin's component class::
- +babeltrace-__type__.__plugin__.__compcls__.7.txt+
+ +babeltrace
2
-__type__.__plugin__.__compcls__.7.txt+
== Macros
== Macros
@@
-38,7
+38,7
@@
macro definitions used everywhere in the man page sources:
+__page__+ in section +__section__+. In troff, the man page's name
is rendered in bold.
+
+__page__+ in section +__section__+. In troff, the man page's name
is rendered in bold.
+
-Example: `man:babeltrace-convert(1)`
+Example: `man:babeltrace
2
-convert(1)`
+opt:__name__+::
Use this macro to insert a link to the command-line option
+opt:__name__+::
Use this macro to insert a link to the command-line option
@@
-51,8
+51,8
@@
Example: `opt:--verbose`, `opt:--color='WHEN'`
+__name__+ described in the _OPTIONS_ section of another Babeltrace
or LTTng man page named +__page__+ in section +__section__+.
+
+__name__+ described in the _OPTIONS_ section of another Babeltrace
or LTTng man page named +__page__+ in section +__section__+.
+
-Example: `manopt:babeltrace(1):--log-level`,
-+manopt:babeltrace-convert(1):--component=\`source.ctf.fs`+
+Example: `manopt:babeltrace
2
(1):--log-level`,
++manopt:babeltrace
2
-convert(1):--component=\`source.ctf.fs`+
+nlopt:__name__+::
Use this macro to write a command-line option named +__name__+
+nlopt:__name__+::
Use this macro to write a command-line option named +__name__+
This page took
0.024281 seconds
and
4
git commands to generate.