| commit | f2087dc03b12ef0874ec8a31bbc5351a3c262b37 | |
| author | Richard W.M. Jones <rjones@redhat.com> | |
| Sat, 31 Aug 2019 11:48:26 +0000 (31 12:48 +0100) | ||
| committer | Richard W.M. Jones <rjones@redhat.com> | |
| Sat, 31 Aug 2019 12:17:21 +0000 (31 13:17 +0100) | ||
| tree | 84faada2f6a1df5f483b7a2a4a6b3744629c3b51 | treesnapshot (tar.gz zip) |
| parent | 8f753368ce98f9aa557fae1ebb675d5b767118ad | commitdiff |
docs: Fix option styling.
This commit fixes the man pages in a few places to be consistent with
the usual style, described below.
(a) If it's something you would type exactly, it's all in bold, eg:
=item B<cache=unsafe>
because “cache=unsafe” actually appears on the command line.
(b) Otherwise the part you would type is in bold, and the rest is
usually¹ capitalized, eg:
=item B<cache-max-size=>SIZE
=item B<rdelay=>NNB<ms>
because “cache-max-size=1M” or “rdelay=30ms” is what would appear on
the command line.
(c) Alternatives are written on separate lines instead of using ‘|’,
eg:
=item B<fuamode=none>
=item B<fuamode=emulate>
Note that a blank line between alternatives is required by POD, but
POD also treats them as effectively a single heading/bullet.
¹ We're not very consistent about capitalization.
This commit fixes the man pages in a few places to be consistent with
the usual style, described below.
(a) If it's something you would type exactly, it's all in bold, eg:
=item B<cache=unsafe>
because “cache=unsafe” actually appears on the command line.
(b) Otherwise the part you would type is in bold, and the rest is
usually¹ capitalized, eg:
=item B<cache-max-size=>SIZE
=item B<rdelay=>NNB<ms>
because “cache-max-size=1M” or “rdelay=30ms” is what would appear on
the command line.
(c) Alternatives are written on separate lines instead of using ‘|’,
eg:
=item B<fuamode=none>
=item B<fuamode=emulate>
Note that a blank line between alternatives is required by POD, but
POD also treats them as effectively a single heading/bullet.
¹ We're not very consistent about capitalization.