GNU bug report logs - #33914
In man pages, the URL's should not be split on two lines

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 33914 in the body.
You can then email your comments to 33914 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Vincent Lefevre <vincent <at> vinc17.net>
To: bug-coreutils <at> gnu.org
Subject: In man pages, the URL's should not be split on two lines
Date: Sun, 30 Dec 2018 01:41:20 +0100

In the dircolors(1) man page (and other ones for long command names)
of GNU coreutils 8.30, as output in a 80-column terminal, one has

REPORTING BUGS
       GNU coreutils online help: <https://www.gnu.org/software/coreutils/>
       Report   dircolors   translation   bugs   to   <https://translationpro‐
       ject.org/team/>

and

SEE ALSO
       Full  documentation at: <https://www.gnu.org/software/coreutils/dircol‐
       ors>
       or available locally via: info '(coreutils) dircolors invocation'

Two of the URL's are split on two lines, making them difficult to
follow.

The corresponding dircolors.1 file contains:

Report dircolors translation bugs to <https://translationproject.org/team/>

and

Full documentation at: <https://www.gnu.org/software/coreutils/dircolors>

The issue may come from the fact that the URL's are not marked up as
such. http://man7.org/linux/man-pages/man7/groff_man.7.html mentions
macros for hyperlinks. Thus this might be the solution...

-- 
Vincent Lefèvre <vincent <at> vinc17.net> - Web: <https://www.vinc17.net/>
100% accessible validated (X)HTML - Blog: <https://www.vinc17.net/blog/>
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)

Message #10 received at 33914-done <at> debbugs.gnu.org (full text, mbox):

From: Pádraig Brady <P <at> draigBrady.com>
To: Vincent Lefevre <vincent <at> vinc17.net>, 33914-done <at> debbugs.gnu.org
Subject: Re: bug#33914: In man pages, the URL's should not be split on two
 lines
Date: Tue, 1 Jan 2019 06:42:38 -0800

[Message part 1 (text/plain, inline)]

On 29/12/18 16:41, Vincent Lefevre wrote:
> In the dircolors(1) man page (and other ones for long command names)
> of GNU coreutils 8.30, as output in a 80-column terminal, one has
> 
> REPORTING BUGS
>        GNU coreutils online help: <https://www.gnu.org/software/coreutils/>
>        Report   dircolors   translation   bugs   to   <https://translationpro‐
>        ject.org/team/>
> 
> and
> 
> SEE ALSO
>        Full  documentation at: <https://www.gnu.org/software/coreutils/dircol‐
>        ors>
>        or available locally via: info '(coreutils) dircolors invocation'
> 
> Two of the URL's are split on two lines, making them difficult to
> follow.
> 
> The corresponding dircolors.1 file contains:
> 
> Report dircolors translation bugs to <https://translationproject.org/team/>
> 
> and
> 
> Full documentation at: <https://www.gnu.org/software/coreutils/dircolors>
> 
> The issue may come from the fact that the URL's are not marked up as
> such. http://man7.org/linux/man-pages/man7/groff_man.7.html mentions
> macros for hyperlinks. Thus this might be the solution...

.UR macros do work, though are not universally available.
The attached takes the simpler approach of ensuring
the lines are short enough for an 80 column display,
for displaying 8 and 9 character command names.

cheers,
Pádraig

[url-wrap.patch (text/x-patch, attachment)]

Message #13 received at 33914 <at> debbugs.gnu.org (full text, mbox):

From: Bernhard Voelker <mail <at> bernhard-voelker.de>
To: 33914 <at> debbugs.gnu.org, P <at> draigBrady.com, vincent <at> vinc17.net
Subject: Re: bug#33914: In man pages, the URL's should not be split on two
 lines
Date: Thu, 3 Jan 2019 17:44:13 +0100

On 1/1/19 3:42 PM, Pádraig Brady wrote:
> Subject: [PATCH] doc: adjust URLS in help to avoid wrapping

s/URLS/URLs/ ?

> * src/system.h: Adjust lines containing URLs so that
> they don't wrap on 80 column terminals.  One could also
> use .UR macros, but these aren't universally available.
> Note the adjustments here need to be compatible with
> the pattern matching done in help2man.
> Addresses https://bugs.gnu.org/33914

Nice! This works also for other long utility names like for
sha???sum family.

Have a nice day,
Berny

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.