]>
Commit | Line | Data |
---|---|---|
cde653e0 MB |
1 | //po4a: entry man manual |
2 | //// | |
3da93af2 | 3 | Please don't treat this file as a real man page! We provide it only to show how |
cde653e0 MB |
4 | things should be formatted. Besides this example file, see the existing .adoc |
5 | files for many more formatting options. | |
6 | The first line above is a hint for po4a that the :man manual: entry needs | |
7 | to be translated. | |
8 | As you can see here, use //// to write comment blocks. For a single comment | |
9 | line, just use //. | |
10 | Please don't wrap lines within a paragraph. Our translation tool po4a behaves | |
11 | a bit unpredictable in such cases. | |
12 | We also urgently recommend to test the creation of the *roff file to see possible | |
13 | issues. | |
14 | //// | |
e2db4d94 MB |
15 | = foobar(1) |
16 | :doctype: manpage | |
17 | :man manual: User commands | |
18 | :man source: util-linux {release-version} | |
19 | :page-layout: base | |
20 | :command: foobar | |
21 | ||
22 | == NAME | |
23 | ||
24 | foobar - do nothing | |
25 | ||
26 | == SYNOPSIS | |
27 | ||
cde653e0 | 28 | *foobar* _options_ _file_ |
e2db4d94 MB |
29 | |
30 | == DESCRIPTION | |
31 | ||
32 | Describe *foobar* briefly. | |
33 | ||
34 | == OPTIONS | |
35 | ||
e08e3d58 | 36 | //Format options bold and values italic: |
cde653e0 MB |
37 | *-o*, *--option* _value_:: |
38 | This option has a value. | |
39 | + | |
993556aa | 40 | For empty lines within a description (to keep the indentation) you can use the "plus" character at the beginning of an otherwise empty line. |
cde653e0 MB |
41 | |
42 | //Last but not least, don't forget the common options: | |
e2db4d94 | 43 | *-V*, *--version*:: |
cde653e0 | 44 | Display version information and exit. |
e2db4d94 MB |
45 | |
46 | *-h*, *--help*:: | |
cde653e0 | 47 | Display help text and exit. |
e2db4d94 MB |
48 | |
49 | == NOTES | |
50 | ||
51 | Put your notes here which don't match any other paragraph. | |
52 | ||
53 | == AUTHORS | |
54 | ||
cde653e0 MB |
55 | // Format mail addresses as follows: |
56 | mailto:john.doe@example.com[John Doe] | |
57 | // If you need more than one address, use a comma-separated list or leave empty lines between the entries. | |
e2db4d94 | 58 | |
e2db4d94 MB |
59 | == SEE ALSO |
60 | ||
61 | *foo*(1), | |
62 | *bar*(1) | |
681f4a1e | 63 | |
625e9c61 | 64 | include::man-common/bugreports.adoc[] |
e2db4d94 | 65 | |
625e9c61 | 66 | include::man-common/footer.adoc[] |
e2db4d94 MB |
67 | |
68 | ifdef::translation[] | |
625e9c61 | 69 | include::man-common/translation.adoc[] |
e2db4d94 | 70 | endif::[] |