Re: [Openvpn-devel] OpenVPN documentation (man page) review

2011-01-13 Thread Samuli Seppänen
> > It should be possible to write a little script which parses the wiki > (page content) source text and makes man/html pages and example files > based on this. This could be done before each release. > > The drawback is that the wiki markup might be too flexible (too many > features) and the

Re: [Openvpn-devel] OpenVPN documentation (man page) review

2011-01-13 Thread David Sommerseth
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 12/01/11 21:48, Jan Just Keijser wrote: > Hi David, > > David Sommerseth wrote: >> -BEGIN PGP SIGNED MESSAGE- >> Hash: SHA1 >> >> >> Hi folks! >> >> This is a little cry for help from us playing with the OpenVPN code. >> >> We have a quite

Re: [Openvpn-devel] OpenVPN documentation (man page) review

2011-01-12 Thread Karl O. Pinc
On 01/12/2011 02:48:29 PM, Jan Just Keijser wrote: > As for the document format: if we want users to contribute then we > should not opt for a too-difficult format that users would have to > learn > before being able to contribute. Docbook and/or texinfo are nice for > Linux users but you'd

Re: [Openvpn-devel] OpenVPN documentation (man page) review

2011-01-12 Thread Jan Just Keijser
Hi David, David Sommerseth wrote: -BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi folks! This is a little cry for help from us playing with the OpenVPN code. We have a quite good man page today with a lot of information. But maintaining it and to make sure it is up-to-date with all the

Re: [Openvpn-devel] OpenVPN documentation (man page) review

2011-01-12 Thread Karl O. Pinc
On 01/12/2011 02:40:00 AM, Matthias Andree wrote: > Am 11.01.2011 12:20, schrieb David Sommerseth: > > > > Hi folks! > > > > This is a little cry for help from us playing with the OpenVPN > code. > > > > We have a quite good man page today with a lot of information. But > > maintaining it and

Re: [Openvpn-devel] OpenVPN documentation (man page) review

2011-01-12 Thread Stefan Monnier
>> * Move the man page to a better format than the pure man page format. >> Are there some good tools/formats like ascii2man or DocBookXML which >> could help easing the maintenance of our documentation? > Docbook XML for sure is a lot more verbose than asciidoc or roff. > I would tend to avoid

Re: [Openvpn-devel] OpenVPN documentation (man page) review

2011-01-12 Thread Matthias Andree
Am 12.01.2011 11:18, schrieb David Sommerseth: > But if we could manage to produce, say chm files (or whatever is the > standard nowadays) for windows, that would be a big improvement as well. > Otherwise, a HTML file (like now, I believe) is better than nothing. I don't personally care much

Re: [Openvpn-devel] OpenVPN documentation (man page) review

2011-01-12 Thread David Sommerseth
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 On 12/01/11 09:40, Matthias Andree wrote: > Am 11.01.2011 12:20, schrieb David Sommerseth: >> >> Hi folks! >> >> This is a little cry for help from us playing with the OpenVPN code. >> >> We have a quite good man page today with a lot of information.

Re: [Openvpn-devel] OpenVPN documentation (man page) review

2011-01-12 Thread Matthias Andree
Am 11.01.2011 12:20, schrieb David Sommerseth: > > Hi folks! > > This is a little cry for help from us playing with the OpenVPN code. > > We have a quite good man page today with a lot of information. But > maintaining it and to make sure it is up-to-date with all the features > OpenVPN

[Openvpn-devel] OpenVPN documentation (man page) review

2011-01-11 Thread David Sommerseth
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Hi folks! This is a little cry for help from us playing with the OpenVPN code. We have a quite good man page today with a lot of information. But maintaining it and to make sure it is up-to-date with all the features OpenVPN supports is often not