Manual page for pot

[0mp]

Hi Luca,

are you still working on the manual page for pot?

[pizzamig]

I uploaded a branch (manAndDoc) where you can find all the work I was doing about the man page.
I stopped, because I've realized that it was growing a lot.
Maybe, it would make sense to have multiple man pages, like pkg(8) or git(1)
As final though, it would be ideal to be able to generate the man page from the scripts. Do you know any small utility that can generate/extract man pages from random text?

[0mp]

@pizzamig Splitting manuals up might be a good idea.

Pandoc might have some tooling for generating manual pages from something. @trasz recently converted the FreeBSD Handbook to a manual page for fun with pandoc I think.

[trasz]

czw., 27 wrz 2018 o 21:20 Mateusz Piotrowski <notifications@github.com> napisał(a):

@pizzamig <https://github.com/pizzamig> Splitting manuals up might be a good idea. Pandoc might have some tooling for generating manual pages from *something*. @trasz <https://github.com/trasz> recently converted the FreeBSD Handbook to a manual page for fun with pandoc I think.

I've tried pandoc, but its mdoc generation capabilities leave much to be desired. I cobbled together my own thing instead: https://github.com/trasz/laserhammer

[pizzamig]

The current work in progress is available in the "manAndDoc" branch and is based on sphinx.
A README.txt file has been added in share/doc/pot, with build instructions and needed dependencies.

The first implementation aim to have:

• pot.7 with all the documentation rendered (already done)
• pot.8 as the typical command line man page (something is there, but basically everything is missing)

That's the current checklist

• Improve and finalize pot.7
• Write the pot.8 man page