From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wr1-f52.google.com (mail-wr1-f52.google.com [209.85.221.52]) by fantadrom.bsd.lv (OpenSMTPD) with ESMTP id 53841804 for ; Thu, 13 Sep 2018 10:36:23 -0500 (EST) Received: by mail-wr1-f52.google.com with SMTP id 20-v6so6383915wrb.12 for ; Thu, 13 Sep 2018 08:36:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=date:from:to:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=gJhAO8uLqcNRCRDTckyNB8cLy/yZEn0msjbxKnLwB98=; b=I1D+aitXPJ6XHzWUFboeVg7UaZCfGuz4lLfuKVaHr0H5yCSWzK1P58XDkZ+LAY3T89 bLfT2Lq527cZLXSrpLnGV24JGMIT4S5N7lnTamy3l29mIZu2OiDQ+1CK7Dvyrx/tYqQq EvIXvTiESAXF2zJraLbd99/GBLwJW6FT6jnYH/7nktRMxZT4rRdeImMxbUPAl6VKjlPW neBace0TRyDISb+7+/nNZ4P8gvCkQ9YogquyexQktEwzgMUnfCQgSICymoDSdOdZDRFW KEQnkC5AYEQrrdkDJnOPU8ToaX7ZHT4s9q/6eyY/GX9X78D7p8yo5ei5m3j2tNL6sL+M CQMA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=gJhAO8uLqcNRCRDTckyNB8cLy/yZEn0msjbxKnLwB98=; b=FOMfqv0n4FiKMik9tpl62gmg1QVJ0eHIE2H/iIfWjKgx7l4pTTpHoIPd8m5g7uhHs4 SQYPExN/3O+mk4alD+OD7vGqRgP/n3hgUF+dwTXfRoEmhLHJngS7KUrsCqro3q+do8Y6 I1Uy2aJsRPgBnMGBjuoS4Pw6VqJnbdvvCNZ1MlcHEn7inuRgwuqN3TLmF9IvMFHj/qQk siFpMCinFsD3MOl5ilekgtq07QhYyR4UrpGV2hULpgq4xNixNzhBYdFTWJNDelTRsWQc SQtWw5LXt4Z8NplXIotRE5rZ/gAcLv+nyBdopT9aAWYQoGkjZWZFKk3WfJEpZS9ofV9N W8cA== X-Gm-Message-State: APzg51ALzUYqnhiEqkQ6gBNf/Izds/kl5nBnPLv6q95/bS9aOLxKCPr+ PuVPodgFk6AcgL8QvMx+yHZJXxca X-Google-Smtp-Source: ANB0VdZ9mwyczTb+3DbFuU5E5MzJFwFiFFmdtfT74+OsWWngRgeEFDT+fnmIyGARxVsTW3gQVJrmcQ== X-Received: by 2002:a1c:2283:: with SMTP id i125-v6mr6067133wmi.28.1536852982642; Thu, 13 Sep 2018 08:36:22 -0700 (PDT) Received: from pali ([2a02:2b88:2:1::5cc6:2f]) by smtp.gmail.com with ESMTPSA id 94-v6sm5491247wrc.10.2018.09.13.08.36.21 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Thu, 13 Sep 2018 08:36:21 -0700 (PDT) Date: Thu, 13 Sep 2018 17:36:21 +0200 From: Pali =?utf-8?B?Um9ow6Fy?= To: discuss@mandoc.bsd.lv Subject: Re: mandoc & perl documentation Message-ID: <20180913153621.yj2nxsgkfxcq7c6i@pali> References: <20180913151226.oaon3nvlvgcqioau@pali> <18000.1536852768@cathet.us> X-Mailinglist: mandoc-discuss Reply-To: discuss@mandoc.bsd.lv MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="5u7dvhr5keus7ejg" Content-Disposition: inline In-Reply-To: <18000.1536852768@cathet.us> User-Agent: NeoMutt/20170113 (1.7.2) --5u7dvhr5keus7ejg Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Thursday 13 September 2018 09:32:48 Anthony J. Bentley wrote: > Hi Pali, >=20 > Pali Roh=C3=A1r writes: > > In perl world is documentation for perl modules or perl scripts writing > > in the POD format. Build process for perl scripts/modules then convert > > POD documentation into manpages and install it into standard system > > location. > > > > I looked at Debian manpages which uses mandoc for converting man pages > > to HTML and basically documentation for perl modules is not good. > > > > For example this is HTMLized manpage for Email::Address::XS perl module: > > https://manpages.debian.org/Email::Address::XS > > > > There is also converting tool which formats POD documentation directly > > into HTML output. And for Email::Address::XS module is looks like: > > https://metacpan.org/pod/Email::Address::XS > > > > So, I would like to ask, how can be HTML output generated from perl > > manpages improved (process: POD --> mandoc --> HTML), so documentation > > would be more close to the native HTML output (process: POD --> HTML)? >=20 > LibreSSL's documentation was originally in pod, and was converted to > mdoc by Ingo and myself. We used Kristaps's pod2mdoc(1) as a base, and > fixed up the resulting mdoc source to be more semantic. >=20 > https://mandoc.bsd.lv/pod2mdoc/ >=20 > If you want to keep the source formatting in pod, you could use pod2mdoc > during the build. The result is not incredibly good due to an inherent > lack of semantics in pod, but it is better than pod2man output. >=20 > I imagine a nicer result would come from keeping the source in mdoc > format and converting to pod during the build, but I'm not aware of > any such converter yet... That is not possible for general usage. Documentation for perl modules are written in POD and would be written also in the future... --=20 Pali Roh=C3=A1r pali.rohar@gmail.com --5u7dvhr5keus7ejg Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iF0EABECAB0WIQS4VrIQdKium2krgIWL8Mk9A+RDUgUCW5qD8wAKCRCL8Mk9A+RD UtVlAJ4/QjHBSMEt8BBhnntW6hzcTIcoFwCeKBHywUdSgdrfjdRB/pEQ6ZLeOMQ= =O5su -----END PGP SIGNATURE----- --5u7dvhr5keus7ejg-- -- To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv