[gentoo-user] Re: writing man pages (gentoo conventions)

[Grant Edwards <grant.b.edwards@gmail.com>]

On 2015-06-03, Peter Humphrey <peter@prh.myzen.co.uk> wrote:
> On Wednesday 03 June 2015 14:24:18 Grant Edwards wrote:
>> On 2015-06-03, Martin Vaeth <martin@mvath.de> wrote:
>> > James <wireless@tampabay.rr.com> wrote:
>> >> So instead of my spew of ascii information files, I'm now composing
>> >> 'man pages' mostly using txt2man.
>> > 
>> > If you want to avoid learning *roff, there is also e.g. pod from perl
>> > which gives you simple basic markup functionality and can output in
>> > man page format (and other format).
>> 
>> asciidoc, markdown, and reStructuredText can all generate man page
>> format as well as HTML, PDF, and others.  The main benefit of these is
>> that they're also easy to read in their "raw" input format (unlike
>> roff).
>
> Isn't there a Gentoo Way too? I can't put my finger on it just now
> but I think I've seen a reference to producing Gentoo docs, including
> man pages.

The only thing I know of is GuideXML which is used to generate the
user guide:

  https://wwwold.gentoo.org/doc/en/xml-guide.xml

I'm not aware of it generating anything other than docbook or HTML,
but maybe you could use something like this to then convert from
docbook to man:

https://www.oasis-open.org/docbook/tools/dtm/
  
-- 
Grant Edwards               grant.b.edwards        Yow! I hope something GOOD
                                  at               came in the mail today so
                              gmail.com            I have a REASON to live!!