CurlOption

This is the FILE * or void * the regular output should be written to.

The full URL to get/put

Port number to connect to, if other than default.

Name of proxy to use.

"name:password" to use when fetching.

"name:password" to use with proxy.

Range to get, specified as an ASCII string.

Specified file stream to upload from (use as input):

Buffer to receive error messages in, must be at least CURL_ERROR_SIZE * bytes big. If this is not used, error messages go to stderr instead:

Function that will be called to store the output (instead of fwrite). The * parameters will use fwrite() syntax, make sure to follow them.

Function that will be called to read the input (instead of fread). The * parameters will use fread() syntax, make sure to follow them.

Time-out the read operation after this amount of seconds

If the CURLOPT_INFILE is used, this can be used to inform libcurl about how large the file being sent really is. That allows better error checking and better verifies that the upload was successful. -1 means unknown size.

For large file support, there is also a _LARGE version of the key which takes an off_t type, allowing platforms with larger off_t sizes to handle larger files. See below for INFILESIZE_LARGE.

POST static input fields.

Set the referrer page (needed by some CGIs)

Set the FTP PORT string (interface name, named or numerical IP address) Use i.e '-' to use default address.

Set the User-Agent string (examined by some CGIs)

Set the "low speed limit"

Set the "low speed time"

Set the continuation offset.

Note there is also a _LARGE version of this key which uses off_t types, allowing for large file offsets on platforms which use larger-than-32-bit off_t's. Look below for RESUME_FROM_LARGE.

Set cookie in request:

This points to a linked list of headers, struct curl_slist kind

This points to a linked list of post entries, struct curl_httppost

name of the file keeping your private SSL-certificate

password for the SSL or SSH private key

send TYPE parameter?

send linked-list of QUOTE commands

send FILE * or void * to store headers to, if you use a callback it is simply passed to the callback unmodified

point to a file to read the initial cookies from, also enables "cookie awareness"

What version to specifically try to use. See CURL_SSLVERSION defines below.

What kind of HTTP time condition to use, see defines

Time to use with the above condition. Specified in number of seconds since 1 Jan 1970

Custom request, for customizing the get command like HTTP: DELETE, TRACE and others FTP: to use a different list command

HTTP request, for odd commands like DELETE, TRACE and others

send linked-list of post-transfer QUOTE commands

Pass a pointer to string of the output using full variable-replacement as described elsewhere.

talk a lot

throw the header out too

shut off the progress meter

use HEAD to get http document

no output on http error codes >= 300

this is an upload

HTTP POST method

return bare names when listing directories

Append instead of overwrite on upload!

Specify whether to read the user+password from the .netrc or the URL. * This must be one of the CURL_NETRC_* enums below.

use Location: Luke!

transfer data in text/ASCII format

HTTP PUT

Function that will be called instead of the internal progress display * function. This function should be defined as the curl_progress_callback * prototype defines.

Data passed to the progress callback

We want the referrer field set automatically when following locations

Port of the proxy, can be set in the proxy string as well with: [host]:[port]

size of the POST input data, if strlen() is not good to use

tunnel non-http operations through a HTTP proxy

Set the interface string to use as outgoing network interface

Set the krb4/5 security level, this also enables krb4/5 awareness. This * is a string, 'clear', 'safe', 'confidential' or 'private'. If the string * is set but doesn't match one of these, 'private' will be used.

Set if we should verify the peer in ssl handshake, set 1 to verify.

The CApath or CAfile used to validate the peer certificate this option is used only if SSL_VERIFYPEER is true

Maximum number of http redirects to follow

Pass a long set to 1 to get the date of the requested document (if possible)! Pass a zero to shut it off.

This points to a linked list of telnet options

Max amount of cached alive connections

What policy to use when closing connections when the cache is filled up

Set to explicitly use a new connection for the upcoming transfer. Do not use this unless you're absolutely sure of this, as it makes the operation slower and is less friendly for the network.

Set to explicitly forbid the upcoming transfer's connection to be re-used when done. Do not use this unless you're absolutely sure of this, as it makes the operation slower and is less friendly for the network.

Set to a file name that contains random data for libcurl to use to seed the random engine when doing SSL connects.

Set to the Entropy Gathering Daemon socket pathname

Time-out connect operations after this amount of seconds, if connects are OK within this time, then fine... This only aborts the connect phase. [Only works on unix-style/SIGALRM operating systems]

Function that will be called to store headers (instead of fwrite). The * parameters will use fwrite() syntax, make sure to follow them.

