aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/curl_easy_setopt.3
AgeCommit message (Collapse)Author
2013-02-22libcurl documentation: clarifications and typosAlexander Klauer
* Elaborates on default values of some curl_easy_setopt() options. * Reminds the user to cast variadic arguments to curl_easy_setopt() to 'void *' where curl internally interprets them as such. * Clarifies the working of the CURLOPT_SEEKFUNCTION option for curl_easy_setopt(). * Fixes typo 'forth' → 'fourth'. * Elaborates on CURL_SOCKET_TIMEOUT. * Adds some missing periods. * Notes that the return value of curl_version() must not be passed to free().
2013-02-17docs: refer to CURLOPT_ACCEPT_ENCODING instead of the old nameDaniel Stenberg
2013-01-28docs: update the comments about loading CA certs with NSSKamil Dudka
Bug: https://bugzilla.redhat.com/696783
2012-11-23DOCS: Updated CURLOPT_CONNECT_ONLY to reflect usage in other protocolsSteve Holme
2012-11-06CURLOPT_SSL_VERIFYHOST: stop supporting the 1 valueDaniel Stenberg
After a research team wrote a document[1] that found several live source codes out there in the wild that misused the CURLOPT_SSL_VERIFYHOST option thinking it was a boolean, this change now bans 1 as a value and will make libcurl return error for it. 1 was never a sensible value to use in production but was introduced back in the days to help debugging. It was always documented clearly this way. 1 was never supported by all SSL backends in libcurl, so this cleanup makes the treatment of it unified. The report's list of mistakes for this option were all PHP code and while there's a binding layer between libcurl and PHP, the PHP team has decided that they have an as thin layer as possible on top of libcurl so they will not alter or specifically filter a 'TRUE' value for this particular option. I sympathize with that position. [1] = http://daniel.haxx.se/blog/2012/10/25/libcurl-claimed-to-be-dangerous/
2012-08-16curl_easy_setopt: documented CURLSOCKTYPE_ACCEPT for SOCKOPTFUNCTIONDaniel Stenberg
2012-08-09docs: update the links to cipher-suites supported by NSSKamil Dudka
... and make the list of cipher-suites in nss.c readable by humans. Bug: http://curl.haxx.se/mail/archive-2012-08/0016.html
2012-08-08docs: mention CURLSSH_AUTH_AGENTArmel Asselin
2012-07-24curl_easy_setopt: fix typoDaniel Stenberg
Reported by: Santhana Todatry
2012-07-20Fixed some typos in documentationDan Fandrich
2012-06-24DOCS: Added clarification to CURLOPT_CUSTOMREQUEST for the POP3 protocolSteve Holme
Bug: http://curl.haxx.se/mail/lib-2012-06/0302.html Reported by: Nagai H
2012-06-04curl_easy_setopt.3: proto updates + cleanupsDaniel Stenberg
- For all *FUNCTION options, they now all show the complete prototype in the description. Previously some of them would just refer to a typedef'ed function pointer in the curl.h header. - I made the phrasing of that "Pass a pointer to a function that matches the following prototype" the same for all *FUNCTION option descriptions. - I removed some uses of 'should'. I think I sometimes over-use this word as in many places I actually mean MUST or otherwise more specific and not-so-optional synonyms.
2012-05-27DOCS: Corrected the "Added in" version number for CURLOPT_MAIL_AUTHSteve Holme
Additionally corrected another RFC link that I missed yesterday.
2012-05-26DOCS: Fixed line spacing of authentication examples in CURLOPT_URLSteve Holme
2012-05-26DOCS: Changed domain names in various examples to example.comSteve Holme
Updated various references of real domain names to example.com as per RFC-2606.
2012-05-26DOCS: Fixed meaning of bit 2 in CURLOPT_POSTREDIRSteve Holme
Setting bit 2 for this value was documented as having a constant value defined as CURL_REDIR_POST_303 yet referenced a 302 request. Additionally corrected the meaning of CURL_REDIR_POST_ALL for all three bits and fixed problems with the bolding of keywords in this section.
2012-05-26DOCS: Standardised how RFCs are referenced.Steve Holme
Standardised how RFCs are referenced so that the website may autolink to the correct documentation on ietf.org. Additionally removed the one link to RFC3986 on curl.haxx.se.
2012-05-24DOCS: Added LDAP to the CURLOPT_URL sectionSteve Holme
2012-05-22DOCS: Updated version number for features added in the pending releaseSteve Holme
2012-05-12NTLM: is supported in GnuTLS builds tooDaniel Stenberg
... since commit 9a4c887c4a7 introduced in libcurl 7.19.4
2012-05-07CURLOPT_HEADERFUNCTION: works for non-HTTP protocols tooDaniel Stenberg
2012-05-03Add note about default timeout in CURLOPT_TIMEOUTClaes Jakobsson
2012-04-05CURLOPT_POSTREDIR: also allow 303 to do POST on the redirected URLAndrei Cipu
As it turns out, some people do want that after all.
2012-04-01SSH: public key can now be an empty stringArmel Asselin
If an empty string is passed to CURLOPT_SSH_PUBLIC_KEYFILE, libcurl will pass no public key to libssh2 which then tries to compute it from the private key. This is known to work when libssh2 1.4.0+ is linked against OpenSSL.
2012-03-31DOCS: Added information regarding POP3 commands to CURLOPT_CUSTOMREQUESTSteve Holme
2012-03-10CURLSSH_OPT_AUTH: documented it has no effectArmel Asselin
2012-02-25libcurl docs: version correctionsDaniel Stenberg
Correct some inconsistencies in which version some things were added. Bug: http://curl.haxx.se/bug/view.cgi?id=3494091 Reported by: "curlybugs"
2012-02-16docs: mention that NTLM works with NSS, tooKamil Dudka
2012-02-15DOCS: Added information for CURLOPT_MAIL_AUTH.Steve Holme
Added information relating to the new CURLOPT_MAIL_AUTH parameter and reworked CURLOPT_MAIL_FROM and CURLOPT_MAIL_RCPT to be a clearer. Fixed inconsistencies of "vocalisation of the abbreviation" versus "vocalisation of the first word" for all abbreviations. Corrected a typo in CURLOPT_NOPROXY.
2012-02-13s/7.24.1/7.25.0Daniel Stenberg
We will go straight to 7.25.0 due to the new additions
2012-02-09CURLOPT_SSL_OPTIONS: addedDaniel Stenberg
Allow an appliction to set libcurl specific SSL options. The first and only options supported right now is CURLSSLOPT_ALLOW_BEAST. It will make libcurl to disable any work-arounds the underlying SSL library may have to address a known security flaw in the SSL3 and TLS1.0 protocol versions. This is a reaction to us unconditionally removing that behavior after this security advisory: http://curl.haxx.se/docs/adv_20120124B.html ... it did however cause a lot of programs to fail because of old servers not liking this work-around. Now programs can opt to decrease the security in order to interoperate with old servers better.
2012-02-09add library support for tuning TCP_KEEPALIVEDave Reisner
This adds three new options to control the behavior of TCP keepalives: - CURLOPT_TCP_KEEPALIVE: enable/disable probes - CURLOPT_TCP_KEEPIDLE: idle time before sending first probe - CURLOPT_TCP_KEEPINTVL: delay between successive probes While not all operating systems support the TCP_KEEPIDLE and TCP_KEEPINTVL knobs, the library will still allow these options to be set by clients, silently ignoring the values.
2012-01-24curl_easy_setopt.3: Fixed SEEKDATA & CLOSESOCKETDATA descriptionsDan Fandrich
2012-01-22CURLOPT_ACCEPTTIMEOUT_MS: spellfixDaniel Stenberg
2012-01-03curl_easy_setopt: refer to the most recent URI RFCDaniel Stenberg
2011-12-20libcurl docs: add the new FTP accept option + errorsDaniel Stenberg
2011-12-19DOCS: Added SMTP information to CURLOPT_INFILESIZESteve Holme
2011-12-15docs: fix typo in curl_easy_setopt manpageAlessandro Ghedini
2011-12-12CURLOPT_INTERFACE: avoid resolving interfaces namesJason Glasgow
Do not try to resolve interfaces names via DNS by recognizing interface names in a few ways. If the interface option argument has a prefix of "if!" then treat the argument as only an interface. Similarly, if the interface argument is the name of an interface (even if it does not have an IP address assigned), treat it as an interface name. Finally, if the interface argument is prefixed by "host!" treat it as a hostname that must be resolved by /etc/hosts or DNS. These changes allow a client using the multi interfaces to avoid blocking on name resolution if the interface loses its IP address or disappears.
2011-12-05CURLOPT_CONNECTTIMEOUT: default is 300 secondsDaniel Stenberg
If the option is set to 0, the default timeout will be used - which in modern libcurl versions equals 300 seconds (== 5 minutes). Bug: http://curl.haxx.se/mail/lib-2011-12/0051.html Reported by: Vladimir Grishchenko
2011-12-05FTP: call opensocket callback properlyDaniel Stenberg
When the new socket is created for an active connection, it is now done using the open socket callback. Test case 596 was modified to run fine, although it hides the fact that the close callback is still called too many times, as it also gets called for closing sockets that were created with accept().
2011-11-18CURLOPT_QUOTE: SFTP supports the '*'-prefix nowDaniel Stenberg
2011-11-17CURLOPT_DNS_SERVERS: set name servers if possibleJason Glasgow
2011-10-24curl_easy_setopt.3: headers can be CURL_MAX_HTTP_HEADER bytesDaniel Stenberg
Mention this maximum header size for the header callback cases
2011-10-24curl_easy_setopt.3: fix typoDaniel Stenberg
shoot, Dan Fandrich already had this pointed out...
2011-10-24curl_easy_setopt: Added pop3 to CURLOPT_URL.Steve Holme
Added pop3 username and password example as well as an explanation of how path part of the URL is used under pop3. Additionally have corrected a couple of typos.
2011-09-28curl_easy_setopt: Added scp and sftp to the URL sectionDan Fandrich
2011-09-28curl_easy_setopt: A brief tidy upSteve Holme
Slight rewording of the CURLOPT_URL SMTP sub-section. Corrected the incorrect use of hyphens on the three uses of "zero-terminated" with "zero terminated" to match the rest of the document. Corrected the use of an out of place hyphen in CURLOPT_NOPROXY section.
2011-09-26remove short-lived CURL_WRITEFUNC_OUT_OF_MEMORYYang Tse
2011-09-25allow write callbacks to indicate OOM to libcurlYang Tse
Allow (*curl_write_callback) write callbacks to return CURL_WRITEFUNC_OUT_OF_MEMORY to properly indicate libcurl of OOM conditions inside the callback itself.