bulleted list conventions
From: Mike Frysinger <hidden>
Date: 2022-10-22 19:45:01
Attachments
- signature.asc [application/pgp-signature] 833 bytes
From: Mike Frysinger <hidden>
Date: 2022-10-22 19:45:01
man-pages(7) is silent on how to handled lists. the only reference i can see
is in an aside in an unrelated section:
When enumerating a list of error codes, the codes are in bold
(this list usually uses the .TP macro).
glancing through existing man pages, it seems that `.IP` is the answer. but
beyond that, we only have chaos. can we pick & document a standard here ?
for numbered lists, the tags are manually maintained, but use a few diff
styles like:
.IP 1
.IP 1.
.IP 1)
.IP (1)
.IP [1]
.IP 1:
there's also alternative lists that use a few diff styles:
.IP a)
.IP (a)
for unordered lists, there's a couple of diff bullet point styles:
*
\(bu
\-
o
+
the * form seems to be the most dominate, but \(bu shows up a good amount.
* is a bit easier to type, but \(bu renders "more correctly" ? *shrug*
finally there's the matter of indentation level. 3 seems to be the most
common, but there's a healthy amount of 2 in there too.
.IP * 3
.IP * 2
-mike