Set this to force the HTTP request to get back to GET. Only really usable if POST, PUT or a custom request have been used first.

Set if we should verify the Common name from the peer certificate in ssl * handshake, set 1 to check existence, 2 to ensure that it matches the * provided hostname.

Specify which file name to write all known cookies in after completed operation. Set file name to "-" (dash) to make it go to stdout.

Specify which SSL ciphers to use

Specify which HTTP version to use! This must be set to one of the CURL_HTTP_VERSION* enums set below.

Specifically switch on or off the FTP engine's use of the EPSV command. By default, that one will always be attempted before the more traditional PASV command.

type of the file keeping your SSL-certificate ("DER", "PEM", "ENG")

name of the file keeping your private SSL-key

type of the file keeping your private SSL-key ("DER", "PEM", "ENG")

crypto engine for the SSL-sub system

set the crypto engine for the SSL-sub system as default the param has no meaning...

Non-zero value means to use the global dns cache

DNS cache timeout

send linked-list of pre-transfer QUOTE commands

set the debug function

set the data for the debug function

mark this as start of a cookie session

The CApath directory used to validate the peer certificate this option is used only if SSL_VERIFYPEER is true

Instruct libcurl to use a smaller receive buffer

Instruct libcurl to not use any signal/alarm handlers, even when using timeouts. This option is useful for multi-threaded applications. See libcurl-the-guide for more background information.

Provide a CURLShare for mutexing non-ts data

indicates type of proxy. accepted values are CURLPROXY_HTTP (default), CURLPROXY_SOCKS4, CURLPROXY_SOCKS4A and CURLPROXY_SOCKS5.

Set the Accept-Encoding string. Use this to tell a server you would like the response to be compressed.

Set pointer to private data

Set aliases for HTTP 200 in the HTTP Response header

Continue to send authentication (user+password) when following locations, even when hostname changed. This can potentially send off the name and password to whatever host the server decides.

Specifically switch on or off the FTP engine's use of the EPRT command ( it also disables the LPRT attempt). By default, those ones will always be attempted before the good old traditional PORT command.

Set this to a bitmask value to enable the particular authentications methods you like. Use this in combination with CURLOPT_USERPWD. Note that setting multiple bits may cause extra network round-trips.

Set the ssl context callback function, currently only for OpenSSL ssl_ctx in second argument. The function must be matching the curl_ssl_ctx_callback proto.

Set the userdata for the ssl context callback function's third argument

FTP Option that causes missing dirs to be created on the remote server. In 7.19.4 we introduced the convenience enums for this option using the CURLFTP_CREATE_DIR prefix.

Set this to a bitmask value to enable the particular authentications methods you like. Use this in combination with CURLOPT_PROXYUSERPWD. Note that setting multiple bits may cause extra network round-trips.

FTP option that changes the timeout, in seconds, associated with getting a response. This is different from transfer timeout time and essentially places a demand on the FTP server to acknowledge commands in a timely manner.

Set this option to one of the CURL_IPRESOLVE_* defines (see below) to tell libcurl to resolve names to those IP versions only. This only has affect on systems with support for more than one, i.e IPv4 _and_ IPv6.

Set this option to limit the size of a file that will be downloaded from an HTTP or FTP server.

Note there is also _LARGE version which adds large file support for platforms which have larger off_t sizes. See MAXFILESIZE_LARGE below.

See the comment for INFILESIZE above, but in short, specifies the size of the file being uploaded. -1 means unknown.

Sets the continuation offset. There is also a LONG version of this; look above for RESUME_FROM.

Sets the maximum size of data that will be downloaded from an HTTP or FTP server. See MAXFILESIZE above for the LONG version.

Set this option to the file name of your .netrc file you want libcurl to parse (using the CURLOPT_NETRC option). If not set, libcurl will do a poor attempt to find the user's home directory and check for a .netrc file in there.

Enable SSL/TLS for FTP, pick one of: CURLFTPSSL_TRY - try using SSL, proceed anyway otherwise CURLFTPSSL_CONTROL - SSL for the control connection or fail CURLFTPSSL_ALL - SSL for all communication or fail

The _LARGE version of the standard POSTFIELDSIZE option

Enable/disable the TCP Nagle algorithm

When FTP over SSL/TLS is selected (with CURLOPT_USE_SSL), this option can be used to change libcurl's default action which is to first try "AUTH SSL" and then "AUTH TLS" in this order, and proceed when a OK response has been received.

