Re: Volunteers?

[Jon Dugan <jdugan --at-- x1024.net>]

>>  I could help on this topic ; I've also posted (long) time ago a note
>> about some options not or poorly commented in the man page... but I'll
>> need some help for such options I don't know well what they do.

Great!  Any help is much appreciated?

I'd be happy to help out with documentation for the undocumented 
commands.  Basically, I am looking to get the documentation/man page 
into a place where it's easy to make changes.

>>  About the format of the documentation source, I think there is now
>> much nice doc formats and tools to maintain a doc and generate it in
>> multiple formats (I think of docbook or other xml variants for
>> example) : could it be a solution ?

I would prefer to keep the main documentation in the man page in 'roff' 
format and then export it to HTML for publishing on the web.

Docbook and XML formats are just as messy as man/roff format IMHO and 
require extra software to generate output.  The roff suite is available 
on every Unix like platform including Cygwin.

For the broader documentation issues such as the wiki I'm happy to just 
use the SourceForge wiki syntax.  Again, this saves on having to install 
software and I believe it to be sufficient for our needs.

That said, I'm generally a pretty reasonable person, so if someone can 
present a compelling case for something different I'll listen.


Jon

Jeff W. Boote wrote:
> I could help on this topic as well. (I have already documented many of 
> the iperf options in the bwctl man page anyway...)
>
> I would personally not want to mess with other formats as the source 
> format - at least not for the command-line tool. Man 'roff' format is 
> sufficient, and is most easy to package together with the software. But 
> - if others want to do that, I would not object. (I just wouldn't want 
> to mess with the extra effort myself.)
>
> jeff
>
> On Mar 21, 2008, at 5:02 AM, Frédéric BOITEUX wrote:
>
> >     Hello,
> >
> > Le mar 18 mar 2008 21:55:13 CET, Jon Dugan <jdugan --at-- x1024.net> a écrit :
> >
> > ...
> > >   2. Converting the current HTML documentation into a man page.  The 
> > > man page
> > >      will be the canonical source and we can generate an HTML version
> > >      from there.

> >  I'll give more info when I'll begin work, not in following days...
> >
> >
> > --
> > Frédéric
>
> jeff
> --
> Jeff W. Boote
> boote --at-- internet2.edu