From: Helge Kreutzmann <debian@helgefjell.de>
To: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
Cc: Karel Zak <kzak@redhat.com>, util-linux@vger.kernel.org
Subject: Re: Consistency fixes in util-linux man pages
Date: Mon, 18 May 2020 17:03:13 +0200 [thread overview]
Message-ID: <20200518150312.GA22063@Debian-50-lenny-64-minimal> (raw)
In-Reply-To: <CAKgNAkihsF1tGurfHbnFPYZ4qJV9-2f=Sbj5qdLxmuuuAJ+GGA@mail.gmail.com>
[-- Attachment #1: Type: text/plain, Size: 1711 bytes --]
Hello Michael and Karel,
On Mon, May 18, 2020 at 12:36:01PM +0200, Michael Kerrisk (man-pages) wrote:
> On Mon, 18 May 2020 at 10:28, Karel Zak <kzak@redhat.com> wrote:
> > BTW, I'm not sure about man pages as ideal format to maintain
> > documentation (because it's mostly about formatting than about
> > content). I think about AsciiDoc or so in future. What do you think
> > about this idea?
>
> I'm not too knowledgeable in AsciiDc, but my impression is that it's
> too limited in terms of its formatting opinions.
>
> If I did move man-pages, the most likely candidate would probably be
> Sphinx, as is nowadays used in the kernel docs. But, that would
> require converting a thousand pages or so, and I have not so far had
> the stomach for that. Of course, you have a rather smaller set of
> pages to deal with, so a conversion step sould be more easily
> entertained.
Even though man pages are limitted in formatting, they are universally
available and, from our POV, getting more attention from the
translators side. We just welcomed our seventh language. Probably not
relevant for kenel side docs, but for programs by non programmers (and
presumably non native speakers) man pages are good option.
(Of course, translation tools for other formats exists and e.g. po4a
supports many formats, it also need a dedicated community of
translators).
Greetings
Helge
--
Dr. Helge Kreutzmann debian@helgefjell.de
Dipl.-Phys. http://www.helgefjell.de/debian.php
64bit GNU powered gpg signed mail preferred
Help keep free software "libre": http://www.ffii.de/
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
next prev parent reply other threads:[~2020-05-18 15:03 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-16 8:24 Consistency fixes in util-linux man pages Michael Kerrisk (man-pages)
2020-05-18 8:28 ` Karel Zak
2020-05-18 10:36 ` Michael Kerrisk (man-pages)
2020-05-18 15:03 ` Helge Kreutzmann [this message]
2020-05-19 10:38 ` Karel Zak
2020-05-19 17:23 ` Helge Kreutzmann
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200518150312.GA22063@Debian-50-lenny-64-minimal \
--to=debian@helgefjell.de \
--cc=kzak@redhat.com \
--cc=mtk.manpages@gmail.com \
--cc=util-linux@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).