generic-library/curl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Use .IP instead of .TP and .B for each item.

Browse Source
This commit is contained in:
Daniel Stenberg 2003-11-04 12:55:53 +00:00
parent c020ee2eb6
commit ecfb53f06d
1 changed files with 115 additions and 241 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

356
docs/libcurl/curl_easy_setopt.3
View File

@ -8,7 +8,6 @@ curl_easy_setopt - set options for a curl easy handle
#include <curl/curl.h> #include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLoption option, parameter); CURLcode curl_easy_setopt(CURL *handle, CURLoption option, parameter);
.ad
.SH DESCRIPTION .SH DESCRIPTION
curl_easy_setopt() is used to tell libcurl how to behave. By using the curl_easy_setopt() is used to tell libcurl how to behave. By using the
appropriate options to \fIcurl_easy_setopt\fP, you can change libcurl's appropriate options to \fIcurl_easy_setopt\fP, you can change libcurl's
@ -34,8 +33,7 @@ transfers.
The \fIhandle\fP is the return code from a \fIcurl_easy_init(3)\fP or The \fIhandle\fP is the return code from a \fIcurl_easy_init(3)\fP or
\fIcurl_easy_duphandle(3)\fP call. \fIcurl_easy_duphandle(3)\fP call.
.SH BEHAVIOR OPTIONS .SH BEHAVIOR OPTIONS
.TP 0.4i .IP CURLOPT_VERBOSE
.B CURLOPT_VERBOSE
Set the parameter to non-zero to get the library to display a lot of verbose Set the parameter to non-zero to get the library to display a lot of verbose
information about its operations. Very useful for libcurl and/or protocol information about its operations. Very useful for libcurl and/or protocol
debugging and understanding. debugging and understanding.
@ -43,20 +41,17 @@ debugging and understanding.
You hardly ever want this set in production use, you will almost always want You hardly ever want this set in production use, you will almost always want
this when you debug/report problems. Another neat option for debugging is the this when you debug/report problems. Another neat option for debugging is the
\fICURLOPT_DEBUGFUNCTION\fP. \fICURLOPT_DEBUGFUNCTION\fP.
.TP .IP CURLOPT_HEADER
.B CURLOPT_HEADER
A non-zero parameter tells the library to include the header in the body A non-zero parameter tells the library to include the header in the body
output. This is only relevant for protocols that actually have headers output. This is only relevant for protocols that actually have headers
preceding the data (like HTTP). preceding the data (like HTTP).
.TP .IP CURLOPT_NOPROGRESS
.B CURLOPT_NOPROGRESS
A non-zero parameter tells the library to shut off the built-in progress meter A non-zero parameter tells the library to shut off the built-in progress meter
completely. completely.
\fBNOTE:\fP future versions of libcurl is likely to not have any built-in \fBNOTE:\fP future versions of libcurl is likely to not have any built-in
progress meter at all. progress meter at all.
.TP .IP CURLOPT_NOSIGNAL
.B CURLOPT_NOSIGNAL
Pass a long. If it is non-zero, libcurl will not use any functions that Pass a long. If it is non-zero, libcurl will not use any functions that
install signal handlers or any functions that cause signals to be sent to the install signal handlers or any functions that cause signals to be sent to the
process. This option is mainly here to allow multi-threaded unix applications process. This option is mainly here to allow multi-threaded unix applications
@ -64,8 +59,7 @@ to still set/use all timeout options etc, without risking getting signals.
(Added in 7.10) (Added in 7.10)
.PP .PP
.SH CALLBACK OPTIONS .SH CALLBACK OPTIONS
.TP 0.4i .IP CURLOPT_WRITEFUNCTION
.B CURLOPT_WRITEFUNCTION
Function pointer that should match the following prototype: \fBsize_t Function pointer that should match the following prototype: \fBsize_t
function( void *ptr, size_t size, size_t nmemb, void *stream);\fP This function( void *ptr, size_t size, size_t nmemb, void *stream);\fP This
function gets called by libcurl as soon as there is data reveiced that needs function gets called by libcurl as soon as there is data reveiced that needs
@ -81,8 +75,7 @@ Set the \fIstream\fP argument with the \fBCURLOPT_WRITEDATA\fP option.
you cannot possibly make any assumptions. It may be one byte, it may be you cannot possibly make any assumptions. It may be one byte, it may be
thousands. The maximum amount of data that can be passed to the write callback thousands. The maximum amount of data that can be passed to the write callback
is defined in the curl.h header file: CURL_MAX_WRITE_SIZE. is defined in the curl.h header file: CURL_MAX_WRITE_SIZE.
.TP .IP CURLOPT_WRITEDATA
.B CURLOPT_WRITEDATA
Data pointer to pass to the file write function. Note that if you specify the Data pointer to pass to the file write function. Note that if you specify the
\fICURLOPT_WRITEFUNCTION\fP, this is the pointer you'll get as input. If you \fICURLOPT_WRITEFUNCTION\fP, this is the pointer you'll get as input. If you
don't use a callback, you must pass a 'FILE *' as libcurl will pass this to don't use a callback, you must pass a 'FILE *' as libcurl will pass this to
@ -94,8 +87,7 @@ crashes.
This option is also known with the older name \fBCURLOPT_FILE\fP, the name This option is also known with the older name \fBCURLOPT_FILE\fP, the name
CURLOPT_WRITEDATA was introduced in 7.9.7. CURLOPT_WRITEDATA was introduced in 7.9.7.
.TP .IP CURLOPT_READFUNCTION
.B CURLOPT_READFUNCTION
Function pointer that should match the following prototype: \fBsize_t Function pointer that should match the following prototype: \fBsize_t
function( void *ptr, size_t size, size_t nmemb, void *stream);\fP This function( void *ptr, size_t size, size_t nmemb, void *stream);\fP This
function gets called by libcurl as soon as it needs to read data in order to function gets called by libcurl as soon as it needs to read data in order to
@ -104,8 +96,7 @@ filled with at most \fIsize\fP multiplied with \fInmemb\fP number of
bytes. Your function must return the actual number of bytes that you stored in bytes. Your function must return the actual number of bytes that you stored in
that memory area. Returning 0 will signal end-of-file to the library and cause that memory area. Returning 0 will signal end-of-file to the library and cause
it to stop the current transfer. it to stop the current transfer.
.TP .IP CURLOPT_READDATA
.B CURLOPT_READDATA
Data pointer to pass to the file read function. Note that if you specify the Data pointer to pass to the file read function. Note that if you specify the
\fICURLOPT_READFUNCTION\fP, this is the pointer you'll get as input. If you \fICURLOPT_READFUNCTION\fP, this is the pointer you'll get as input. If you
don't specify a read callback, this must be a valid FILE *. don't specify a read callback, this must be a valid FILE *.
@ -115,8 +106,7 @@ don't specify a read callback, this must be a valid FILE *.
This option is also known with the older name \fBCURLOPT_INFILE\fP, the name This option is also known with the older name \fBCURLOPT_INFILE\fP, the name
CURLOPT_READDATA was introduced in 7.9.7. CURLOPT_READDATA was introduced in 7.9.7.
.TP .IP CURLOPT_PROGRESSFUNCTION
.B CURLOPT_PROGRESSFUNCTION
Function pointer that should match the \fIcurl_progress_callback\fP prototype Function pointer that should match the \fIcurl_progress_callback\fP prototype
found in \fI<curl/curl.h>\fP. This function gets called by libcurl instead of found in \fI<curl/curl.h>\fP. This function gets called by libcurl instead of
its internal equivalent with a frequent interval during data transfer. its internal equivalent with a frequent interval during data transfer.
@ -127,12 +117,10 @@ callback will cause libcurl to abort the transfer and return
Also note that \fICURLOPT_NOPROGRESS\fP must be set to FALSE to make this Also note that \fICURLOPT_NOPROGRESS\fP must be set to FALSE to make this
function actually get called. function actually get called.
.TP .IP CURLOPT_PROGRESSDATA
.B CURLOPT_PROGRESSDATA
Pass a pointer that will be untouched by libcurl and passed as the first Pass a pointer that will be untouched by libcurl and passed as the first
argument in the progress callback set with \fICURLOPT_PROGRESSFUNCTION\fP. argument in the progress callback set with \fICURLOPT_PROGRESSFUNCTION\fP.
.TP .IP CURLOPT_HEADERFUNCTION
.B CURLOPT_HEADERFUNCTION
Function pointer that should match the following prototype: \fIsize_t Function pointer that should match the following prototype: \fIsize_t
function( void *ptr, size_t size, size_t nmemb, void *stream);\fP. This function( void *ptr, size_t size, size_t nmemb, void *stream);\fP. This
function gets called by libcurl as soon as there is received header data that function gets called by libcurl as soon as there is received header data that
@ -144,14 +132,12 @@ you passed to libcurl with the \fICURLOPT_WRITEHEADER\fP option. Return the
number of bytes actually written or return -1 to signal error to the library number of bytes actually written or return -1 to signal error to the library
(it will cause it to abort the transfer with a \fICURLE_WRITE_ERROR\fP return (it will cause it to abort the transfer with a \fICURLE_WRITE_ERROR\fP return
code). code).
.TP .IP CURLOPT_WRITEHEADER
.B CURLOPT_WRITEHEADER
Pass a pointer to be used to write the header part of the received data to. If Pass a pointer to be used to write the header part of the received data to. If
you don't use your own callback to take care of the writing, this must be a you don't use your own callback to take care of the writing, this must be a
valid FILE *. See also the \fICURLOPT_HEADERFUNCTION\fP option above on how to valid FILE *. See also the \fICURLOPT_HEADERFUNCTION\fP option above on how to
set a custom get-all-headers callback. set a custom get-all-headers callback.
.TP .IP CURLOPT_DEBUGFUNCTION
.B CURLOPT_DEBUGFUNCTION
Function pointer that should match the following prototype: \fIint Function pointer that should match the following prototype: \fIint
curl_debug_callback (CURL *, curl_infotype, char *, size_t, void *);\fP curl_debug_callback (CURL *, curl_infotype, char *, size_t, void *);\fP
CURLOPT_DEBUGFUNCTION replaces the standard debug function used when CURLOPT_DEBUGFUNCTION replaces the standard debug function used when
@ -162,31 +148,23 @@ terminated, but will be exactly of the size as told by the size_t argument.
Available curl_infotype values: Available curl_infotype values:
.RS .RS
.TP 5 .IP CURLINFO_TEXT
.B CURLINFO_TEXT
The data is informational text. The data is informational text.
.TP .IP CURLINFO_HEADER_IN
.B CURLINFO_HEADER_IN
The data is header (or header-like) data received from the peer. The data is header (or header-like) data received from the peer.
.TP .IP CURLINFO_HEADER_OUT
.B CURLINFO_HEADER_OUT
The data is header (or header-like) data sent to the peer. The data is header (or header-like) data sent to the peer.
.TP .IP CURLINFO_DATA_IN
.B CURLINFO_DATA_IN
The data is protocol data received from the peer. The data is protocol data received from the peer.
.TP .IP CURLINFO_DATA_OUT
.B CURLINFO_DATA_OUT
The data is protocol data sent to the peer. The data is protocol data sent to the peer.
.RE .RE
.TP .IP CURLOPT_DEBUGDATA
.B CURLOPT_DEBUGDATA
Pass a pointer to whatever you want passed in to your CURLOPT_DEBUGFUNCTION in Pass a pointer to whatever you want passed in to your CURLOPT_DEBUGFUNCTION in
the last void * argument. This pointer is not used by libcurl, it is only the last void * argument. This pointer is not used by libcurl, it is only
passed to the callback. passed to the callback.
.PP
.SH ERROR OPTIONS .SH ERROR OPTIONS
.TP 0.4i .IP CURLOPT_ERRORBUFFER
.B CURLOPT_ERRORBUFFER
Pass a char * to a buffer that the libcurl may store human readable error Pass a char * to a buffer that the libcurl may store human readable error
messages in. This may be more helpful than just the return code from the messages in. This may be more helpful than just the return code from the
library. The buffer must be at least CURL_ERROR_SIZE big. library. The buffer must be at least CURL_ERROR_SIZE big.
@ -196,27 +174,22 @@ debug/trace why errors happen.
\fBNote:\fP if the library does not return an error, the buffer may not have \fBNote:\fP if the library does not return an error, the buffer may not have
been touched. Do not rely on the contents in those cases. been touched. Do not rely on the contents in those cases.
.TP .IP CURLOPT_STDERR
.B CURLOPT_STDERR
Pass a FILE * as parameter. This is the stream to use instead of stderr Pass a FILE * as parameter. This is the stream to use instead of stderr
internally when reporting errors. internally when reporting errors.
.TP .IP CURLOPT_FAILONERROR
.B CURLOPT_FAILONERROR
A non-zero parameter tells the library to fail silently if the HTTP code A non-zero parameter tells the library to fail silently if the HTTP code
returned is equal to or larger than 300. The default action would be to return returned is equal to or larger than 300. The default action would be to return
the page normally, ignoring that code. the page normally, ignoring that code.
.PP
.SH NETWORK OPTIONS .SH NETWORK OPTIONS
.TP 0.4i .IP CURLOPT_URL
.B CURLOPT_URL
The actual URL to deal with. The parameter should be a char * to a zero The actual URL to deal with. The parameter should be a char * to a zero
terminated string. The string must remain present until curl no longer needs terminated string. The string must remain present until curl no longer needs
it, as it doesn't copy the string. it, as it doesn't copy the string.
\fBNOTE:\fP this option is (the only one) required to be set before \fBNOTE:\fP this option is (the only one) required to be set before
\fIcurl_easy_perform(3)\fP is called. \fIcurl_easy_perform(3)\fP is called.
.TP .IP CURLOPT_PROXY
.B CURLOPT_PROXY
Set HTTP proxy to use. The parameter should be a char * to a zero terminated Set HTTP proxy to use. The parameter should be a char * to a zero terminated
string holding the host name or dotted IP address. To specify port number in string holding the host name or dotted IP address. To specify port number in
this string, append :[port] to the end of the host name. The proxy string may this string, append :[port] to the end of the host name. The proxy string may
@ -233,47 +206,38 @@ you tunnel through the HTTP proxy. Such tunneling is activated with
\fBNOTE2:\fP libcurl respects the environment variables \fBhttp_proxy\fP, \fBNOTE2:\fP libcurl respects the environment variables \fBhttp_proxy\fP,
\fBftp_proxy\fP, \fBall_proxy\fP etc, if any of those is set. \fBftp_proxy\fP, \fBall_proxy\fP etc, if any of those is set.
.TP .IP CURLOPT_PROXYPORT
.B CURLOPT_PROXYPORT
Pass a long with this option to set the proxy port to connect to unless it is Pass a long with this option to set the proxy port to connect to unless it is
specified in the proxy string \fICURLOPT_PROXY\fP. specified in the proxy string \fICURLOPT_PROXY\fP.
.TP .IP CURLOPT_PROXYTYPE
.B CURLOPT_PROXYTYPE
Pass a long with this option to set type of the proxy. Available options for Pass a long with this option to set type of the proxy. Available options for
this are CURLPROXY_HTTP and CURLPROXY_SOCKS5, with the HTTP one being this are CURLPROXY_HTTP and CURLPROXY_SOCKS5, with the HTTP one being
default. (Added in 7.10) default. (Added in 7.10)
.TP .IP CURLOPT_HTTPPROXYTUNNEL
.B CURLOPT_HTTPPROXYTUNNEL
Set the parameter to non-zero to get the library to tunnel all operations Set the parameter to non-zero to get the library to tunnel all operations
through a given HTTP proxy. Note that there is a big difference between using through a given HTTP proxy. Note that there is a big difference between using
a proxy and to tunnel through it. If you don't know what this means, you a proxy and to tunnel through it. If you don't know what this means, you
probably don't want this tunneling option. probably don't want this tunneling option.
.TP .IP CURLOPT_INTERFACE
.B CURLOPT_INTERFACE
Pass a char * as parameter. This set the interface name to use as outgoing Pass a char * as parameter. This set the interface name to use as outgoing
network interface. The name can be an interface name, an IP address or a host network interface. The name can be an interface name, an IP address or a host
name. name.
.TP .IP CURLOPT_DNS_CACHE_TIMEOUT
.B CURLOPT_DNS_CACHE_TIMEOUT
Pass a long, this sets the timeout in seconds. Name resolves will be kept in Pass a long, this sets the timeout in seconds. Name resolves will be kept in
memory for this number of seconds. Set to zero (0) to completely disable memory for this number of seconds. Set to zero (0) to completely disable
caching, or set to -1 to make the cached entries remain forever. By default, caching, or set to -1 to make the cached entries remain forever. By default,
libcurl caches info for 60 seconds. libcurl caches info for 60 seconds.
.TP .IP CURLOPT_DNS_USE_GLOBAL_CACHE
.B CURLOPT_DNS_USE_GLOBAL_CACHE
Pass a long. If the value is non-zero, it tells curl to use a global DNS cache Pass a long. If the value is non-zero, it tells curl to use a global DNS cache
that will survive between easy handle creations and deletions. This is not that will survive between easy handle creations and deletions. This is not
thread-safe and this will use a global varible. thread-safe and this will use a global varible.
.TP .IP CURLOPT_BUFFERSIZE
.B CURLOPT_BUFFERSIZE
Pass a long specifying your prefered size for the receive buffer in libcurl. Pass a long specifying your prefered size for the receive buffer in libcurl.
The main point of this would be that the write callback gets called more often The main point of this would be that the write callback gets called more often
and with smaller chunks. This is just treated as a request, not an order. You and with smaller chunks. This is just treated as a request, not an order. You
cannot be guaranteed to actually get the given size. (Added in 7.10) cannot be guaranteed to actually get the given size. (Added in 7.10)
.PP
.SH NAMES and PASSWORDS OPTIONS (Authentication) .SH NAMES and PASSWORDS OPTIONS (Authentication)
.TP 0.4i .IP CURLOPT_NETRC
.B CURLOPT_NETRC
This parameter controls the preference of libcurl between using user names and This parameter controls the preference of libcurl between using user names and
passwords from your \fI~/.netrc\fP file, relative to user names and passwords passwords from your \fI~/.netrc\fP file, relative to user names and passwords
in the URL supplied with \fICURLOPT_URL\fP. in the URL supplied with \fICURLOPT_URL\fP.
@ -284,8 +248,7 @@ controlled by this parameter.
Pass a long, set to one of the values described below. Pass a long, set to one of the values described below.
.RS .RS
.TP 5 .IP CURL_NETRC_OPTIONAL
.B CURL_NETRC_OPTIONAL
The use of your \fI~/.netrc\fP file is optional, The use of your \fI~/.netrc\fP file is optional,
and information in the URL is to be preferred. The file will be scanned and information in the URL is to be preferred. The file will be scanned
with the host and user name (to find the password only) or with the host only, with the host and user name (to find the password only) or with the host only,
@ -293,26 +256,22 @@ to find the first user name and password after that \fImachine\fP,
which ever information is not specified in the URL. which ever information is not specified in the URL.
Undefined values of the option will have this effect. Undefined values of the option will have this effect.
.TP .IP CURL_NETRC_IGNORED
.B CURL_NETRC_IGNORED
The library will ignore the file and use only the information in the URL. The library will ignore the file and use only the information in the URL.
This is the default. This is the default.
.TP .IP CURL_NETRC_REQUIRED
.B CURL_NETRC_REQUIRED
This value tells the library that use of the file is required, This value tells the library that use of the file is required,
to ignore the information in the URL, to ignore the information in the URL,
and to search the file with the host only. and to search the file with the host only.
.RE .RE
.TP
Only machine name, user name and password are taken into account Only machine name, user name and password are taken into account
(init macros and similar things aren't supported). (init macros and similar things aren't supported).
\fBNote:\fP libcurl does not verify that the file has the correct properties \fBNote:\fP libcurl does not verify that the file has the correct properties
set (as the standard Unix ftp client does). It should only be readable by set (as the standard Unix ftp client does). It should only be readable by
user. user.
.TP .IP CURLOPT_USERPWD
.B CURLOPT_USERPWD
Pass a char * as parameter, which should be [user name]:[password] to use for Pass a char * as parameter, which should be [user name]:[password] to use for
the connection. If both the colon and password is left out, you will be the connection. If both the colon and password is left out, you will be
prompted for it while using a colon with no password will make libcurl use an prompted for it while using a colon with no password will make libcurl use an
@ -325,14 +284,12 @@ password information to hosts using the initial host name (unless
CURLOPT_UNRESTRICTED_AUTH is set), so if libcurl follows locations to other CURLOPT_UNRESTRICTED_AUTH is set), so if libcurl follows locations to other
hosts it will not send the user and password to those. This is enforced to hosts it will not send the user and password to those. This is enforced to
prevent accidental information leakage. prevent accidental information leakage.
.TP .IP CURLOPT_PROXYUSERPWD
.B CURLOPT_PROXYUSERPWD
Pass a char * as parameter, which should be [user name]:[password] to use for Pass a char * as parameter, which should be [user name]:[password] to use for
the connection to the HTTP proxy. If the password is left out, you will be the connection to the HTTP proxy. If the password is left out, you will be
prompted for it. \fICURLOPT_PASSWDFUNCTION\fP can be used to set your own prompted for it. \fICURLOPT_PASSWDFUNCTION\fP can be used to set your own
prompt function. prompt function.
.TP .IP CURLOPT_HTTPAUTH
.B CURLOPT_HTTPAUTH
Pass a long as parameter, which is set to a bitmask, to tell libcurl what Pass a long as parameter, which is set to a bitmask, to tell libcurl what
authentication method(s) you want it to use. The available bits are listed authentication method(s) you want it to use. The available bits are listed
below. If more than one bit is set, libcurl will first query the site to see below. If more than one bit is set, libcurl will first query the site to see
@ -341,42 +298,35 @@ it to use. Note that for some methods, this will induce an extra network
round-trip. Set the actual name and password with the \fICURLOPT_USERPWD\fP round-trip. Set the actual name and password with the \fICURLOPT_USERPWD\fP
option. (Added in 7.10.6) option. (Added in 7.10.6)
.RS .RS
.TP 5 .IP CURLAUTH_BASIC
.B CURLAUTH_BASIC
HTTP Basic authentication. This is the default choice, and the only method HTTP Basic authentication. This is the default choice, and the only method
that is in wide-spread use and supported virtually everywhere. This is sending that is in wide-spread use and supported virtually everywhere. This is sending
the user name and password over the network in plain text, easily captured by the user name and password over the network in plain text, easily captured by
others. others.
.TP .IP CURLAUTH_DIGEST
.B CURLAUTH_DIGEST
HTTP Digest authentication. Digest authentication is defined in RFC2617 and HTTP Digest authentication. Digest authentication is defined in RFC2617 and
is a more secure way to do authentication over public networks than the is a more secure way to do authentication over public networks than the
regular old-fashioned Basic method. regular old-fashioned Basic method.
.TP .IP CURLAUTH_GSSNEGOTIATE
.B CURLAUTH_GSSNEGOTIATE
HTTP GSS-Negotiate authentication. The GSS-Negotiate method was designed by HTTP GSS-Negotiate authentication. The GSS-Negotiate method was designed by
Microsoft and is used in their web aplications. It is primarily meant as a Microsoft and is used in their web aplications. It is primarily meant as a
support for Kerberos5 authentication but may be also used along with another support for Kerberos5 authentication but may be also used along with another
authentication methods. For more information see IETF draft authentication methods. For more information see IETF draft
draft-brezak-spnego-http-04.txt. draft-brezak-spnego-http-04.txt.
.TP .IP CURLAUTH_NTLM
.B CURLAUTH_NTLM
HTTP NTLM authentication. A proprietary protocol invented and used by HTTP NTLM authentication. A proprietary protocol invented and used by
Microsoft. It uses a challenge-response and hash concept similar to Digest to Microsoft. It uses a challenge-response and hash concept similar to Digest to
prevent the password from being evesdropped. prevent the password from being evesdropped.
.TP .IP CURLAUTH_ANY
.B CURLAUTH_ANY
This is a convenience macro that sets all bits and thus makes libcurl pick any This is a convenience macro that sets all bits and thus makes libcurl pick any
it finds suitable. libcurl will automaticly select the one it finds most it finds suitable. libcurl will automaticly select the one it finds most
secure. secure.
.TP .IP CURLAUTH_ANYSAFE
.B CURLAUTH_ANYSAFE
This is a convenience macro that sets all bits except Basic and thus makes This is a convenience macro that sets all bits except Basic and thus makes
libcurl pick any it finds suitable. libcurl will automaticly select the one it libcurl pick any it finds suitable. libcurl will automaticly select the one it
finds most secure. finds most secure.
.RE .RE
.TP .IP CURLOPT_PROXYAUTH
.B CURLOPT_PROXYAUTH
Pass a long as parameter, which is set to a bitmask, to tell libcurl what Pass a long as parameter, which is set to a bitmask, to tell libcurl what
authentication method(s) you want it to use for your proxy authentication. If authentication method(s) you want it to use for your proxy authentication. If
more than one bit is set, libcurl will first query the site to see what more than one bit is set, libcurl will first query the site to see what
@ -386,10 +336,8 @@ round-trip. Set the actual name and password with the
\fICURLOPT_PROXYUSERPWD\fP option. The bitmask can be constructed by or'ing \fICURLOPT_PROXYUSERPWD\fP option. The bitmask can be constructed by or'ing
together the bits listed above for the \fICURLOPT_HTTPAUTH\fP option. As of together the bits listed above for the \fICURLOPT_HTTPAUTH\fP option. As of
this writing, only Basic and NTLM work. (Added in 7.10.7) this writing, only Basic and NTLM work. (Added in 7.10.7)
.PP
.SH HTTP OPTIONS .SH HTTP OPTIONS
.TP 0.4i .IP CURLOPT_ENCODING
.B CURLOPT_ENCODING
Sets the contents of the Accept-Encoding: header sent in an HTTP Sets the contents of the Accept-Encoding: header sent in an HTTP
request, and enables decoding of a response when a Content-Encoding: request, and enables decoding of a response when a Content-Encoding:
header is received. Three encodings are supported: \fIidentity\fP, header is received. Three encodings are supported: \fIidentity\fP,
@ -402,8 +350,7 @@ This is a request, not an order; the server may or may not do it. This
option must be set (to any non-NULL value) or else any unsolicited option must be set (to any non-NULL value) or else any unsolicited
encoding done by the server is ignored. See the special file encoding done by the server is ignored. See the special file
lib/README.encoding for details. lib/README.encoding for details.
.TP .IP CURLOPT_FOLLOWLOCATION
.B CURLOPT_FOLLOWLOCATION
A non-zero parameter tells the library to follow any Location: header that the A non-zero parameter tells the library to follow any Location: header that the
server sends as part of a HTTP header. server sends as part of a HTTP header.
@ -411,31 +358,26 @@ server sends as part of a HTTP header.
new location and follow new Location: headers all the way until no more such new location and follow new Location: headers all the way until no more such
headers are returned. \fICURLOPT_MAXREDIRS\fP can be used to limit the number headers are returned. \fICURLOPT_MAXREDIRS\fP can be used to limit the number
of redirects libcurl will follow. of redirects libcurl will follow.
.TP .IP CURLOPT_UNRESTRICTED_AUTH
.B CURLOPT_UNRESTRICTED_AUTH
A non-zero parameter tells the library it can continue to send authentication A non-zero parameter tells the library it can continue to send authentication
(user+password) when following locations, even when hostname changed. Note (user+password) when following locations, even when hostname changed. Note
that this is meaningful only when setting \fICURLOPT_FOLLOWLOCATION\fP. that this is meaningful only when setting \fICURLOPT_FOLLOWLOCATION\fP.
.TP .IP CURLOPT_MAXREDIRS
.B CURLOPT_MAXREDIRS
Pass a long. The set number will be the redirection limit. If that many Pass a long. The set number will be the redirection limit. If that many
redirections have been followed, the next redirect will cause an error redirections have been followed, the next redirect will cause an error
(\fICURLE_TOO_MANY_REDIRECTS\fP). This option only makes sense if the (\fICURLE_TOO_MANY_REDIRECTS\fP). This option only makes sense if the
\fICURLOPT_FOLLOWLOCATION\fP is used at the same time. \fICURLOPT_FOLLOWLOCATION\fP is used at the same time.
.TP .IP CURLOPT_PUT
.B CURLOPT_PUT
A non-zero parameter tells the library to use HTTP PUT to transfer data. The A non-zero parameter tells the library to use HTTP PUT to transfer data. The
data should be set with CURLOPT_READDATA and CURLOPT_INFILESIZE. data should be set with CURLOPT_READDATA and CURLOPT_INFILESIZE.
.TP .IP CURLOPT_POST
.B CURLOPT_POST
A non-zero parameter tells the library to do a regular HTTP post. This is a A non-zero parameter tells the library to do a regular HTTP post. This is a
normal application/x-www-form-urlencoded kind, which is the most commonly used normal application/x-www-form-urlencoded kind, which is the most commonly used
one by HTML forms. See the CURLOPT_POSTFIELDS option for how to specify the one by HTML forms. See the CURLOPT_POSTFIELDS option for how to specify the
data to post and CURLOPT_POSTFIELDSIZE in how to set the data size. Starting data to post and CURLOPT_POSTFIELDSIZE in how to set the data size. Starting
with libcurl 7.8, this option is obsolete. Using the CURLOPT_POSTFIELDS option with libcurl 7.8, this option is obsolete. Using the CURLOPT_POSTFIELDS option
will imply this option. will imply this option.
.TP .IP CURLOPT_POSTFIELDS
.B CURLOPT_POSTFIELDS
Pass a char * as parameter, which should be the full data to post in a HTTP Pass a char * as parameter, which should be the full data to post in a HTTP
post operation. You need to make sure that the data is formatted the way you post operation. You need to make sure that the data is formatted the way you
want the server to receive it. libcurl will not convert or encode it for want the server to receive it. libcurl will not convert or encode it for
@ -448,14 +390,12 @@ CURLOPT_POSTFIELDS implies CURLOPT_POST.
\fBNote:\fP to make multipart/formdata posts (aka rfc1867-posts), check out \fBNote:\fP to make multipart/formdata posts (aka rfc1867-posts), check out
the \fICURLOPT_HTTPPOST\fP option. the \fICURLOPT_HTTPPOST\fP option.
.TP .IP CURLOPT_POSTFIELDSIZE
.B CURLOPT_POSTFIELDSIZE
If you want to post data to the server without letting libcurl do a strlen() If you want to post data to the server without letting libcurl do a strlen()
to measure the data size, this option must be used. When this option is used to measure the data size, this option must be used. When this option is used
you can post fully binary data, which otherwise is likely to fail. If this you can post fully binary data, which otherwise is likely to fail. If this
size is set to zero, the library will use strlen() to get the size. size is set to zero, the library will use strlen() to get the size.
.TP .IP CURLOPT_HTTPPOST
.B CURLOPT_HTTPPOST
Tells libcurl you want a multipart/formdata HTTP POST to be made and you Tells libcurl you want a multipart/formdata HTTP POST to be made and you
instruct what data to pass on to the server. Pass a pointer to a linked list instruct what data to pass on to the server. Pass a pointer to a linked list
of HTTP post structs as parameter. The linked list should be a fully valid of HTTP post structs as parameter. The linked list should be a fully valid
@ -463,20 +403,17 @@ list of 'struct HttpPost' structs properly filled in. The best and most
elegant way to do this, is to use \fIcurl_formadd(3)\fP as documented. The elegant way to do this, is to use \fIcurl_formadd(3)\fP as documented. The
data in this list must remain intact until you close this curl handle again data in this list must remain intact until you close this curl handle again
with \fIcurl_easy_cleanup(3)\fP. with \fIcurl_easy_cleanup(3)\fP.
.TP .IP CURLOPT_REFERER
.B CURLOPT_REFERER
Pass a pointer to a zero terminated string as parameter. It will be used to Pass a pointer to a zero terminated string as parameter. It will be used to
set the Referer: header in the http request sent to the remote server. This set the Referer: header in the http request sent to the remote server. This
can be used to fool servers or scripts. You can also set any custom header can be used to fool servers or scripts. You can also set any custom header
with \fICURLOPT_HTTPHEADER\fP. with \fICURLOPT_HTTPHEADER\fP.
.TP .IP CURLOPT_USERAGENT
.B CURLOPT_USERAGENT
Pass a pointer to a zero terminated string as parameter. It will be used to Pass a pointer to a zero terminated string as parameter. It will be used to
set the User-Agent: header in the http request sent to the remote server. This set the User-Agent: header in the http request sent to the remote server. This
can be used to fool servers or scripts. You can also set any custom header can be used to fool servers or scripts. You can also set any custom header
with \fICURLOPT_HTTPHEADER\fP. with \fICURLOPT_HTTPHEADER\fP.
.TP .IP CURLOPT_HTTPHEADER
.B CURLOPT_HTTPHEADER
Pass a pointer to a linked list of HTTP headers to pass to the server in your Pass a pointer to a linked list of HTTP headers to pass to the server in your
HTTP request. The linked list should be a fully valid list of \fBstruct HTTP request. The linked list should be a fully valid list of \fBstruct
curl_slist\fP structs properly filled in. Use \fIcurl_slist_append(3)\fP to curl_slist\fP structs properly filled in. Use \fIcurl_slist_append(3)\fP to
@ -497,8 +434,7 @@ request-line are headers.
\fBNOTE:\fPThe most commonly replaced headers have "shortcuts" in the options \fBNOTE:\fPThe most commonly replaced headers have "shortcuts" in the options
CURLOPT_COOKIE, CURLOPT_USERAGENT and CURLOPT_REFERER. CURLOPT_COOKIE, CURLOPT_USERAGENT and CURLOPT_REFERER.
.TP .IP CURLOPT_HTTP200ALIASES
.B CURLOPT_HTTP200ALIASES
Pass a pointer to a linked list of aliases to be treated as valid HTTP 200 Pass a pointer to a linked list of aliases to be treated as valid HTTP 200
responses. Some servers respond with a custom header response line. For responses. Some servers respond with a custom header response line. For
example, IceCast servers respond with "ICY 200 OK". By including this string example, IceCast servers respond with "ICY 200 OK". By including this string
@ -513,8 +449,7 @@ be properly filled in. Use \fIcurl_slist_append(3)\fP to create the list and
alias is "MYHTTP/9.9", Libcurl will not treat the server as responding with alias is "MYHTTP/9.9", Libcurl will not treat the server as responding with
HTTP version 9.9. Instead Libcurl will use the value set by option HTTP version 9.9. Instead Libcurl will use the value set by option
\fICURLOPT_HTTP_VERSION\fP. \fICURLOPT_HTTP_VERSION\fP.
.TP .IP CURLOPT_COOKIE
.B CURLOPT_COOKIE
Pass a pointer to a zero terminated string as parameter. It will be used to Pass a pointer to a zero terminated string as parameter. It will be used to
set a cookie in the http request. The format of the string should be set a cookie in the http request. The format of the string should be
NAME=CONTENTS, where NAME is the cookie name and CONTENTS is what the cookie NAME=CONTENTS, where NAME is the cookie name and CONTENTS is what the cookie
@ -526,8 +461,7 @@ cookies in one string like this: "name1=content1; name2=content2;" etc.
Using this option multiple times will only make the latest string override the Using this option multiple times will only make the latest string override the
previously ones. previously ones.
.TP .IP CURLOPT_COOKIEFILE
.B CURLOPT_COOKIEFILE
Pass a pointer to a zero terminated string as parameter. It should contain the Pass a pointer to a zero terminated string as parameter. It should contain the
name of your file holding cookie data to read. The cookie data may be in name of your file holding cookie data to read. The cookie data may be in
Netscape / Mozilla cookie data format or just regular HTTP-style headers Netscape / Mozilla cookie data format or just regular HTTP-style headers
@ -536,8 +470,7 @@ dumped to a file.
Given an empty or non-existing file, this option will enable cookies for this Given an empty or non-existing file, this option will enable cookies for this
curl handle, making it understand and parse received cookies and then use curl handle, making it understand and parse received cookies and then use
matching cookies in future request. matching cookies in future request.
.TP .IP CURLOPT_COOKIEJAR
.B CURLOPT_COOKIEJAR
Pass a file name as char *, zero terminated. This will make libcurl write all Pass a file name as char *, zero terminated. This will make libcurl write all
internally known cookies to the specified file when \fIcurl_easy_cleanup(3)\fP internally known cookies to the specified file when \fIcurl_easy_cleanup(3)\fP
is called. If no cookies are known, no file will be created. Specify "-" to is called. If no cookies are known, no file will be created. Specify "-" to
@ -545,48 +478,39 @@ instead have the cookies written to stdout. Using this option also enables
cookies for this session, so if you for example follow a location it will make cookies for this session, so if you for example follow a location it will make
matching cookies get sent accordingly. matching cookies get sent accordingly.
.B NOTE .IP NOTE
If the cookie jar file can't be created or written to (when the If the cookie jar file can't be created or written to (when the
curl_easy_cleanup() is called), libcurl will not and cannot report an error curl_easy_cleanup() is called), libcurl will not and cannot report an error
for this. Using CURLOPT_VERBOSE or CURLOPT_DEBUGFUNCTION will get a warning to for this. Using CURLOPT_VERBOSE or CURLOPT_DEBUGFUNCTION will get a warning to
display, but that is the only visible feedback you get about this possibly display, but that is the only visible feedback you get about this possibly
lethal situation. lethal situation.
.TP .IP CURLOPT_TIMECONDITION
.B CURLOPT_TIMECONDITION
Pass a long as parameter. This defines how the CURLOPT_TIMEVALUE time value is Pass a long as parameter. This defines how the CURLOPT_TIMEVALUE time value is
treated. You can set this parameter to TIMECOND_IFMODSINCE or treated. You can set this parameter to TIMECOND_IFMODSINCE or
TIMECOND_IFUNMODSINCE. This is a HTTP-only feature. (TBD) TIMECOND_IFUNMODSINCE. This is a HTTP-only feature. (TBD)
.TP .IP CURLOPT_TIMEVALUE
.B CURLOPT_TIMEVALUE
Pass a long as parameter. This should be the time in seconds since 1 jan 1970, Pass a long as parameter. This should be the time in seconds since 1 jan 1970,
and the time will be used in a condition as specified with and the time will be used in a condition as specified with
CURLOPT_TIMECONDITION. CURLOPT_TIMECONDITION.
.TP .IP CURLOPT_HTTPGET
.B CURLOPT_HTTPGET
Pass a long. If the long is non-zero, this forces the HTTP request to get back Pass a long. If the long is non-zero, this forces the HTTP request to get back
to GET. Only really usable if POST, PUT or a custom request have been used to GET. Only really usable if POST, PUT or a custom request have been used
previously using the same curl handle. previously using the same curl handle.
.TP .IP CURLOPT_HTTP_VERSION
.B CURLOPT_HTTP_VERSION
Pass a long, set to one of the values described below. They force libcurl to Pass a long, set to one of the values described below. They force libcurl to
use the specific HTTP versions. This is not sensible to do unless you have a use the specific HTTP versions. This is not sensible to do unless you have a
good reason. good reason.
.RS .RS
.TP 5 .IP CURL_HTTP_VERSION_NONE
.B CURL_HTTP_VERSION_NONE
We don't care about what version the library uses. libcurl will use whatever We don't care about what version the library uses. libcurl will use whatever
it thinks fit. it thinks fit.
.TP .IP CURL_HTTP_VERSION_1_0
.B CURL_HTTP_VERSION_1_0
Enforce HTTP 1.0 requests. Enforce HTTP 1.0 requests.
.TP .IP CURL_HTTP_VERSION_1_1
.B CURL_HTTP_VERSION_1_1
Enforce HTTP 1.1 requests. Enforce HTTP 1.1 requests.
.RE .RE
.PP
.SH FTP OPTIONS .SH FTP OPTIONS
.TP 0.4i .IP CURLOPT_FTPPORT
.B CURLOPT_FTPPORT
Pass a pointer to a zero terminated string as parameter. It will be used to Pass a pointer to a zero terminated string as parameter. It will be used to
get the IP address to use for the ftp PORT instruction. The PORT instruction get the IP address to use for the ftp PORT instruction. The PORT instruction
tells the remote server to connect to our specified IP address. The string may tells the remote server to connect to our specified IP address. The string may
@ -596,8 +520,7 @@ address. Default FTP operations are passive, and thus won't use PORT.
You disable PORT again and go back to using the passive version by setting You disable PORT again and go back to using the passive version by setting
this option to NULL. this option to NULL.
.TP .IP CURLOPT_QUOTE
.B CURLOPT_QUOTE
Pass a pointer to a linked list of FTP commands to pass to the server prior to Pass a pointer to a linked list of FTP commands to pass to the server prior to
your ftp request. This will be done before any other FTP commands are issued your ftp request. This will be done before any other FTP commands are issued
(even before the CWD command). The linked list should be a fully valid list of (even before the CWD command). The linked list should be a fully valid list of
@ -605,22 +528,19 @@ your ftp request. This will be done before any other FTP commands are issued
to append strings (commands) to the list, and clear the entire list afterwards to append strings (commands) to the list, and clear the entire list afterwards
with \fIcurl_slist_free_all(3)\fP. Disable this operation again by setting a with \fIcurl_slist_free_all(3)\fP. Disable this operation again by setting a
NULL to this option. NULL to this option.
.TP .IP CURLOPT_POSTQUOTE
.B CURLOPT_POSTQUOTE
Pass a pointer to a linked list of FTP commands to pass to the server after Pass a pointer to a linked list of FTP commands to pass to the server after
your ftp transfer request. The linked list should be a fully valid list of your ftp transfer request. The linked list should be a fully valid list of
struct curl_slist structs properly filled in as described for struct curl_slist structs properly filled in as described for
\fICURLOPT_QUOTE\fP. Disable this operation again by setting a NULL to this \fICURLOPT_QUOTE\fP. Disable this operation again by setting a NULL to this
option. option.
.TP .IP CURLOPT_PREQUOTE
.B CURLOPT_PREQUOTE
Pass a pointer to a linked list of FTP commands to pass to the server after Pass a pointer to a linked list of FTP commands to pass to the server after
the transfer type is set. The linked list should be a fully valid list of the transfer type is set. The linked list should be a fully valid list of
struct curl_slist structs properly filled in as described for struct curl_slist structs properly filled in as described for
\fICURLOPT_QUOTE\fP. Disable this operation again by setting a NULL to this \fICURLOPT_QUOTE\fP. Disable this operation again by setting a NULL to this
option. option.
.TP .IP CURLOPT_FTPLISTONLY
.B CURLOPT_FTPLISTONLY
A non-zero parameter tells the library to just list the names of an ftp A non-zero parameter tells the library to just list the names of an ftp
directory, instead of doing a full directory listing that would include file directory, instead of doing a full directory listing that would include file
sizes, dates etc. sizes, dates etc.
@ -628,30 +548,25 @@ sizes, dates etc.
This causes an FTP NLST command to be sent. Beware that some FTP servers list This causes an FTP NLST command to be sent. Beware that some FTP servers list
only files in their response to NLST; they might not include subdirectories only files in their response to NLST; they might not include subdirectories
and symbolic links. and symbolic links.
.TP .IP CURLOPT_FTPAPPEND
.B CURLOPT_FTPAPPEND
A non-zero parameter tells the library to append to the remote file instead of A non-zero parameter tells the library to append to the remote file instead of
overwrite it. This is only useful when uploading to a ftp site. overwrite it. This is only useful when uploading to a ftp site.
.TP .IP CURLOPT_FTP_USE_EPRT
.B CURLOPT_FTP_USE_EPRT
Pass a long. If the value is non-zero, it tells curl to use the EPRT (and Pass a long. If the value is non-zero, it tells curl to use the EPRT (and
LPRT) command when doing active FTP downloads (which is enabled by LPRT) command when doing active FTP downloads (which is enabled by
CURLOPT_FTPPORT). Using EPRT means that it will first attempt to use EPRT and CURLOPT_FTPPORT). Using EPRT means that it will first attempt to use EPRT and
then LPRT before using PORT, but if you pass FALSE (zero) to this option, it then LPRT before using PORT, but if you pass FALSE (zero) to this option, it
will not try using EPRT or LPRT, only plain PORT. (Added in 7.10.5) will not try using EPRT or LPRT, only plain PORT. (Added in 7.10.5)
.TP .IP CURLOPT_FTP_USE_EPSV
.B CURLOPT_FTP_USE_EPSV
Pass a long. If the value is non-zero, it tells curl to use the EPSV command Pass a long. If the value is non-zero, it tells curl to use the EPSV command
when doing passive FTP downloads (which it always does by default). Using EPSV when doing passive FTP downloads (which it always does by default). Using EPSV
means that it will first attempt to use EPSV before using PASV, but if you means that it will first attempt to use EPSV before using PASV, but if you
pass FALSE (zero) to this option, it will not try using EPSV, only plain PASV. pass FALSE (zero) to this option, it will not try using EPSV, only plain PASV.
.TP .IP CURLOPT_FTP_CREATE_MISSING_DIRS
.B CURLOPT_FTP_CREATE_MISSING_DIRS
Pass a long. If the value is non-zero, curl will attempt to create any remote Pass a long. If the value is non-zero, curl will attempt to create any remote
directory that it fails to CWD into. CWD is the command that changes working directory that it fails to CWD into. CWD is the command that changes working
directory. (Added in 7.10.7) directory. (Added in 7.10.7)
.TP .IP CURLOPT_FTP_RESPONSE_TIMEOUT
.B CURLOPT_FTP_RESPONSE_TIMEOUT
Pass a long. Causes curl to set a timeout period (in seconds) on the amount Pass a long. Causes curl to set a timeout period (in seconds) on the amount
of time that the server is allowed to take in order to generate a response of time that the server is allowed to take in order to generate a response
message for a command before the session is considered hung. Note that while message for a command before the session is considered hung. Note that while
@ -659,33 +574,27 @@ curl is waiting for a response, this value overrides CURLOPT_TIMEOUT. It is
recommended that if used in conjunction with CURLOPT_TIMEOUT, you set recommended that if used in conjunction with CURLOPT_TIMEOUT, you set
CURLOPT_FTP_RESPONSE_TIMEOUT to a value smaller than CURLOPT_TIMEOUT. CURLOPT_FTP_RESPONSE_TIMEOUT to a value smaller than CURLOPT_TIMEOUT.
(Added in 7.10.8) (Added in 7.10.8)
.PP
.SH PROTOCOL OPTIONS .SH PROTOCOL OPTIONS
.TP 0.4i .IP CURLOPT_TRANSFERTEXT
.B CURLOPT_TRANSFERTEXT
A non-zero parameter tells the library to use ASCII mode for ftp transfers, A non-zero parameter tells the library to use ASCII mode for ftp transfers,
instead of the default binary transfer. For LDAP transfers it gets the data in instead of the default binary transfer. For LDAP transfers it gets the data in
plain text instead of HTML and for win32 systems it does not set the stdout to plain text instead of HTML and for win32 systems it does not set the stdout to
binary mode. This option can be usable when transferring text data between binary mode. This option can be usable when transferring text data between
systems with different views on certain characters, such as newlines or systems with different views on certain characters, such as newlines or
similar. similar.
.TP .IP CURLOPT_CRLF
.B CURLOPT_CRLF
Convert Unix newlines to CRLF newlines on transfers. Convert Unix newlines to CRLF newlines on transfers.
.TP .IP CURLOPT_RANGE
.B CURLOPT_RANGE
Pass a char * as parameter, which should contain the specified range you Pass a char * as parameter, which should contain the specified range you
want. It should be in the format "X-Y", where X or Y may be left out. HTTP want. It should be in the format "X-Y", where X or Y may be left out. HTTP
transfers also support several intervals, separated with commas as in transfers also support several intervals, separated with commas as in
\fI"X-Y,N-M"\fP. Using this kind of multiple intervals will cause the HTTP \fI"X-Y,N-M"\fP. Using this kind of multiple intervals will cause the HTTP
server to send the response document in pieces (using standard MIME separation server to send the response document in pieces (using standard MIME separation
techniques). techniques).
.TP .IP CURLOPT_RESUME_FROM
.B CURLOPT_RESUME_FROM
Pass a long as parameter. It contains the offset in number of bytes that you Pass a long as parameter. It contains the offset in number of bytes that you
want the transfer to start from. want the transfer to start from.
.TP .IP CURLOPT_CUSTOMREQUEST
.B CURLOPT_CUSTOMREQUEST
Pass a pointer to a zero terminated string as parameter. It will be user Pass a pointer to a zero terminated string as parameter. It will be user
instead of GET or HEAD when doing a HTTP request, or instead of LIST or NLST instead of GET or HEAD when doing a HTTP request, or instead of LIST or NLST
when doing an ftp directory listing. This is useful for doing DELETE or other when doing an ftp directory listing. This is useful for doing DELETE or other
@ -699,28 +608,23 @@ could possibly confuse the remote server badly. Use \fICURLOPT_POST\fP and
\fICURLOPT_POSTFIELDS\fP to set POST data. Use \fICURLOPT_HTTPHEADER\fP to \fICURLOPT_POSTFIELDS\fP to set POST data. Use \fICURLOPT_HTTPHEADER\fP to
replace or extend the set of headers sent by libcurl. Use replace or extend the set of headers sent by libcurl. Use
\fICURLOPT_HTTP_VERSION\fP to change HTTP version. \fICURLOPT_HTTP_VERSION\fP to change HTTP version.
.TP .IP CURLOPT_FILETIME
.B CURLOPT_FILETIME
Pass a long. If it is a non-zero value, libcurl will attempt to get the Pass a long. If it is a non-zero value, libcurl will attempt to get the
modification date of the remote document in this operation. This requires that modification date of the remote document in this operation. This requires that
the remote server sends the time or replies to a time querying command. The the remote server sends the time or replies to a time querying command. The
\fIcurl_easy_getinfo(3)\fP function with the \fICURLINFO_FILETIME\fP argument \fIcurl_easy_getinfo(3)\fP function with the \fICURLINFO_FILETIME\fP argument
can be used after a transfer to extract the received time (if any). can be used after a transfer to extract the received time (if any).
.TP .IP CURLOPT_NOBODY
.B CURLOPT_NOBODY
A non-zero parameter tells the library to not include the body-part in the A non-zero parameter tells the library to not include the body-part in the
output. This is only relevant for protocols that have separate header and body output. This is only relevant for protocols that have separate header and body
parts. On HTTP(S) servers, this will make libcurl do a HEAD request. parts. On HTTP(S) servers, this will make libcurl do a HEAD request.
.TP .IP CURLOPT_INFILESIZE
.B CURLOPT_INFILESIZE
When uploading a file to a remote site, this option should be used to tell When uploading a file to a remote site, this option should be used to tell
libcurl what the expected size of the infile is. libcurl what the expected size of the infile is.
.TP .IP CURLOPT_UPLOAD
.B CURLOPT_UPLOAD
A non-zero parameter tells the library to prepare for an upload. The A non-zero parameter tells the library to prepare for an upload. The
CURLOPT_READDATA and CURLOPT_INFILESIZE are also interesting for uploads. CURLOPT_READDATA and CURLOPT_INFILESIZE are also interesting for uploads.
.TP .IP CURLOPT_MAXFILESIZE
.B CURLOPT_MAXFILESIZE
Pass a long as parameter. This allows you to specify the maximum size (in Pass a long as parameter. This allows you to specify the maximum size (in
bytes) of a file to download. If the file requested is larger than this value, bytes) of a file to download. If the file requested is larger than this value,
the transfer will not start and CURLE_FILESIZE_EXCEEDED will be returned. the transfer will not start and CURLE_FILESIZE_EXCEEDED will be returned.
@ -728,10 +632,8 @@ the transfer will not start and CURLE_FILESIZE_EXCEEDED will be returned.
NOTE: The file size is not always known prior to download, and for such files NOTE: The file size is not always known prior to download, and for such files
this option has no effect even if the file transfer ends up being larger than this option has no effect even if the file transfer ends up being larger than
this given limit. This concerns both FTP and HTTP transfers. this given limit. This concerns both FTP and HTTP transfers.
.PP
.SH CONNECTION OPTIONS .SH CONNECTION OPTIONS
.TP 0.4i .IP CURLOPT_TIMEOUT
.B CURLOPT_TIMEOUT
Pass a long as parameter containing the maximum time in seconds that you allow Pass a long as parameter containing the maximum time in seconds that you allow
the libcurl transfer operation to take. Normally, name lookups can take a the libcurl transfer operation to take. Normally, name lookups can take a
considerable time and limiting operations to less than a few minutes risk considerable time and limiting operations to less than a few minutes risk
@ -740,18 +642,15 @@ SIGALRM to enable time-outing system calls.
\fBNOTE:\fP this is not recommended to use in unix multi-threaded programs, as \fBNOTE:\fP this is not recommended to use in unix multi-threaded programs, as
it uses signals unless CURLOPT_NOSIGNAL (see above) is set. it uses signals unless CURLOPT_NOSIGNAL (see above) is set.
.TP .IP CURLOPT_LOW_SPEED_LIMIT
.B CURLOPT_LOW_SPEED_LIMIT
Pass a long as parameter. It contains the transfer speed in bytes per second Pass a long as parameter. It contains the transfer speed in bytes per second
that the transfer should be below during CURLOPT_LOW_SPEED_TIME seconds for that the transfer should be below during CURLOPT_LOW_SPEED_TIME seconds for
the library to consider it too slow and abort. the library to consider it too slow and abort.
.TP .IP CURLOPT_LOW_SPEED_TIME
.B CURLOPT_LOW_SPEED_TIME
Pass a long as parameter. It contains the time in seconds that the transfer Pass a long as parameter. It contains the time in seconds that the transfer
should be below the CURLOPT_LOW_SPEED_LIMIT for the library to consider it too should be below the CURLOPT_LOW_SPEED_LIMIT for the library to consider it too
slow and abort. slow and abort.
.TP .IP CURLOPT_MAXCONNECTS
.B CURLOPT_MAXCONNECTS
Pass a long. The set number will be the persistent connection cache size. The Pass a long. The set number will be the persistent connection cache size. The
set amount will be the maximum amount of simultaneously open connections that set amount will be the maximum amount of simultaneously open connections that
libcurl may cache. Default is 5, and there isn't much point in changing this libcurl may cache. Default is 5, and there isn't much point in changing this
@ -766,8 +665,7 @@ open connections to increase.
\fBNOTE:\fP if you already have performed transfers with this curl handle, \fBNOTE:\fP if you already have performed transfers with this curl handle,
setting a smaller MAXCONNECTS than before may cause open connections to get setting a smaller MAXCONNECTS than before may cause open connections to get
closed unnecessarily. closed unnecessarily.
.TP .IP CURLOPT_CLOSEPOLICY
.B CURLOPT_CLOSEPOLICY
Pass a long. This option sets what policy libcurl should use when the Pass a long. This option sets what policy libcurl should use when the
connection cache is filled and one of the open connections has to be closed to connection cache is filled and one of the open connections has to be closed to
make room for a new connection. This must be one of the CURLCLOSEPOLICY_* make room for a new connection. This must be one of the CURLCLOSEPOLICY_*
@ -777,24 +675,21 @@ likely to be capable of re-use. Use \fICURLCLOSEPOLICY_OLDEST\fP to make
libcurl close the oldest connection, the one that was created first among the libcurl close the oldest connection, the one that was created first among the
ones in the connection cache. The other close policies are not support ones in the connection cache. The other close policies are not support
yet. yet.
.TP .IP CURLOPT_FRESH_CONNECT
.B CURLOPT_FRESH_CONNECT
Pass a long. Set to non-zero to make the next transfer use a new (fresh) Pass a long. Set to non-zero to make the next transfer use a new (fresh)
connection by force. If the connection cache is full before this connection, connection by force. If the connection cache is full before this connection,
one of the existing connections will be closed as according to the selected or one of the existing connections will be closed as according to the selected or
default policy. This option should be used with caution and only if you default policy. This option should be used with caution and only if you
understand what it does. Set this to 0 to have libcurl attempt re-using an understand what it does. Set this to 0 to have libcurl attempt re-using an
existing connection (default behavior). existing connection (default behavior).
.TP .IP CURLOPT_FORBID_REUSE
.B CURLOPT_FORBID_REUSE
Pass a long. Set to non-zero to make the next transfer explicitly close the Pass a long. Set to non-zero to make the next transfer explicitly close the
connection when done. Normally, libcurl keep all connections alive when done connection when done. Normally, libcurl keep all connections alive when done
with one transfer in case there comes a succeeding one that can re-use them. with one transfer in case there comes a succeeding one that can re-use them.
This option should be used with caution and only if you understand what it This option should be used with caution and only if you understand what it
does. Set to 0 to have libcurl keep the connection open for possibly later does. Set to 0 to have libcurl keep the connection open for possibly later
re-use (default behavior). re-use (default behavior).
.TP .IP CURLOPT_CONNECTTIMEOUT
.B CURLOPT_CONNECTTIMEOUT
Pass a long. It should contain the maximum time in seconds that you allow the Pass a long. It should contain the maximum time in seconds that you allow the
connection to the server to take. This only limits the connection phase, once connection to the server to take. This only limits the connection phase, once
it has connected, this option is of no more use. Set to zero to disable it has connected, this option is of no more use. Set to zero to disable
@ -803,20 +698,16 @@ timeouts). See also the \fICURLOPT_TIMEOUT\fP option.
\fBNOTE:\fP this is not recommended to use in unix multi-threaded programs, as \fBNOTE:\fP this is not recommended to use in unix multi-threaded programs, as
it uses signals unless CURLOPT_NOSIGNAL (see above) is set. it uses signals unless CURLOPT_NOSIGNAL (see above) is set.
.PP
.SH SSL and SECURITY OPTIONS .SH SSL and SECURITY OPTIONS
.TP 0.4i .IP CURLOPT_SSLCERT
.B CURLOPT_SSLCERT
Pass a pointer to a zero terminated string as parameter. The string should be Pass a pointer to a zero terminated string as parameter. The string should be
the file name of your certificate. The default format is "PEM" and can be the file name of your certificate. The default format is "PEM" and can be
changed with \fICURLOPT_SSLCERTTYPE\fP. changed with \fICURLOPT_SSLCERTTYPE\fP.
.TP .IP CURLOPT_SSLCERTTYPE
.B CURLOPT_SSLCERTTYPE
Pass a pointer to a zero terminated string as parameter. The string should be Pass a pointer to a zero terminated string as parameter. The string should be
the format of your certificate. Supported formats are "PEM" and "DER". (Added the format of your certificate. Supported formats are "PEM" and "DER". (Added
in 7.9.3) in 7.9.3)
.TP .IP CURLOPT_SSLCERTPASSWD
.B CURLOPT_SSLCERTPASSWD
Pass a pointer to a zero terminated string as parameter. It will be used as Pass a pointer to a zero terminated string as parameter. It will be used as
the password required to use the CURLOPT_SSLCERT certificate. If the password the password required to use the CURLOPT_SSLCERT certificate. If the password
is not supplied, you will be prompted for it. \fICURLOPT_PASSWDFUNCTION\fP can is not supplied, you will be prompted for it. \fICURLOPT_PASSWDFUNCTION\fP can
@ -825,47 +716,40 @@ be used to set your own prompt function.
\fBNOTE:\fPThis option is replaced by \fICURLOPT_SSLKEYPASSWD\fP and only \fBNOTE:\fPThis option is replaced by \fICURLOPT_SSLKEYPASSWD\fP and only
cept for backward compatibility. You never needed a pass phrase to load cept for backward compatibility. You never needed a pass phrase to load
a certificate but you need one to load your private key. a certificate but you need one to load your private key.
.TP .IP CURLOPT_SSLKEY
.B CURLOPT_SSLKEY
Pass a pointer to a zero terminated string as parameter. The string should be Pass a pointer to a zero terminated string as parameter. The string should be
the file name of your private key. The default format is "PEM" and can be the file name of your private key. The default format is "PEM" and can be
changed with \fICURLOPT_SSLKEYTYPE\fP. changed with \fICURLOPT_SSLKEYTYPE\fP.
.TP .IP CURLOPT_SSLKEYTYPE
.B CURLOPT_SSLKEYTYPE
Pass a pointer to a zero terminated string as parameter. The string should be Pass a pointer to a zero terminated string as parameter. The string should be
the format of your private key. Supported formats are "PEM", "DER" and "ENG". the format of your private key. Supported formats are "PEM", "DER" and "ENG".
\fBNOTE:\fPThe format "ENG" enables you to load the private key from a crypto \fBNOTE:\fPThe format "ENG" enables you to load the private key from a crypto
engine. in this case \fICURLOPT_SSLKEY\fP is used as an identifier passed to engine. in this case \fICURLOPT_SSLKEY\fP is used as an identifier passed to
the engine. You have to set the crypto engine with \fICURLOPT_SSL_ENGINE\fP. the engine. You have to set the crypto engine with \fICURLOPT_SSL_ENGINE\fP.
.TP .IP CURLOPT_SSLKEYPASSWD
.B CURLOPT_SSLKEYPASSWD
Pass a pointer to a zero terminated string as parameter. It will be used as Pass a pointer to a zero terminated string as parameter. It will be used as
the password required to use the \fICURLOPT_SSLKEY\fP private key. If the the password required to use the \fICURLOPT_SSLKEY\fP private key. If the
password is not supplied, you will be prompted for password is not supplied, you will be prompted for
it. \fICURLOPT_PASSWDFUNCTION\fP can be used to set your own prompt function. it. \fICURLOPT_PASSWDFUNCTION\fP can be used to set your own prompt function.
.TP .IP CURLOPT_SSL_ENGINE
.B CURLOPT_SSL_ENGINE
Pass a pointer to a zero terminated string as parameter. It will be used as Pass a pointer to a zero terminated string as parameter. It will be used as
the identifier for the crypto engine you want to use for your private the identifier for the crypto engine you want to use for your private
key. key.
\fBNOTE:\fPIf the crypto device cannot be loaded, \fBNOTE:\fPIf the crypto device cannot be loaded,
\fICURLE_SSL_ENGINE_NOTFOUND\fP is returned. \fICURLE_SSL_ENGINE_NOTFOUND\fP is returned.
.TP .IP CURLOPT_SSL_ENGINEDEFAULT
.B CURLOPT_SSL_ENGINEDEFAULT
Sets the actual crypto engine as the default for (asymetric) crypto Sets the actual crypto engine as the default for (asymetric) crypto
operations. operations.
\fBNOTE:\fPIf the crypto device cannot be set, \fBNOTE:\fPIf the crypto device cannot be set,
\fICURLE_SSL_ENGINE_SETFAILED\fP is returned. \fICURLE_SSL_ENGINE_SETFAILED\fP is returned.
.TP .IP CURLOPT_SSLVERSION
.B CURLOPT_SSLVERSION
Pass a long as parameter. Set what version of SSL to attempt to use, 2 or Pass a long as parameter. Set what version of SSL to attempt to use, 2 or
3. By default, the SSL library will try to solve this by itself although some 3. By default, the SSL library will try to solve this by itself although some
servers make this difficult why you at times may have to use this option. servers make this difficult why you at times may have to use this option.
.TP .IP CURLOPT_SSL_VERIFYPEER
.B CURLOPT_SSL_VERIFYPEER
Pass a long that is set to a zero value to stop curl from verifying the peer's Pass a long that is set to a zero value to stop curl from verifying the peer's
certificate (7.10 starting setting this option to TRUE by default). Alternate certificate (7.10 starting setting this option to TRUE by default). Alternate
certificates to verify against can be specified with the CURLOPT_CAINFO option certificates to verify against can be specified with the CURLOPT_CAINFO option
@ -873,35 +757,29 @@ or a certificate directory can be specified with the CURLOPT_CAPATH option
(Added in 7.9.8). As of 7.10, curl installs a default bundle. (Added in 7.9.8). As of 7.10, curl installs a default bundle.
CURLOPT_SSL_VERIFYHOST may also need to be set to 1 or 0 if CURLOPT_SSL_VERIFYHOST may also need to be set to 1 or 0 if
CURLOPT_SSL_VERIFYPEER is disabled (it defaults to 2). CURLOPT_SSL_VERIFYPEER is disabled (it defaults to 2).
.TP .IP CURLOPT_CAINFO
.B CURLOPT_CAINFO
Pass a char * to a zero terminated string naming a file holding one or more Pass a char * to a zero terminated string naming a file holding one or more
certificates to verify the peer with. This only makes sense when used in certificates to verify the peer with. This only makes sense when used in
combination with the CURLOPT_SSL_VERIFYPEER option. combination with the CURLOPT_SSL_VERIFYPEER option.
.TP .IP CURLOPT_CAPATH
.B CURLOPT_CAPATH
Pass a char * to a zero terminated string naming a directory holding multiple Pass a char * to a zero terminated string naming a directory holding multiple
CA certificates to verify the peer with. The certificate directory must be CA certificates to verify the peer with. The certificate directory must be
prepared using the openssl c_rehash utility. This only makes sense when used prepared using the openssl c_rehash utility. This only makes sense when used
in combination with the CURLOPT_SSL_VERIFYPEER option. The CAPATH function in combination with the CURLOPT_SSL_VERIFYPEER option. The CAPATH function
apparently does not work in Windows due to some limitation in openssl. (Added apparently does not work in Windows due to some limitation in openssl. (Added
in 7.9.8) in 7.9.8)
.TP .IP CURLOPT_RANDOM_FILE
.B CURLOPT_RANDOM_FILE
Pass a char * to a zero terminated file name. The file will be used to read Pass a char * to a zero terminated file name. The file will be used to read
from to seed the random engine for SSL. The more random the specified file is, from to seed the random engine for SSL. The more random the specified file is,
the more secure the SSL connection will become. the more secure the SSL connection will become.
.TP .IP CURLOPT_EGDSOCKET
.B CURLOPT_EGDSOCKET
Pass a char * to the zero terminated path name to the Entropy Gathering Daemon Pass a char * to the zero terminated path name to the Entropy Gathering Daemon
socket. It will be used to seed the random engine for SSL. socket. It will be used to seed the random engine for SSL.
.TP .IP CURLOPT_SSL_VERIFYHOST
.B CURLOPT_SSL_VERIFYHOST
Pass a long. Set if we should verify the Common name from the peer certificate Pass a long. Set if we should verify the Common name from the peer certificate
in the SSL handshake, set 1 to check existence, 2 to ensure that it matches in the SSL handshake, set 1 to check existence, 2 to ensure that it matches
the provided hostname. This is by default set to 2. (default changed in 7.10) the provided hostname. This is by default set to 2. (default changed in 7.10)
.TP .IP CURLOPT_SSL_CIPHER_LIST
.B CURLOPT_SSL_CIPHER_LIST
Pass a char *, pointing to a zero terminated string holding the list of Pass a char *, pointing to a zero terminated string holding the list of
ciphers to use for the SSL connection. The list must be syntactly correct, it ciphers to use for the SSL connection. The list must be syntactly correct, it
consists of one or more cipher strings separated by colons. Commas or spaces consists of one or more cipher strings separated by colons. Commas or spaces
@ -912,21 +790,17 @@ compile OpenSSL.
You'll find more details about cipher lists on this URL: You'll find more details about cipher lists on this URL:
\fIhttp://www.openssl.org/docs/apps/ciphers.html\fP \fIhttp://www.openssl.org/docs/apps/ciphers.html\fP
.TP .IP CURLOPT_KRB4LEVEL
.B CURLOPT_KRB4LEVEL
Pass a char * as parameter. Set the krb4 security level, this also enables Pass a char * as parameter. Set the krb4 security level, this also enables
krb4 awareness. This is a string, 'clear', 'safe', 'confidential' or krb4 awareness. This is a string, 'clear', 'safe', 'confidential' or
\&'private'. If the string is set but doesn't match one of these, 'private' \&'private'. If the string is set but doesn't match one of these, 'private'
will be used. Set the string to NULL to disable kerberos4. The kerberos will be used. Set the string to NULL to disable kerberos4. The kerberos
support only works for FTP. support only works for FTP.
.PP
.SH OTHER OPTIONS .SH OTHER OPTIONS
.TP 0.4i .IP CURLOPT_PRIVATE
.B CURLOPT_PRIVATE
Pass a char * as parameter, pointing to data that should be associated with Pass a char * as parameter, pointing to data that should be associated with
the curl handle. The pointer can be subsequently retrieved using the the curl handle. The pointer can be subsequently retrieved using the
CURLINFO_PRIVATE options to curl_easy_getinfo. (Added in 7.10.3) CURLINFO_PRIVATE options to curl_easy_getinfo. (Added in 7.10.3)
.PP
.SH RETURN VALUE .SH RETURN VALUE
CURLE_OK (zero) means that the option was set properly, non-zero means an CURLE_OK (zero) means that the option was set properly, non-zero means an
error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl-errors.3\fP error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl-errors.3\fP