[ODE] Man pages for ODE ?
Bram Stolk
bram at sara.nl
Sat Nov 26 06:02:02 MST 2005
Peter Onion wrote:
> Is there a set of unix style man pages available for ODE ?
>
> I'm a linux user so I'm used to being able to find a libraries
> documentation in the man pages. For example all the other libs I'm
> using (gtk+/gtkglext/glade/openGL/alsa/popt libraries are documented
> like this which makes ODE the odd one out.
>
> It would be **really useful** to be able to type
> "man dWorldAutoEnableFlag" rather than having to either look at the
> printed version of the manual or to search the web or pdf versions.
>
> If anyone else thinks this would be useful, maybe we can work together
> to tackle it ?
sounds good.
I'm all for it!
I see two possible ways to go about this:
1) maintain man pages seperatly from src (straightforward)
2) literate progamming
http://en.wikipedia.org/wiki/Literate_programming
(generate man from src itself)
The latter option would ensure that API and MAN do not
diverge easily.
Bram
>
> Peter.
>
> _______________________________________________
> ODE mailing list
> ODE at q12.org
> http://q12.org/mailman/listinfo/ode
More information about the ODE
mailing list