public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: Mike Frysinger <vapier@gentoo.org>
To: linux-man@vger.kernel.org
Subject: bulleted list conventions
Date: Sun, 23 Oct 2022 00:15:25 +0545	[thread overview]
Message-ID: <Y1Q2wbahzVSvLPyw@vapier> (raw)

[-- Attachment #1: Type: text/plain, Size: 988 bytes --]

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

             reply	other threads:[~2022-10-22 19:45 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-10-22 18:30 Mike Frysinger [this message]
2022-10-22 18:44 ` bulleted list conventions Mike Frysinger
2022-10-22 22:12   ` Alejandro Colomar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=Y1Q2wbahzVSvLPyw@vapier \
    --to=vapier@gentoo.org \
    --cc=linux-man@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox