From: Alejandro Colomar <alx@kernel.org>
To: astian <astian@memeware.net>
Cc: linux-man <linux-man@vger.kernel.org>
Subject: Re: ioperm(2): confusing terminology
Date: Thu, 17 Sep 2026 13:00:30 +0200 [thread overview]
Message-ID: <aqvHRZ7DfbdG5XBt@devuan> (raw)
In-Reply-To: <DLHEF3KZF52V.2PBZHFYF7KPYO@memeware.net>
[-- Attachment #1: Type: text/plain, Size: 2134 bytes --]
Hi astian,
> Date: 2026-09-17 07:04:37+0000
> From: astian <astian@memeware.net>
>
> On 14 Sep 2026 14:56 +0200, Alejandro Colomar wrote:
> [...]
> >> Which bring up the question, why not moving to a less hairy source
> >> format?
> >
> > This question comes up every now and then. TL;DR: other formats are
> > worse.
> >
> > man(7) is pretty simple, and easy to learn exactly by editing words
> > blindly. There are very few macros, and their behavior is trivial once
> > you use them a few times.
> >
> > One thing that is very important is that we use semantic newlines.
> > That discards .md and .rst, since they are meant to be written with
> > paragraphs as they'd be read by humans.
>
> Sorry, I didn't read groff_man fully, but I'm curious: what is the
> meaning of newlines in man that gets lost in those other formats?
They have no meaning.
> Looking at some source pages now and it seems most newlines are about as
> (non) meaningful as in those formats (i.e., the paragraph is reflowed
> during rendering).
I don't know how you read .md or .rst, but I read them in the terminal,
usually with less(1), which doesn't reflow them. Is there any program
for reading these in the terminal reflowed?
> > mdoc(7) is more complex than
> > man(7), and thus we don't want that. There are other formats, also
> > inappropriate, for the same or other reasons.
> >
> > A summary that will serve for 95%+ of the text written in manual pages:
> >
> > .SH section heading
> > .SS sub section
> > .B bold
> > .I italics
> >
> > Alternating per word (spaces removed):
> > .BI bold italics
> > .IB italics bold
> > .BR bold roman
> > .RB roman bold
> > .IR italics roman
> > .RI roman italics
> > (roman means normal)
> >
> > paragraph separator:
> > .P
> > Indented paragraph:
> > .IP
> > Tagged paragraph:
> > .TP
> > tag
> >
> > Examples:
> > .EX
> > this is an example (monospace, no fill)
> > .EE
>
> Thanks for the synopsis.
You're welcome!
Have a lovely day!
Alex
--
<https://www.alejandro-colomar.es>
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
next prev parent reply other threads:[~2026-09-17 11:00 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-12 22:00 ioperm(2): confusing terminology astian
2026-09-12 22:24 ` Alejandro Colomar
2026-09-12 22:48 ` Alejandro Colomar
2026-09-13 6:29 ` astian
2026-09-14 12:56 ` Alejandro Colomar
2026-09-15 15:39 ` Markdown as a "less hairy" source format for man pages (was: ioperm(2): confusing terminology) G. Branden Robinson
2026-09-17 7:05 ` Markdown as a "less hairy" source format for man pages astian
2026-09-17 7:04 ` ioperm(2): confusing terminology astian
2026-09-17 11:00 ` Alejandro Colomar [this message]
2026-09-17 19:09 ` astian
2026-09-17 19:34 ` Alejandro Colomar
2026-09-17 6:16 ` [PATCH 1/2] man/man2/ioperm.2: Reword slightly for clarity astian
2026-09-17 11:59 ` Alejandro Colomar
2026-09-17 6:16 ` [PATCH 2/2] man/man2/ioperm.2: wfix astian
2026-09-17 11:59 ` Alejandro Colomar
2026-09-17 12:38 ` ioperm(2): confusing terminology G. Branden Robinson
2026-09-17 13:18 ` Alejandro Colomar
2026-09-17 19:08 ` astian
2026-09-17 23:02 ` G. Branden Robinson
2026-09-17 19:11 ` [PATCH 2/2] man/man2/ioperm.2: wfix astian
2026-09-17 19:58 ` [PATCH] man/man5/proc_ioports.5: wfix astian
2026-09-17 23:09 ` G. Branden Robinson
2026-09-17 23:16 ` Alejandro Colomar
2026-09-18 7:03 ` [PATCH v2] " astian
2026-09-17 19:57 ` [PATCH v2] man/man2/ioperm.2: wfix astian
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=aqvHRZ7DfbdG5XBt@devuan \
--to=alx@kernel.org \
--cc=astian@memeware.net \
--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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.