Available parameters are: CURLFTPAUTH_DEFAULT - let libcurl decide CURLFTPAUTH_SSL - try "AUTH SSL" first, then TLS CURLFTPAUTH_TLS - try "AUTH TLS" first, then SSL

zero terminated string for pass on to the FTP server when asked for "account" info

feed cookies into cookie engine

ignore Content-Length

Set to non-zero to skip the IP address received in a 227 PASV FTP server response. Typically used for FTP-SSL purposes but is not restricted to that. libcurl will then instead use the same IP address it used for the control connection.

Select "file method" to use when doing FTP, see the curl_ftpmethod above.

Local port number to bind the socket to

Number of ports to try, including the first one set with LOCALPORT. Thus, setting it to 1 will make no additional attempts but the first.

no transfer, set up connection and let application use the socket by extracting it with CURLINFO_LASTSOCKET

Function that will be called to convert from the network encoding (instead of using the iconv calls in libcurl)

Function that will be called to convert to the network encoding (instead of using the iconv calls in libcurl)

Function that will be called to convert from UTF8 (instead of using the iconv calls in libcurl) Note that this is used only for SSL certificate processing

limit-rate: maximum number of bytes per second to send or receive

ditto

Pointer to command string to send if USER/PASS fails.

callback function for setting socket options

set to 0 to disable session ID re-use for this transfer, default is enabled (== 1)

allowed SSH authentication methods

Used by scp/sftp to do public/private key authentication

Send CCC (Clear Command Channel) after authentication

Same as TIMEOUT and CONNECTTIMEOUT, but with ms resolution

ditto

set to zero to disable the libcurl's decoding and thus pass the raw body data to the application even when it is encoded/compressed

ditto

Permission used when creating new files and directories on the remote server for protocols that support it, SFTP/SCP/FILE

ditto

Set the behaviour of POST when redirecting. Values must be set to one of CURL_REDIR* defines below. This used to be called CURLOPT_POST301

used by scp/sftp to verify the host's public key

Callback function for opening socket (instead of socket(2)). Optionally, callback is able change the address or refuse to connect returning CURL_SOCKET_BAD. The callback should have type curl_opensocket_callback

ditto

POST volatile input fields.

set transfer mode (;type=<a|i>) when doing FTP via an HTTP proxy

Callback function for seeking in the input stream

ditto

CRL file

Issuer certificate

(IPv6) Address scope

Collect certificate chain info and allow it to get retrievable with CURLINFO_CERTINFO after the transfer is complete. (Unfortunately) only working with OpenSSL-powered builds.

"name" and "pwd" to use when fetching.

ditto

"name" and "pwd" to use with Proxy when fetching.

ditto

Comma separated list of hostnames defining no-proxy zones. These should match both hostnames directly, and hostnames within a domain. For example, local.com will match local.com and www.local.com, but NOT notlocal.com or www.notlocal.com. For compatibility with other implementations of this, .local.com will be considered to be the same as local.com. A single * is the only valid wildcard, and effectively disables the use of proxy.

block size for TFTP transfers

Socks Service

Socks Service

set the bitmask for the protocols that are allowed to be used for the transfer, which thus helps the app which takes URLs from users or other external inputs and want to restrict what protocol(s) to deal with. Defaults to CURLPROTO_ALL.

set the bitmask for the protocols that libcurl is allowed to follow to, as a subset of the CURLOPT_PROTOCOLS ones. That means the protocol needs to be set in both bitmasks to be allowed to get redirected to. Defaults to all protocols except FILE and SCP.

set the SSH knownhost file name to use

set the SSH host key callback, must point to a curl_sshkeycallback function

set the SSH host key callback custom pointer

set the SMTP mail originator

set the SMTP mail receiver(s)

FTP: send PRET before PASV

RTSP request method (OPTIONS, SETUP, PLAY, etc...)

The RTSP session identifier

The RTSP stream URI

The Transport: header to use in RTSP requests

Manually initialize the client RTSP CSeq for this handle

Manually initialize the server RTSP CSeq for this handle

The stream to pass to INTERLEAVEFUNCTION.

Let the application define a custom write method for RTP data

Turn on wildcard matching

Directory matching callback called before downloading of an individual file (chunk) started

Directory matching callback called after the file (chunk) was downloaded, or skipped

Change match (fnmatch-like) callback for wildcard matching

Let the application define custom chunk data pointer

FNMATCH_FUNCTION user pointer

send linked-list of name:port:address sets

Set a username for authenticated TLS

Set a password for authenticated TLS

Set authentication type for authenticated TLS

the last unused

convenient alias

ditto

ditto

ditto