cURL / Mailing Lists / curl-users / Single Mail


Re: big docs (was Re: Limits to curl command....)

From: Rodrigo Zanatta Silva <>
Date: Mon, 19 Jan 2015 09:25:28 -0200

Lol. I would suggest the strategy of sqlmap

If I call the program with *-h* it show the basic help page, but if I use
*-hh* it show a full help.

When I mean small doc, it is not give a short explanation about function.
It is just don't show option that is not very often used.

So, doing a example, I would suggest that

   - --url
   - --write-out
   - --verbose

Is a good candidate to be in small doc. But

   - --tlsauthtype
   - --socks5-hostname <host[:port]>
   - --proxy1.0 <proxyhost[:port]>

Is things (very complex) that I never used. You is the main programer, so
for you it is really difficult choose what is most important :D For a users
like me, it is not that difficult.

I would suggest this strategy:

   - Make some pool (questionnaire, research, what is the correct word?)
   for the users say what option they use more.
   - Create a anonymous function in the curl that send what the users are
   using (yes, if the user want to send it, like Google, Microsoft, etc does
   in their program)

2015-01-19 8:50 GMT-02:00 Alex Bligh <>:

> On 19 Jan 2015, at 10:41, Daniel Stenberg <> wrote:
> > Which are the most commonly used options would you say? And how many
> options would be suitable to have in a "smaller docs" ?
> >
> > I could very well imagine making a "quick guide" or similar, but I would
> not like to duplicate the same info so I'd prefer to make some clever magic
> that extracts pieces from the real man page to make the smaller one.
> Personally I like the format of the curl docs (well, the man page which is
> where I look for docs). I think splitting it into less and more frequently
> used options is either going to result in duplication or confusion (moving
> related options away from each other), and the options X considers common
> will no doubt be different from those Y considers common.
> If I was going to suggest an improvement, it would be to add an 'EXAMPLES'
> section. But really compared to other CLI tools of similar complexity
> (openssl anyone?), curl is a paragon of good documentation.
> --
> Alex Bligh

List admin:
Received on 2015-01-19