Re: How to set URLs in man pages

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

 



Hi Branden,

On Thu, Dec 19, 2024 at 10:19:12AM -0600, G. Branden Robinson wrote:
> Here's the exhibit Alex handled recently:
> 
> At 2024-12-19T12:08:35+0100, Alejandro Colomar wrote:
> > I've had to amend the patch again.  I didn't notice that it caused
> > many warnings in -Tutf8, -Thtml, -Tps, and -Tpdf output.  I've applied
> > the following diff.
> > 
> > diff --git a/man/man3/getopt.3 b/man/man3/getopt.3
> > index 3b0025528..cb946355a 100644
> > --- a/man/man3/getopt.3
> > +++ b/man/man3/getopt.3
> > @@ -384,7 +384,7 @@ .SH HISTORY
> >  .IR <stdio.h> .
> >  .P
> >  Very old versions of glibc were affected by a
> > -.UR https://sourceware.org/git/?p=glibc.git;a=commitdiff;h=bf079e19f50d64aa5e05b5e17ec29afab9aabb20
> > +.UR https://\:sourceware.org/\:git/\:?p=glibc.git;a=commitdiff;h=bf079e19f50d64aa5e05
> >  .BI _ PID _GNU_nonoption_argv_flags_
> >  environment variable
> >  .UE .
> > 
> > That adds break points, and also reduces the hash by half (which
> > should hold without clashes forever, hopefully).
> 
> I observe that break points could also be added after semicolons.

I would have done that if there was another warning.  But I prefer to
keep that part as a single token, if not necessary.

> 
> Also, you can escape a newline to keep the input line length short.

I prefer to keep the input line unbroken.  It makes it easier to sed(1)
stuff later.

It keeps the language simpler.


Have a lovely night!
Alex

> .UR https://\:sourceware.org/\:git/\:?p=glibc.git;a=commitdiff;\
> h=bf079e19f50d64aa5e05
> 
> groff_man_style(7):
>      \newline  Join the next input line to the current one.  Except for
>                the update of the input line counter (used for diagnostic
>                messages and related purposes), a series of lines ending
>                in backslash‐newline appears to groff as a single input
>                line.  Use this escape sequence to split excessively long
>                input lines for document maintenance.
> 
> Regards,
> Branden



-- 
<https://www.alejandro-colomar.es/>

Attachment: signature.asc
Description: PGP signature


[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux