cURL / Mailing Lists / curl-users / Single Mail

curl-users

Re: [devel] curl.1 manual restructuring (exampes, POD)

From: Jari Aalto <jari.aalto_at_cante.net>
Date: Sun, 04 Mar 2007 19:45:07 +0200

Daniel Stenberg <daniel_at_haxx.se> writes:
> Is that initial table of contents meant to contain links? Is it
> possible to inhibit that table from the output?

It is possible to inhibit the table of contents. pod2html adds
it by deault, but option --noindex suppresses it.

> Anyway, in comparison I find the roffit HTML output preferable. Mostly
> due to the cross-reference links it adds.

> Compare the --anyauth description for example:
>
> http://curl.haxx.se/docs/manpage.html#--anyauth
> http://cante.net/~jaalto/tmp/curl/curl.1.html#item__2d_2danyauth
>
> Admittedly only a minor difference, but something I myself enjoy quite a bit.

The pod2html constructs the references on the fly form the docuyment,
so it needs to make them unique, hence the added cruft "__2d_2d".

I've submitted a patch to the Perl5 porters about this to make them
look almost like you suggested. I can provide my local version of
pod2html if you want.

> Oh, then I think you need to incorporate TheArtOfHttpScripting into it
> as well and then we're talking about quite a large man page! ;-)

I believe this cover's 90% of the needs.

   http://curl.haxx.se/docs/manual.html

I've already converted it into POD to be attached to curl.1 shortly.

> As mentioned already, for me the question is all POD or no POD. And
> since there's no volunteers stepping up to covert the other 52(!) man
> pages, I'm leaning towards no POD.

You could think this as a start. And slowly migrate the other manual pages
as you see fit. Having the main manual page (for the end-users) in easily
editable format (In my view naturally), will certainly benefit in the long.

My motivation is to make the curl.1 page even better. I've now
finished the conversion and I think you find the output of pod2man
comparable to roffit. Would you take a look now:

  http://cante.net/~jaalto/tmp/curl/curl.1.html

It also contains those "internal croff referencces" now. That is not supported
by pod2html, but I wrote Perl script to add those.

Would you now accept the POD version?

Jari
Received on 2007-03-04