Subject: bug#33914: closed (Re: bug#33914: In man pages, the URL's should not be split on two lines)

From: [email-masked] (GNU bug Tracking System)
Date: Tue, 01 Jan 2019 14:43:01 +0000

Your bug report

#33914: In man pages, the URL's should not be split on two lines

which was filed against the coreutils package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to [email-masked].

-- 
33914: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=33914
GNU Bug Tracking System
Contact [email-masked] with problems

Subject: Re: bug#33914: In man pages, the URL's should not be split on two lines
From: Pádraig Brady <[email-masked]>
To: Vincent Lefevre <[email-masked]>, [email-masked]
Date: Tue, 1 Jan 2019 06:42:38 -0800
List-Id: <debbugs-submit.debbugs.gnu.org>

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

From 8ec3103e509b34ce3d1231b8b754b265b9296a08 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?P=C3=A1draig=20Brady?= <[email-masked]>
Date: Tue, 1 Jan 2019 06:34:14 -0800
Subject: [PATCH] doc: adjust URLS in help to avoid wrapping

* 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
---
 src/system.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/system.h b/src/system.h
index f5231d5..540da66 100644
--- a/src/system.h
+++ b/src/system.h
@@ -660,10 +660,10 @@ emit_ancillary_info (char const *program)
          <https://translationproject.org/team/LANG_CODE.html> to form one of
          the URLs at https://translationproject.org/team/.  Otherwise, replace
          the entire URL with your translation team's email address.  */
-      printf (_("Report %s translation bugs to "
-                "<https://translationproject.org/team/>\n"), program);
+      fputs (_("Report any translation bugs to "
+               "<https://translationproject.org/team/>\n"), stdout);
     }
-  printf (_("Full documentation at: <%s%s>\n"),
+  printf (_("Full documentation <%s%s>\n"),
           PACKAGE_URL, program);
   printf (_("or available locally via: info '(coreutils) %s%s'\n"),
           node, node == program ? " invocation" : "");
-- 
2.9.3

Subject: In man pages, the URL's should not be split on two lines
From: Vincent Lefevre <[email-masked]>
To: [email-masked]
Date: Sun, 30 Dec 2018 01:41:20 +0100
List-Id: <debbugs-submit.debbugs.gnu.org>

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 <[email-masked]> - 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)