Camille Moncelier | 2 Dec 2009 17:30

Re: opkg help and documentation

As I sait previously, I'm not a big fan of nroff syntax for creating man pages.

What do you think about makeing somthing like this:

http://www.google.com/codesearch/p?hl=en#N-lCuqhWHXY/trunk/tovid/Makefile.am&q=makefile.am%20txt2tags

It use txt2tags to make a man page from a wiki like syntax. The author added
a dist hook in the makefile to package the compiled man pages in order to
not depends on txt2tags when releasing.

IMHO, using a tool like txt2tags can make make page editing A LOT easier.

A sample txt2tags man page:
- http://www.google.com/codesearch/p?hl=en#S7R6oHNNbis/pub/distfiles/tovid-0.28.tar.gz|6tww3XDXzOU/tovid-0.28/docs/src/en/idvid.t2t

Compiled result:
- http://www.google.com/codesearch/p?hl=en#S7R6oHNNbis/pub/distfiles/tovid-0.28.tar.gz|6tww3XDXzOU/tovid-0.28/docs/man/idvid.1

On Wed, Dec 2, 2009 at 12:23 AM, Graham Gower <graham.gower@...> wrote:
> Excellent, thanks.
>
> I'm not knowledgeable with nroff nor autotools, so please bear with me
> while I familiarise myself with them so that this can be smoothly
> integrated.
>
> -Graham
>
> --
>
> You received this message because you are subscribed to the Google Groups "opkg-devel" group.
(Continue reading)

Graham Gower | 2 Dec 2009 21:49
Picon

Re: opkg help and documentation

2009/12/3 Camille Moncelier <moncelier@...>:
> As I sait previously, I'm not a big fan of nroff syntax for creating man pages.
>
> What do you think about makeing somthing like this:
>

The big problem is that it adds an extra build time dependency. nroff
is standard and everyone is using it. Maybe its not the best, but its
functional and all the tools already work.

-Graham

--

You received this message because you are subscribed to the Google Groups "opkg-devel" group.
To post to this group, send email to opkg-devel@...
To unsubscribe from this group, send email to opkg-devel+unsubscribe@...
For more options, visit this group at http://groups.google.com/group/opkg-devel?hl=en.


Gmane