coreutils
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: doc: emit better output for --option=[+]count in man pages


From: Pádraig Brady
Subject: Re: doc: emit better output for --option=[+]count in man pages
Date: Sun, 27 Jul 2025 10:06:23 +0100
User-agent: Mozilla Thunderbird Beta

On 27/07/2025 01:20, Collin Funk wrote:
In the Coreutils man pages we have occurrences of:

     --option=[+]count

to indicate an optional '+' sign in the given number. The help2man
script generates poor output for these. This can be seen on the tail man
pages [1]. Here is the generated HTML:

      <b>-c</b>, <b>--bytes</b>=<i>[</i>+]NUM

Specifically, the italic tag makes the '[' appear strange. However, the
case for:

     --option=[-]count

looks much better. We can see this in the head man page [2]:

     <b>-c</b>, <b>--bytes</b>=<i>[-]NUM</i>

The attached patch fixes it. WDYT?

I tagged bug-help2man@gnu.org, but I am not sure if it even exists
because I cannot find an archive. And AFAIK it is not version
controlled, only distributed through ftp.gnu.org.

Collin

[1] https://man7.org/linux/man-pages/man1/tail.1.html
[2] https://man7.org/linux/man-pages/man1/head.1.html


+1
CC'ing Brendan O'Dea just in case.

cheers,
Padraig



reply via email to

[Prev in Thread] Current Thread [Next in Thread]