Re: [Monotone-devel] monotone man page

[Aaron W. Hsu]

On Sunday 20 June 2010 18:47:19 Thomas Keller wrote:
> Hey there!
> 
> I've just pushed some initial work to nvm.man-page to let monotone
> auto-generate its own man page. If you compile this, a new hidden
> "manpage" command will be available, which dumps the command tree and a
> few additional information in (g)roff format, so you can then basically
> 
>       mtn manpage | groff -man -Tascii - | less
> 
> to view the generated page. This is work-in-progress, as I'm fighting
> with some of groff's macros still (f.e. the indentation is not always
> correct). Also I need to tweak the output of our description methods a
> bit, because a couple of unwanted newlines are inserted as well, and I
> need a fancy / catchy DESCRIPTION for the program itself (proposals
> welcome!) - but basically it works.
> 
> I haven't yet touched the build process part for that, so no, the man
> page will not be automatically generated / installed when you hit make
> install now...

I love this! I'm quite excited to get a man page with mtn. Is there a chance 
that we could move to using mandoc instead of just the normal man pages? This 
will have positive benefits on the BSD systems, such as OpenBSD, which favors 
the mandoc system. 

Is there a reason that the documentation needs to be generated from the 
existing help documentation? Sometimes I find that it is nice to put much more 
information into a proper man page than what you get from the help command in 
monotone.

        Aaron W. Hsu

signature.asc
Description: This is a digitally signed message part.