Commit | Line | Data |
---|---|---|
f8cdcb88 PP |
1 | LTTng-tools man pages |
2 | ===================== | |
3 | ||
4 | This directory contains the sources of the LTTng-tools man pages. | |
5 | ||
6 | LTTng-tools man pages are written in | |
7 | [AsciiDoc](http://www.methods.co.nz/asciidoc/), and then converted to | |
8 | DocBook (XML) using the `asciidoc` command, and finally to troff using | |
9 | the appropriate DocBook XSL stylesheet (using the `xmlto` command). | |
10 | ||
11 | ||
12 | Custom XSL stylesheets | |
13 | ---------------------- | |
14 | ||
15 | There are a few custom XSL stylesheets applied for customizing the | |
16 | generated man pages in the `xsl` directory. | |
17 | ||
18 | ||
19 | Macros | |
20 | ------ | |
21 | ||
22 | AsciiDoc is configured with `asciidoc.conf` which contains a few | |
23 | macro definitions used everywhere in the man page sources. | |
24 | ||
25 | ||
26 | ### linklttng | |
27 | ||
28 | The linklttng macro is used to link to another LTTng man page. Its | |
29 | output is different depending on the back-end. In troff, the man page | |
30 | name is rendered in bold, whereas the HTML5 output renders a hyperlink. | |
31 | ||
32 | Usage example: `linklttng:lttng-enable-channel(1)`. | |
33 | ||
34 | ||
35 | ### option | |
36 | ||
1cdba677 PP |
37 | The option macro is used to write a command-line option which is |
38 | defined in the same man page. | |
f8cdcb88 PP |
39 | |
40 | Usage example: `option:--no-output`, `option:--loglevel=TRACE_WARNING` | |
41 | ||
42 | ||
1cdba677 PP |
43 | ### nloption |
44 | ||
45 | Command-line option generating no link. This is used when talking | |
46 | about a generic option which is defined in many man pages. | |
47 | ||
48 | Usage example: `nloption:--jul` | |
49 | ||
50 | ||
51 | ### genoption | |
52 | ||
53 | General (`lttng(1)`) command-line option, for generating the appropriate | |
54 | cross-man-page link. | |
55 | ||
56 | Usage example: `genoption:--group`, `genoption:--sessiond-path` | |
57 | ||
58 | ||
f8cdcb88 PP |
59 | ### not |
60 | ||
61 | The `:not:` macro is used to emphasize on _not_. | |
62 | ||
63 | ||
64 | Includes | |
65 | -------- | |
66 | ||
67 | * `common-cmd-footer.txt`: common `lttng` command footer. | |
68 | * `common-cmd-help-options.txt`: common program information section | |
69 | of `lttng` command options. | |
70 | * `common-cmd-options-head.txt`: common `lttng` command head of | |
71 | options section. | |
72 | * `common-footer.txt`: common footer for all commands. | |
73 | ||
74 | ||
75 | Convention | |
76 | ---------- | |
77 | ||
78 | Please follow those rules when updating the current man pages or | |
79 | writing new ones: | |
80 | ||
81 | * Always use macros when possible (link to other LTTng man page, | |
82 | command-line option, NOT, etc.). | |
5e72f0b0 | 83 | * Use callouts with the `term` role for command-line examples. |
f8cdcb88 PP |
84 | * Always refer to _long_ options in the text. |
85 | * Use the `option:--option=parameter` format (with `=`) when providing | |
86 | a parameter to long options. | |
87 | * Write _user space_, not _userspace_ nor _user-space_. | |
88 | (neither _user land_). | |
89 | * Write _file system_, not _filesystem_. | |
90 | * Write _use case_, not _use-case_ nor _usecase_. | |
91 | * Write _log level_, not _loglevel_. | |
92 | * Write complete LTTng project names: _LTTng-modules_, _LTTng-UST_ and | |
93 | _LTTng-tools_, not _modules_, _UST_ and _tools_. | |
94 | * Prefer simple emphasis to strong emphasis for emphasizing text. | |
95 | * Try to stay behind the 72th column mark if possible, and behind | |
96 | the 80th column otherwise. | |
97 | * Do not end directory paths with a forward slash | |
98 | (good: `include/trace/events`, bad: `include/trace/events/`). | |
99 | * Minimize the use of the future tense (_will_). | |
100 | * Do not use Latin abbreviations (_e.g._, _i.e._, _etc._). |