Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 9 Jun 2022 15:33:56 -0700
From:      Steve Kargl <sgk@troutmask.apl.washington.edu>
To:        Steffen Nurpmeso <steffen@sdaoden.eu>
Cc:        Baptiste Daroussin <bapt@freebsd.org>, freebsd-hackers@freebsd.org
Subject:   Re: mandoc and volume titles
Message-ID:  <YqJ1VOcJYbXBg85T@troutmask.apl.washington.edu>
In-Reply-To: <20220609214906.6--d0%steffen@sdaoden.eu>
References:  <YqEyLFHI8GQi6NLc@troutmask.apl.washington.edu> <20220609071702.umix3bbub3qxunlq@aniel.nours.eu> <YqIEl0SgJytjD%2BAW@troutmask.apl.washington.edu> <20220609152904.gc9ue%steffen@sdaoden.eu> <YqIiLQUI7Y/QH3Qg@troutmask.apl.washington.edu> <20220609165536.A5vGK%steffen@sdaoden.eu> <YqJihG7hegKkNj6M@troutmask.apl.washington.edu> <20220609214906.6--d0%steffen@sdaoden.eu>

next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, Jun 09, 2022 at 11:49:06PM +0200, Steffen Nurpmeso wrote:
> Steve Kargl wrote in
>  |
>  |The first 6 lives of my file are
>  |
>  |.ds volume-operating-system steve
>  |.ds volume-ds-8 kargl
> 
> If you use ".Dt TDI 1", you must set volume-ds-1.
> 
>  |.Dd June 8, 2022
>  |.Dt TDI 1
>  |.Sh NAME
>  |.Nm tdi
>  |
>  |% mandoc tdi.1 | head -1
> 
> This is mandoc Mr. Kargl.

Well, yes, that's what I've been talking about.

The .ds stuff you mention is not documented in mandoc(1)
nor the mdoc(7) manpages.  Adding 

.ds doc-volume-operating-system Steve
.ds doc-volume-ds-4 Kargl

to a file does not override the volume title when using mandoc.

% cat steve.4
.Dd June 8, 2022
.ds doc-volume-operating-system Steve
.ds doc-volume-ds-4 Kargl
.Dt TDI 4
.Sh NAME
.Nm tdi
Hi.
% mandoc steve.4
TDI(4)                 FreeBSD Kernel Interfaces Manual                 TDI(4)

NAME
     tdi Hi.

                                 June 8, 2022

I gave mandoc a -V option to do the override.

% mandoc -V "Steve Kargl" steve.4
TDI(4)                            Steve Kargl                           TDI(4)

NAME
     tdi Hi.

                                 June 8, 2022

Having to install groff and adding undocumented .ds magic isn't the
solution for a FreeBSD base system functionality.  In fact, I think
it would be better to have the mdoc(7) package grow a .Vl macro to
allow the volume title to be easily overridden.

-- 
Steve



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?YqJ1VOcJYbXBg85T>