public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: Lennart Jablonka <humm@ljabl.com>
To: "G. Branden Robinson" <g.branden.robinson@gmail.com>, groff@gnu.org
Cc: linux-man@vger.kernel.org, bug-ncurses@gnu.org, alx@kernel.org
Subject: Re: Proposed v2: revised man(7) synopsis macros
Date: Fri, 26 Apr 2024 21:54:15 +0000	[thread overview]
Message-ID: <ZiwihxockR9UOCxV@fluorine> (raw)
In-Reply-To: <20240426055958.3hzal6m4r7mgzhqj@illithid>

Quoth G. Branden Robinson:
>I have been dissatisfied with groff man(7)'s SY and YS macros for a long
>time.  My primary grievance is one that has frustrated its uptake by
>documenters of libraries: the macros are designed for synopsizing Unix
>commands, not C library functions.
>
>After working on the ncurses man pages for a while it became clear to me
>how to modestly revise the way groff man(7)'s SY and YS macros work to
>serve both sets of authors better.

I’m sure this is good and fine, but I do wanna mention this: 
SYNOPSIS items with lines after the first one aligned, possibly 
with something on the first line, is like the one usecase for .HP.  
I think it would be good to mention that, even if Groff deprecates 
.HP (because HTML is incapable of expressing that?  I don’t like 
that reason.  Besides, CSS has `text-indent: $length hanging` 
now).

  parent reply	other threads:[~2024-04-26 22:00 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-26  5:59 Proposed v2: revised man(7) synopsis macros G. Branden Robinson
2024-04-26  9:32 ` Alejandro Colomar
2024-05-03 20:31   ` G. Branden Robinson
2024-05-05 12:41     ` Alejandro Colomar
2024-05-05 12:44       ` Alejandro Colomar
     [not found]         ` <20240505135453.4rxsqe3so7347mli@illithid>
     [not found]           ` <ZjeTilIR86sBYrtI@debian>
2024-05-05 14:28             ` Alejandro Colomar
2024-05-05 14:32               ` G. Branden Robinson
2024-05-05 14:45                 ` Alejandro Colomar
2024-04-26 21:54 ` Lennart Jablonka [this message]
2024-04-26 22:31   ` Undeprecating man(7)'s `HP` macro? (was: Proposed v2: revised man(7) synopsis macros) G. Branden Robinson
2024-04-29  8:39 ` Proposed v2: revised man(7) synopsis macros G. Branden Robinson

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=ZiwihxockR9UOCxV@fluorine \
    --to=humm@ljabl.com \
    --cc=alx@kernel.org \
    --cc=bug-ncurses@gnu.org \
    --cc=g.branden.robinson@gmail.com \
    --cc=groff@gnu.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