Re: [Chicken-hackers] Using mandoc for chicken manual pages?

[Christian Kellermann]

* Timo Myyrä <address@hidden> [160719 11:49]:
> Peter Bex <address@hidden> writes:
>
> > On Tue, Jul 19, 2016 at 10:53:07AM +0300, Timo Myyrä wrote:
> >
> >> Hi,
> >>
> >> Chicken manuals are currently little sparse and use older man(7) format.
> >> Would it make sense to update the manual pages and switch to using mdoc(7)
> >> format in them? Mdoc(7) format is easier to work on and the manual pages 
> >> need
> >> attention in any case. Currently they just recommend to run the command 
> >> with
> >> `-h' flag to get the information.
> >>
> >> On chickens user side this wouldn't cause anything new, better manuals I 
> >> hope. I
> >> think most platforms can view mdoc(7) pages just fine.
> >
> > I think this would be great.  The main problem with manpages is
> > maintenance, because most of this is duplicated in the online help and
> > the "manual" dir.
>
> Hmm, mandoc can output HTML from mdoc. Could the HTML page be generated from
> mdoc file? That would keep those in sync? But that step could be worked on 
> later.

I think the key point here is that the manual is also editable in the
wiki, hence needs a manual merge on every release (which is not that
often, so that's doable).

Kind regards,

Christian

--
May you be peaceful, may you live in safety, may you be free from
suffering, and may you live with ease.