aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/curl_easy_setopt.3
AgeCommit message (Collapse)Author
2013-10-23CURLOPT_RESOLVE: mention they don't time-outDaniel Stenberg
Clarify in the documentation that DNS entries added with CURLOPT_RESOLVE won't time-out. Bug: http://curl.haxx.se/mail/lib-2013-10/0062.html Reported-by: Romulo Ceccon
2013-10-16DOCS: Added libcurl version number to CURLOPT_SSLVERSIONSteve Holme
2013-10-15SSL: protocol version can be specified more preciselyGergely Nagy
CURL_SSLVERSION_TLSv1_0, CURL_SSLVERSION_TLSv1_1, CURL_SSLVERSION_TLSv1_2 enum values are added to force exact TLS version (CURL_SSLVERSION_TLSv1 means TLS 1.x). axTLS: axTLS only supports TLS 1.0 and 1.1 but it cannot be set that only one of these should be used, so we don't allow the new enum values. darwinssl: Added support for the new enum values. SChannel: Added support for the new enum values. CyaSSL: Added support for the new enum values. Bug: The original CURL_SSLVERSION_TLSv1 value enables only TLS 1.0 (it did the same before this commit), because CyaSSL cannot be configured to use TLS 1.0-1.2. GSKit: GSKit doesn't seem to support TLS 1.1 and TLS 1.2, so we do not allow those values. Bugfix: There was a typo that caused wrong SSL versions to be passed to GSKit. NSS: TLS minor version cannot be set, so we don't allow the new enum values. QsoSSL: TLS minor version cannot be set, so we don't allow the new enum values. OpenSSL: Added support for the new enum values. Bugfix: The original CURL_SSLVERSION_TLSv1 value enabled only TLS 1.0, now it enables 1.0-1.2. Command-line tool: Added command line options for the new values.
2013-09-30curl_easy_setopt.3: slight clarification of SEEKFUNCTIONDaniel Stenberg
2013-09-20curl_easy_setopt.3: clarify that TIMEOUT and TIMEOUT_MS set the same valueDaniel Stenberg
2013-09-20pop3: Added basic SASL XOAUTH2 supportSteve Holme
Added the ability to use an XOAUTH2 bearer token [RFC6750] with POP3 for authentication using RFC6749 "OAuth 2.0 Authorization Framework". The bearer token is expected to be valid for the user specified in conn->user. If CURLOPT_XOAUTH2_BEARER is defined and the connection has an advertised auth mechanism of "XOAUTH2", the user and access token are formatted as a base64 encoded string and sent to the server as "AUTH XOAUTH2 <bearer token>".
2013-09-13curl_easy_setopt.3: mention RTMP URL quirksDaniel Stenberg
URL: http://curl.haxx.se/bug/view.cgi?id=1278 Reported-by: Gorilla Maguila
2013-09-12libcurl: New options to bind DNS to local interfaces or IP addressesKim Vandry
2013-09-05darwinssl: add support for PKCS#12 files for client authenticationNick Zitzmann
I also documented the fact that the OpenSSL engine also supports them.
2013-08-30docs: Added documentation for CURLOPT_BEARERKyle L. Huff
2013-08-02Revert "DOCS: Added IMAP URL example for listing new messages"Steve Holme
This reverts commit 82ab5f1b0c7c3f as this was the wrong place to document the complexity of IMAP URLs and Custom Requests.
2013-08-02DOCS: Added IMAP URL example for listing new messagesSteve Holme
In addition to listing the folder contents, in the URL examples, added an example to list the new messages waiting in the user's inbox.
2013-07-18CURLOPT_XFERINFOFUNCTION: introducing a new progress callbackDaniel Stenberg
CURLOPT_XFERINFOFUNCTION is now the preferred progress callback function and CURLOPT_PROGRESSFUNCTION is considered deprecated. This new callback uses pure 'curl_off_t' arguments to pass on full resolution sizes. It otherwise retains the same characteristics: the same call rate, the same meanings for the arguments and the return code is used the same way. The progressfunc.c example is updated to show how to use the new callback for newer libcurls while supporting the older one if built with an older libcurl or even built with a newer libcurl while running with an older.
2013-06-14curl_easy_setopt.3: clarify CURLOPT_PROGRESSFUNCTION frequencyDaniel Stenberg
Make it clearer that the CURLOPT_PROGRESSFUNCTION callback will be called more frequently than once per second when things are happening.
2013-06-08curl_easy_setopt.3: HTTP header with no contentPeter Gal
Update the documentation on how to specify a HTTP header with no content.
2013-05-20curl_easy_setopt.3: expand the PROGRESSFUNCTION sectionDaniel Stenberg
Explain the callback and its arguments better and with more descriptive text.
2013-04-28DOCS: Corrected line length of recent Secure Transport changesSteve Holme
2013-04-27darwinssl: add TLS crypto authenticationNick Zitzmann
Users using the Secure Transport (darwinssl) back-end can now use a certificate and private key to authenticate with a site using TLS. Because Apple's security system is based around the keychain and does not have any non-public function to create a SecIdentityRef data structure from data loaded outside of the Keychain, the certificate and private key have to be loaded into the Keychain first (using the certtool command line tool or the Security framework's C API) before we can find it and use it.
2013-04-27Corrected version numbers after bumpSteve Holme
2013-04-27DOCS: Updated following the addition of CURLOPT_SASL_IRSteve Holme
Documented the the option in curl_easy_setopt() and added it to symbols-in-versions.
2013-04-25DOCS: Minor rewording / clarification of host name protocol detectionSteve Holme
2013-04-24DOCS: Added reference to IETF draft for SMTP URL InterfaceSteve Holme
...when mentioning login options. Additional minor clarification of "Windows builds" to be "Windows builds with SSPI"as a way of enabling NTLM as Windows builds may be built with OpenSSL to enable NTLM or without NTLM support altogether.
2013-04-23DOCS: Reworked the scheme calculation explanation under CURLOPT_URLSteve Holme
2013-04-22DOCS: Added information about login options to CURLOPT_USERPWDSteve Holme
2013-04-22DOCS: Added information about login options in the URLSteve Holme
2013-04-03curl_easy_setopt.3: CURLOPT_HTTPGET disables CURLOPT_UPLOADDaniel Stenberg
2013-03-07DOCS: Corrected the IMAP URL grammar of the UIDVALIDITY parameterSteve Holme
2013-03-07DOCS: Added the list command to the IMAP URL sectionSteve Holme
Added examples of the list command and clarified existing example URLs following recent changes.
2013-02-26DOCS: Added the IMAP UIDVALIDITY property to the CURLOPT_URL sectionSteve Holme
2013-02-25DOCS: Corrected IMAP URL examples according to RFC5092Steve Holme
URL examples that included the UID weren't technically correct although would pass the curl parser.
2013-02-24DOCS: Corrected layout of POP3 and IMAP URL examplesSteve Holme
Corrected layout issues with the POP3 and IMAP URL examples introduced in commit cb3ae6894fb2.
2013-02-23DOCS: Updated CURLOPT_URL section following recent POP3 and IMAP changesSteve Holme
Updated the POP3 sub-section to refer to message ID rather than mailbox. Added an IMAP sub-section with example URLs depicting the specification of mailbox, uid and section.
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