From nobody Thu Jun 9 14:32:55 2022 X-Original-To: freebsd-hackers@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id E17818333DD for ; Thu, 9 Jun 2022 14:32:58 +0000 (UTC) (envelope-from sgk@troutmask.apl.washington.edu) Received: from troutmask.apl.washington.edu (troutmask.apl.washington.edu [128.95.76.21]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (2048 bits) client-digest SHA256) (Client CN "troutmask", Issuer "troutmask" (not verified)) by mx1.freebsd.org (Postfix) with ESMTPS id 4LJmls3h3gz3rqs; Thu, 9 Jun 2022 14:32:57 +0000 (UTC) (envelope-from sgk@troutmask.apl.washington.edu) Received: from troutmask.apl.washington.edu (localhost [127.0.0.1]) by troutmask.apl.washington.edu (8.16.1/8.16.1) with ESMTPS id 259EWt8Z036359 (version=TLSv1.3 cipher=TLS_AES_256_GCM_SHA384 bits=256 verify=NO); Thu, 9 Jun 2022 07:32:56 -0700 (PDT) (envelope-from sgk@troutmask.apl.washington.edu) Received: (from sgk@localhost) by troutmask.apl.washington.edu (8.16.1/8.16.1/Submit) id 259EWtmO036358; Thu, 9 Jun 2022 07:32:55 -0700 (PDT) (envelope-from sgk) Date: Thu, 9 Jun 2022 07:32:55 -0700 From: Steve Kargl To: Baptiste Daroussin Cc: freebsd-hackers@freebsd.org Subject: Re: mandoc and volume titles Message-ID: Reply-To: sgk@troutmask.apl.washington.edu References: <20220609071702.umix3bbub3qxunlq@aniel.nours.eu> List-Id: Technical discussions relating to FreeBSD List-Archive: https://lists.freebsd.org/archives/freebsd-hackers List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-freebsd-hackers@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20220609071702.umix3bbub3qxunlq@aniel.nours.eu> X-Rspamd-Queue-Id: 4LJmls3h3gz3rqs X-Spamd-Bar: - Authentication-Results: mx1.freebsd.org; dkim=none; dmarc=fail reason="No valid SPF, No valid DKIM" header.from=washington.edu (policy=none); spf=none (mx1.freebsd.org: domain of sgk@troutmask.apl.washington.edu has no SPF policy when checking 128.95.76.21) smtp.mailfrom=sgk@troutmask.apl.washington.edu X-Spamd-Result: default: False [-1.40 / 15.00]; HAS_REPLYTO(0.00)[sgk@troutmask.apl.washington.edu]; ARC_NA(0.00)[]; MID_RHS_MATCH_FROM(0.00)[]; FROM_HAS_DN(0.00)[]; TO_DN_SOME(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; NEURAL_HAM_LONG(-1.00)[-1.000]; MIME_GOOD(-0.10)[text/plain]; REPLYTO_ADDR_EQ_FROM(0.00)[]; NEURAL_SPAM_MEDIUM(0.12)[0.121]; NEURAL_HAM_SHORT(-0.52)[-0.517]; RCPT_COUNT_TWO(0.00)[2]; MLMMJ_DEST(0.00)[freebsd-hackers]; R_SPF_NA(0.00)[no SPF record]; FROM_EQ_ENVFROM(0.00)[]; R_DKIM_NA(0.00)[]; MIME_TRACE(0.00)[0:+]; ASN(0.00)[asn:73, ipnet:128.95.0.0/16, country:US]; RCVD_COUNT_TWO(0.00)[2]; RCVD_TLS_ALL(0.00)[]; DMARC_POLICY_SOFTFAIL(0.10)[washington.edu : No valid SPF, No valid DKIM,none] X-ThisMailContainsUnwantedMimeParts: N On Thu, Jun 09, 2022 at 09:17:02AM +0200, Baptiste Daroussin wrote: > On Wed, Jun 08, 2022 at 04:35:08PM -0700, Steve Kargl wrote: > > All, > > > > mandoc and mdoc(7) are a convenient system for writing > > documentation, but it has a drawback. The volume > > title is hardcoded to a FreeBSD manual page. For my > > personal projects, I would like to change the volume > > title. For example. > > > > % mandoc tier.1 | head -1 > > TIER(1) FreeBSD General Commands Manual TIER(1) > > > > I have hacked up mandoc to accept a -V option, which allows e.g., > > > > % mandoc -V "Steve's Menagerie" tier.1 | head -1 > > TIER(1) Steve's Menagerie TIER(1) > > > > I have created a bug report and attached the diff to it > > if anyone is interested. > > > > https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=264560 > > Hello Steve, > > Regarding mandoc, I would like to keep it with as little custom patches > as possible, regarding your patch, it sounds like a useful feature, have > you considered talking directly to upstream about it to see if they are > willing to integrate it directly? > > https://mandoc.bsd.lv/contact.html ? > > They are friendly and usually reactive. > I was pointed to upstream in the bug report. While a -V option would work for me with single files, I think adding a .Vl macro would be better. The top of a file would look like .Vl Volume Title .Dd June 8, 2022 .Dt TIER 1 This would allow a specific volume title on each file such as % mandoc -T pdf manual.1 appendx.1 > manaul.pdf MANUAL(1) Project X Tech Specs MANUAL(1) ... APPENDEX(1) Support Library APPENDIX(1) I'll try talking to upstream. -- Steve