From: Lennart Jablonka <humm@ljabl.com>
To: Keith Marshall <keith.d.marshall@ntlworld.com>,
linux-man@vger.kernel.org, Alejandro Colomar <alx@kernel.org>
Subject: Re: man page style conventions
Date: Sun, 14 Apr 2024 13:51:33 +0000 [thread overview]
Message-ID: <ZhvfZTXkwbun_tkR@fluorine> (raw)
In-Reply-To: <bcc2e2ec-32af-4254-a2c9-1884f28af407@ntlworld.com>
Quoth Keith Marshall:
>In my personal opinion, FWIW, the use of italics in this context is just
>plain ugly. Opinion aside, it does not conform to the convention, as it
>is stated in man-pages(7) -- either the convention needs to be changed,
>by common consent, or groff_man(7) needs to be brought to heel.
In addition to what Alex and Branden said, I will note that
man-pages(7) contains this at the very beginning:
>This page describes the conventions that should be employed when
>writing man pages for the Linux man-pages project, which
>documents the user-space API provided by the Linux kernel and the
>GNU C library. The project thus provides most of the pages in
>Section 2, many of the pages that appear in Sections 3, 4, and 7,
>and a few of the pages that appear in Sections 1, 5, and 8 of the
>man pages on a Linux system. The conventions described on this
>page may also be useful for authors writing man pages for other
>projects.
man-pages(7) is pretty much prescriptive for the linux-man-pages
project. It is also something likely to be seen by someone
wanting to learn how to write a man page, but it still is
independent of what Groff does. There exist different conventions
for how to write man pages. The <opinion>obviously traditionally
correct</opinion> way of referring to other man pages is with
explicit italics; the new Groff way is to use .MR; the
linux-man-pages way is to embolden the title.
groff_man(7) conforms to the conventions—to /its/ conventions.
The discrepancy between man-pages(7) and groff_man(7) does not
imply that either has to change.
But yes, in my opinion, man-pages(7) should change. I think it
should probably go away, or stay inside the linux-man-pages
repository, not getting installed. It is, after all,
linux-man-pages-specific and groff_man_style(7) exists.
Or it could be renamed. linux-man-pages(7).
linux-man-pages-man-pages(7).
prev parent reply other threads:[~2024-04-14 13:58 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-13 12:22 man page style conventions Keith Marshall
2024-04-13 14:01 ` G. Branden Robinson
2024-04-13 18:39 ` Alejandro Colomar
2024-04-14 13:51 ` Lennart Jablonka [this message]
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=ZhvfZTXkwbun_tkR@fluorine \
--to=humm@ljabl.com \
--cc=alx@kernel.org \
--cc=keith.d.marshall@ntlworld.com \
--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