docs/libcurl/curl_easy_setopt.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .\"
  23 .TH curl_easy_setopt 3 "25 Jun 2014" "libcurl 7.38.0" "libcurl Manual"
  24 .SH NAME
  25 curl_easy_setopt \- set options for a curl easy handle
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLoption option, parameter);
  30 .SH DESCRIPTION
  31 \fIcurl_easy_setopt(3)\fP is used to tell libcurl how to behave. By setting
  32 the appropriate options, the application can change libcurl's behavior.  All
  33 options are set with an \fIoption\fP followed by a \fIparameter\fP. That
  34 parameter can be a \fBlong\fP, a \fBfunction pointer\fP, an \fBobject
  35 pointer\fP or a \fBcurl_off_t\fP, depending on what the specific option
  36 expects. Read this manual carefully as bad input values may cause libcurl to
  37 behave badly!  You can only set one option in each function call. A typical
  38 application uses many \fIcurl_easy_setopt(3)\fP calls in the setup phase.
  39
  40 Options set with this function call are valid for all forthcoming transfers
  41 performed using this \fIhandle\fP.  The options are not in any way reset
  42 between transfers, so if you want subsequent transfers with different options,
  43 you must change them between the transfers. You can optionally reset all
  44 options back to internal default with \fIcurl_easy_reset(3)\fP.
  45
  46 Strings passed to libcurl as 'char *' arguments, are copied by the library;
  47 thus the string storage associated to the pointer argument may be overwritten
  48 after \fIcurl_easy_setopt(3)\fP returns. The only exception to this rule is
  49 really \fICURLOPT_POSTFIELDS(3)\fP, but the alternative that copies the string
  50 \fICURLOPT_COPYPOSTFIELDS(3)\fP has some usage characteristics you need to
  51 read up on.
  52
  53 The order in which the options are set does not matter.
  54
  55 Before version 7.17.0, strings were not copied. Instead the user was forced
  56 keep them available until libcurl no longer needed them.
  57
  58 The \fIhandle\fP is the return code from a \fIcurl_easy_init(3)\fP or
  59 \fIcurl_easy_duphandle(3)\fP call.
  60 .SH BEHAVIOR OPTIONS
  61 .IP CURLOPT_VERBOSE
  62 Display verbose information. See \fICURLOPT_VERBOSE(3)\fP
  63 .IP CURLOPT_HEADER
  64 Include the header in the body output. See \fICURLOPT_HEADER(3)\fP
  65 .IP CURLOPT_NOPROGRESS
  66 Shut off the progress meter. See \fICURLOPT_NOPROGRESS(3)\fP
  67 .IP CURLOPT_NOSIGNAL
  68 Do not install signal handlers. See \fICURLOPT_NOSIGNAL(3)\fP
  69 .IP CURLOPT_WILDCARDMATCH
  70 Transfer multiple files according to a file name pattern. See \fICURLOPT_WILDCARDMATCH(3)\fP
  71 .SH CALLBACK OPTIONS
  72 .IP CURLOPT_WRITEFUNCTION
  73 Callback for writing data. See \fICURLOPT_WRITEFUNCTION(3)\fP
  74 .IP CURLOPT_WRITEDATA
  75 Data pointer to pass to the write callback. See \fICURLOPT_WRITEDATA(3)\fP
  76 .IP CURLOPT_READFUNCTION
  77 Callback for reading data. See \fICURLOPT_READFUNCTION(3)\fP
  78 .IP CURLOPT_READDATA
  79 Data pointer to pass to the read callback. See \fICURLOPT_READDATA(3)\fP
  80 .IP CURLOPT_IOCTLFUNCTION
  81 Callback for I/O operations. See \fICURLOPT_IOCTLFUNCTION(3)\fP
  82 .IP CURLOPT_IOCTLDATA
  83 Data pointer to pass to the I/O callback. See \fICURLOPT_IOCTLDATA(3)\fP
  84 .IP CURLOPT_SEEKFUNCTION
  85 Callback for seek operations. See \fICURLOPT_SEEKFUNCTION(3)\fP
  86 .IP CURLOPT_SEEKDATA
  87 Data pointer to pass to the seek callback. See \fICURLOPT_SEEKDATA(3)\fP
  88 .IP CURLOPT_SOCKOPTFUNCTION
  89 Callback for sockopt operations. See \fICURLOPT_SOCKOPTFUNCTION(3)\fP
  90 .IP CURLOPT_SOCKOPTDATA
  91 Data pointer to pass to the sockopt callback. See \fICURLOPT_SOCKOPTDATA(3)\fP
  92 .IP CURLOPT_OPENSOCKETFUNCTION
  93 Callback for socket creation. See \fICURLOPT_OPENSOCKETFUNCTION(3)\fP
  94 .IP CURLOPT_OPENSOCKETDATA
  95 Data pointer to pass to the open socket callback. See \fICURLOPT_OPENSOCKETDATA(3)\fP
  96 .IP CURLOPT_CLOSESOCKETFUNCTION
  97 Callback for closing socket. See \fICURLOPT_CLOSESOCKETFUNCTION(3)\fP
  98 .IP CURLOPT_CLOSESOCKETDATA
  99 Data pointer to pass to the close socket callback. See \fICURLOPT_CLOSESOCKETDATA(3)\fP
 100 .IP CURLOPT_PROGRESSFUNCTION
 101 OBSOLETE callback for progress meter. See \fICURLOPT_PROGRESSFUNCTION(3)\fP
 102 .IP CURLOPT_PROGRESSDATA
 103 Data pointer to pass to the progress meter callback. See \fICURLOPT_PROGRESSDATA(3)\fP
 104 .IP CURLOPT_XFERINFOFUNCTION
 105 Callback for progress meter. See \fICURLOPT_XFERINFOFUNCTION(3)\fP
 106 .IP CURLOPT_XFERINFODATA
 107 Data pointer to pass to the progress meter callback. See \fICURLOPT_XFERINFODATA(3)\fP
 108 .IP CURLOPT_HEADERFUNCTION
 109 Callback for writing received headers. See \fICURLOPT_HEADERFUNCTION(3)\fP
 110 .IP CURLOPT_HEADERDATA
 111 Data pointer to pass to the header callback. See \fICURLOPT_HEADERDATA(3)\fP
 112 .IP CURLOPT_DEBUGFUNCTION
 113 Callback for debug information. See \fICURLOPT_DEBUGFUNCTION(3)\fP
 114 .IP CURLOPT_DEBUGDATA
 115 Data pointer to pass to the debug callback. See \fICURLOPT_DEBUGDATA(3)\fP
 116 .IP CURLOPT_SSL_CTX_FUNCTION
 117 Callback for SSL context logic. See \fICURLOPT_SSL_CTX_FUNCTION(3)\fP
 118 .IP CURLOPT_SSL_CTX_DATA
 119 Data pointer to pass to the SSL context callback. See \fICURLOPT_SSL_CTX_DATA(3)\fP
 120 .IP CURLOPT_CONV_TO_NETWORK_FUNCTION
 121 Callback for code base conversion. See \fICURLOPT_CONV_TO_NETWORK_FUNCTION(3)\fP
 122 .IP CURLOPT_CONV_FROM_NETWORK_FUNCTION
 123 Callback for code base conversion. See \fICURLOPT_CONV_FROM_NETWORK_FUNCTION(3)\fP
 124 .IP CURLOPT_CONV_FROM_UTF8_FUNCTION
 125 Callback for code base conversion. See \fICURLOPT_CONV_FROM_UTF8_FUNCTION(3)\fP
 126 .IP CURLOPT_INTERLEAVEFUNCTION
 127 Callback for RTSP interleaved data. See \fICURLOPT_INTERLEAVEFUNCTION(3)\fP
 128 .IP CURLOPT_INTERLEAVEDATA
 129 Data pointer to pass to the RTSP interleave callback. See \fICURLOPT_INTERLEAVEDATA(3)\fP
 130 .IP CURLOPT_CHUNK_BGN_FUNCTION
 131 Callback for wildcard download start of chunk. See \fICURLOPT_CHUNK_BGN_FUNCTION(3)\fP
 132 .IP CURLOPT_CHUNK_END_FUNCTION
 133 Callback for wildcard download end of chunk. See \fICURLOPT_CHUNK_END_FUNCTION(3)\fP
 134 .IP CURLOPT_CHUNK_DATA
 135 Data pointer to pass to the chunk callbacks. See \fICURLOPT_CHUNK_DATA(3)\fP
 136 .IP CURLOPT_FNMATCH_FUNCTION
 137 Callback for wildcard matching. See \fICURLOPT_FNMATCH_FUNCTION(3)\fP
 138 .IP CURLOPT_FNMATCH_DATA
 139 Data pointer to pass to the wildcard matching callback. See \fICURLOPT_FNMATCH_DATA(3)\fP
 140 .SH ERROR OPTIONS
 141 .IP CURLOPT_ERRORBUFFER
 142 Error message buffer. See \fICURLOPT_ERRORBUFFER(3)\fP
 143 .IP CURLOPT_STDERR
 144 stderr replacement stream. See \fICURLOPT_STDERR(3)\fP
 145 .IP CURLOPT_FAILONERROR
 146 Fail on HTTP 4xx errors. \fICURLOPT_FAILONERROR(3)\fP
 147 .IP CURLOPT_KEEP_SENDING_ON_ERROR
 148 Keep sending on HTTP >= 300 errors. \fICURLOPT_KEEP_SENDING_ON_ERROR(3)\fP
 149 .SH NETWORK OPTIONS
 150 .IP CURLOPT_URL
 151 URL to work on. See \fICURLOPT_URL(3)\fP
 152 .IP CURLOPT_PATH_AS_IS
 153 Disable squashing /../ and /./ sequences in the path. See \fICURLOPT_PATH_AS_IS(3)\fP
 154 .IP CURLOPT_PROTOCOLS
 155 Allowed protocols. See \fICURLOPT_PROTOCOLS(3)\fP
 156 .IP CURLOPT_REDIR_PROTOCOLS
 157 Protocols to allow redirects to. See \fICURLOPT_REDIR_PROTOCOLS(3)\fP
 158 .IP CURLOPT_DEFAULT_PROTOCOL
 159 Default protocol. See \fICURLOPT_DEFAULT_PROTOCOL(3)\fP
 160 .IP CURLOPT_PROXY
 161 Proxy to use. See \fICURLOPT_PROXY(3)\fP
 162 .IP CURLOPT_PRE_PROXY
 163 Socks proxy to use. See \fICURLOPT_PRE_PROXY(3)\fP
 164 .IP CURLOPT_PROXYPORT
 165 Proxy port to use. See \fICURLOPT_PROXYPORT(3)\fP
 166 .IP CURLOPT_PROXYTYPE
 167 Proxy type. See \fICURLOPT_PROXYTYPE(3)\fP
 168 .IP CURLOPT_NOPROXY
 169 Filter out hosts from proxy use. \fICURLOPT_NOPROXY(3)\fP
 170 .IP CURLOPT_HTTPPROXYTUNNEL
 171 Tunnel through the HTTP proxy. \fICURLOPT_HTTPPROXYTUNNEL(3)\fP
 172 .IP CURLOPT_CONNECT_TO
 173 Connect to a specific host and port. See \fICURLOPT_CONNECT_TO(3)\fP
 174 .IP CURLOPT_SOCKS5_GSSAPI_SERVICE
 175 Socks5 GSSAPI service name. \fICURLOPT_SOCKS5_GSSAPI_SERVICE(3)\fP
 176 .IP CURLOPT_SOCKS5_GSSAPI_NEC
 177 Socks5 GSSAPI NEC mode. See \fICURLOPT_SOCKS5_GSSAPI_NEC(3)\fP
 178 .IP CURLOPT_PROXY_SERVICE_NAME
 179 Proxy authentication service name. \fICURLOPT_PROXY_SERVICE_NAME(3)\fP
 180 .IP CURLOPT_SERVICE_NAME
 181 Authentication service name. \fICURLOPT_SERVICE_NAME(3)\fP
 182 .IP CURLOPT_INTERFACE
 183 Bind connection locally to this. See \fICURLOPT_INTERFACE(3)\fP
 184 .IP CURLOPT_LOCALPORT
 185 Bind connection locally to this port. See \fICURLOPT_LOCALPORT(3)\fP
 186 .IP CURLOPT_LOCALPORTRANGE
 187 Bind connection locally to port range. See \fICURLOPT_LOCALPORTRANGE(3)\fP
 188 .IP CURLOPT_DNS_CACHE_TIMEOUT
 189 Timeout for DNS cache. See \fICURLOPT_DNS_CACHE_TIMEOUT(3)\fP
 190 .IP CURLOPT_DNS_USE_GLOBAL_CACHE
 191 OBSOLETE Enable global DNS cache. See \fICURLOPT_DNS_USE_GLOBAL_CACHE(3)\fP
 192 .IP CURLOPT_BUFFERSIZE
 193 Ask for alternate buffer size. See \fICURLOPT_BUFFERSIZE(3)\fP
 194 .IP CURLOPT_PORT
 195 Port number to connect to. See \fICURLOPT_PORT(3)\fP
 196 .IP CURLOPT_TCP_FASTOPEN
 197 Enable TFO, TCP Fast Open. See \fICURLOPT_TCP_FASTOPEN(3)\fP
 198 .IP CURLOPT_TCP_NODELAY
 199 Disable the Nagle algorithm. See \fICURLOPT_TCP_NODELAY(3)\fP
 200 .IP CURLOPT_ADDRESS_SCOPE
 201 IPv6 scope for local addresses. See \fICURLOPT_ADDRESS_SCOPE(3)\fP
 202 .IP CURLOPT_TCP_KEEPALIVE
 203 Enable TCP keep-alive. See \fICURLOPT_TCP_KEEPALIVE(3)\fP
 204 .IP CURLOPT_TCP_KEEPIDLE
 205 Idle time before sending keep-alive. See \fICURLOPT_TCP_KEEPIDLE(3)\fP
 206 .IP CURLOPT_TCP_KEEPINTVL
 207 Interval between keep-alive probes. See \fICURLOPT_TCP_KEEPINTVL(3)\fP
 208 .IP CURLOPT_UNIX_SOCKET_PATH
 209 Path to a Unix domain socket. See \fICURLOPT_UNIX_SOCKET_PATH(3)\fP
 210 .IP CURLOPT_ABSTRACT_UNIX_SOCKET
 211 Path to an abstract Unix domain socket. See \fICURLOPT_ABSTRACT_UNIX_SOCKET(3)\fP
 212 .SH NAMES and PASSWORDS OPTIONS (Authentication)
 213 .IP CURLOPT_NETRC
 214 Enable .netrc parsing. See \fICURLOPT_NETRC(3)\fP
 215 .IP CURLOPT_NETRC_FILE
 216 \&.netrc file name. See \fICURLOPT_NETRC_FILE(3)\fP
 217 .IP CURLOPT_USERPWD
 218 User name and password. See \fICURLOPT_USERPWD(3)\fP
 219 .IP CURLOPT_PROXYUSERPWD
 220 Proxy user name and password. See \fICURLOPT_PROXYUSERPWD(3)\fP
 221 .IP CURLOPT_USERNAME
 222 User name. See \fICURLOPT_USERNAME(3)\fP
 223 .IP CURLOPT_PASSWORD
 224 Password. See \fICURLOPT_PASSWORD(3)\fP
 225 .IP CURLOPT_LOGIN_OPTIONS
 226 Login options. See \fICURLOPT_LOGIN_OPTIONS(3)\fP
 227 .IP CURLOPT_PROXYUSERNAME
 228 Proxy user name. See \fICURLOPT_PROXYUSERNAME(3)\fP
 229 .IP CURLOPT_PROXYPASSWORD
 230 Proxy password. See \fICURLOPT_PROXYPASSWORD(3)\fP
 231 .IP CURLOPT_HTTPAUTH
 232 HTTP server authentication methods. See \fICURLOPT_HTTPAUTH(3)\fP
 233 .IP CURLOPT_TLSAUTH_USERNAME
 234 TLS authentication user name. See \fICURLOPT_TLSAUTH_USERNAME(3)\fP
 235 .IP CURLOPT_PROXY_TLSAUTH_USERNAME
 236 Proxy TLS authentication user name. See \fICURLOPT_PROXY_TLSAUTH_USERNAME(3)\fP
 237 .IP CURLOPT_TLSAUTH_PASSWORD
 238 TLS authentication password. See \fICURLOPT_TLSAUTH_PASSWORD(3)\fP
 239 .IP CURLOPT_PROXY_TLSAUTH_PASSWORD
 240 Proxy TLS authentication password. See \fICURLOPT_PROXY_TLSAUTH_PASSWORD(3)\fP
 241 .IP CURLOPT_TLSAUTH_TYPE
 242 TLS authentication methods. See \fICURLOPT_TLSAUTH_TYPE(3)\fP
 243 .IP CURLOPT_PROXY_TLSAUTH_TYPE
 244 Proxy TLS authentication methods. See \fICURLOPT_PROXY_TLSAUTH_TYPE(3)\fP
 245 .IP CURLOPT_PROXYAUTH
 246 HTTP proxy authentication methods. See \fICURLOPT_PROXYAUTH(3)\fP
 247 .IP CURLOPT_SASL_IR
 248 Enable SASL initial response. See \fICURLOPT_SASL_IR(3)\fP
 249 .IP CURLOPT_XOAUTH2_BEARER
 250 OAuth2 bearer token. See \fICURLOPT_XOAUTH2_BEARER(3)\fP
 251 .SH HTTP OPTIONS
 252 .IP CURLOPT_AUTOREFERER
 253 Automatically set Referer: header. See \fICURLOPT_AUTOREFERER(3)\fP
 254 .IP CURLOPT_ACCEPT_ENCODING
 255 Accept-Encoding and automatic decompressing data. See \fICURLOPT_ACCEPT_ENCODING(3)\fP
 256 .IP CURLOPT_TRANSFER_ENCODING
 257 Request Transfer-Encoding. See \fICURLOPT_TRANSFER_ENCODING(3)\fP
 258 .IP CURLOPT_FOLLOWLOCATION
 259 Follow HTTP redirects. See \fICURLOPT_FOLLOWLOCATION(3)\fP
 260 .IP CURLOPT_UNRESTRICTED_AUTH
 261 Do not restrict authentication to original host. \fICURLOPT_UNRESTRICTED_AUTH(3)\fP
 262 .IP CURLOPT_MAXREDIRS
 263 Maximum number of redirects to follow. See \fICURLOPT_MAXREDIRS(3)\fP
 264 .IP CURLOPT_POSTREDIR
 265 How to act on redirects after POST. See \fICURLOPT_POSTREDIR(3)\fP
 266 .IP CURLOPT_PUT
 267 Issue a HTTP PUT request. See \fICURLOPT_PUT(3)\fP
 268 .IP CURLOPT_POST
 269 Issue a HTTP POST request. See \fICURLOPT_POST(3)\fP
 270 .IP CURLOPT_POSTFIELDS
 271 Send a POST with this data. See \fICURLOPT_POSTFIELDS(3)\fP
 272 .IP CURLOPT_POSTFIELDSIZE
 273 The POST data is this big. See \fICURLOPT_POSTFIELDSIZE(3)\fP
 274 .IP CURLOPT_POSTFIELDSIZE_LARGE
 275 The POST data is this big. See \fICURLOPT_POSTFIELDSIZE_LARGE(3)\fP
 276 .IP CURLOPT_COPYPOSTFIELDS
 277 Send a POST with this data - and copy it. See \fICURLOPT_COPYPOSTFIELDS(3)\fP
 278 .IP CURLOPT_HTTPPOST
 279 Multipart formpost HTTP POST. See \fICURLOPT_HTTPPOST(3)\fP
 280 .IP CURLOPT_REFERER
 281 Referer: header. See \fICURLOPT_REFERER(3)\fP
 282 .IP CURLOPT_USERAGENT
 283 User-Agent: header. See \fICURLOPT_USERAGENT(3)\fP
 284 .IP CURLOPT_HTTPHEADER
 285 Custom HTTP headers. See \fICURLOPT_HTTPHEADER(3)\fP
 286 .IP CURLOPT_HEADEROPT
 287 Control custom headers. See \fICURLOPT_HEADEROPT(3)\fP
 288 .IP CURLOPT_PROXYHEADER
 289 Custom HTTP headers sent to proxy. See \fICURLOPT_PROXYHEADER(3)\fP
 290 .IP CURLOPT_HTTP200ALIASES
 291 Alternative versions of 200 OK. See \fICURLOPT_HTTP200ALIASES(3)\fP
 292 .IP CURLOPT_COOKIE
 293 Cookie(s) to send. See \fICURLOPT_COOKIE(3)\fP
 294 .IP CURLOPT_COOKIEFILE
 295 File to read cookies from. See \fICURLOPT_COOKIEFILE(3)\fP
 296 .IP CURLOPT_COOKIEJAR
 297 File to write cookies to. See \fICURLOPT_COOKIEJAR(3)\fP
 298 .IP CURLOPT_COOKIESESSION
 299 Start a new cookie session. See \fICURLOPT_COOKIESESSION(3)\fP
 300 .IP CURLOPT_COOKIELIST
 301 Add or control cookies. See \fICURLOPT_COOKIELIST(3)\fP
 302 .IP CURLOPT_HTTPGET
 303 Do a HTTP GET request. See \fICURLOPT_HTTPGET(3)\fP
 304 .IP CURLOPT_HTTP_VERSION
 305 HTTP version to use. \fICURLOPT_HTTP_VERSION(3)\fP
 306 .IP CURLOPT_IGNORE_CONTENT_LENGTH
 307 Ignore Content-Length. See \fICURLOPT_IGNORE_CONTENT_LENGTH(3)\fP
 308 .IP CURLOPT_HTTP_CONTENT_DECODING
 309 Disable Content decoding. See \fICURLOPT_HTTP_CONTENT_DECODING(3)\fP
 310 .IP CURLOPT_HTTP_TRANSFER_DECODING
 311 Disable Transfer decoding. See \fICURLOPT_HTTP_TRANSFER_DECODING(3)\fP
 312 .IP CURLOPT_EXPECT_100_TIMEOUT_MS
 313 100-continue timeout. See \fICURLOPT_EXPECT_100_TIMEOUT_MS(3)\fP
 314 .IP CURLOPT_PIPEWAIT
 315 Wait on connection to pipeline on it. See \fICURLOPT_PIPEWAIT(3)\fP
 316 .IP CURLOPT_STREAM_DEPENDS
 317 This HTTP/2 stream depends on another. See \fICURLOPT_STREAM_DEPENDS(3)\fP
 318 .IP CURLOPT_STREAM_DEPENDS_E
 319 This HTTP/2 stream depends on another exclusively. See
 320 \fICURLOPT_STREAM_DEPENDS_E(3)\fP
 321 .IP CURLOPT_STREAM_WEIGHT
 322 Set this HTTP/2 stream's weight. See \fICURLOPT_STREAM_WEIGHT(3)\fP
 323 .SH SMTP OPTIONS
 324 .IP CURLOPT_MAIL_FROM
 325 Address of the sender. See \fICURLOPT_MAIL_FROM(3)\fP
 326 .IP CURLOPT_MAIL_RCPT
 327 Address of the recipients. See \fICURLOPT_MAIL_RCPT(3)\fP
 328 .IP CURLOPT_MAIL_AUTH
 329 Authentication address. See \fICURLOPT_MAIL_AUTH(3)\fP
 330 .SH TFTP OPTIONS
 331 .IP CURLOPT_TFTP_BLKSIZE
 332 TFTP block size. See \fICURLOPT_TFTP_BLKSIZE(3)\fP
 333 .IP CURLOPT_TFTP_NO_OPTIONS
 334 Do not send TFTP options requests. See \fICURLOPT_TFTP_NO_OPTIONS(3)\fP
 335 .SH FTP OPTIONS
 336 .IP CURLOPT_FTPPORT
 337 Use active FTP. See \fICURLOPT_FTPPORT(3)\fP
 338 .IP CURLOPT_QUOTE
 339 Commands to run before transfer. See \fICURLOPT_QUOTE(3)\fP
 340 .IP CURLOPT_POSTQUOTE
 341 Commands to run after transfer. See \fICURLOPT_POSTQUOTE(3)\fP
 342 .IP CURLOPT_PREQUOTE
 343 Commands to run just before transfer. See \fICURLOPT_PREQUOTE(3)\fP
 344 .IP CURLOPT_APPEND
 345 Append to remote file. See \fICURLOPT_APPEND(3)\fP
 346 .IP CURLOPT_FTP_USE_EPRT
 347 Use EPTR. See \fICURLOPT_FTP_USE_EPRT(3)\fP
 348 .IP CURLOPT_FTP_USE_EPSV
 349 Use EPSV. See \fICURLOPT_FTP_USE_EPSV(3)\fP
 350 .IP CURLOPT_FTP_USE_PRET
 351 Use PRET. See \fICURLOPT_FTP_USE_PRET(3)\fP
 352 .IP CURLOPT_FTP_CREATE_MISSING_DIRS
 353 Create missing directories on the remote server. See \fICURLOPT_FTP_CREATE_MISSING_DIRS(3)\fP
 354 .IP CURLOPT_FTP_RESPONSE_TIMEOUT
 355 Timeout for FTP responses. See \fICURLOPT_FTP_RESPONSE_TIMEOUT(3)\fP
 356 .IP CURLOPT_FTP_ALTERNATIVE_TO_USER
 357 Alternative to USER. See \fICURLOPT_FTP_ALTERNATIVE_TO_USER(3)\fP
 358 .IP CURLOPT_FTP_SKIP_PASV_IP
 359 Ignore the IP address in the PASV response. See \fICURLOPT_FTP_SKIP_PASV_IP(3)\fP
 360 .IP CURLOPT_FTPSSLAUTH
 361 Control how to do TLS. See \fICURLOPT_FTPSSLAUTH(3)\fP
 362 .IP CURLOPT_FTP_SSL_CCC
 363 Back to non-TLS again after authentication. See \fICURLOPT_FTP_SSL_CCC(3)\fP
 364 .IP CURLOPT_FTP_ACCOUNT
 365 Send ACCT command. See \fICURLOPT_FTP_ACCOUNT(3)\fP
 366 .IP CURLOPT_FTP_FILEMETHOD
 367 Specify how to reach files. See \fICURLOPT_FTP_FILEMETHOD(3)\fP
 368 .SH RTSP OPTIONS
 369 .IP CURLOPT_RTSP_REQUEST
 370 RTSP request. See \fICURLOPT_RTSP_REQUEST(3)\fP
 371 .IP CURLOPT_RTSP_SESSION_ID
 372 RTSP session-id. See \fICURLOPT_RTSP_SESSION_ID(3)\fP
 373 .IP CURLOPT_RTSP_STREAM_URI
 374 RTSP stream URI. See \fICURLOPT_RTSP_STREAM_URI(3)\fP
 375 .IP CURLOPT_RTSP_TRANSPORT
 376 RTSP Transport: header. See \fICURLOPT_RTSP_TRANSPORT(3)\fP
 377 .IP CURLOPT_RTSP_CLIENT_CSEQ
 378 Client CSEQ number. See \fICURLOPT_RTSP_CLIENT_CSEQ(3)\fP
 379 .IP CURLOPT_RTSP_SERVER_CSEQ
 380 CSEQ number for RTSP Server->Client request. See \fICURLOPT_RTSP_SERVER_CSEQ(3)\fP
 381 .SH PROTOCOL OPTIONS
 382 .IP CURLOPT_TRANSFERTEXT
 383 Use text transfer. See \fICURLOPT_TRANSFERTEXT(3)\fP
 384 .IP CURLOPT_PROXY_TRANSFER_MODE
 385 Add transfer mode to URL over proxy. See \fICURLOPT_PROXY_TRANSFER_MODE(3)\fP
 386 .IP CURLOPT_CRLF
 387 Convert newlines. See \fICURLOPT_CRLF(3)\fP
 388 .IP CURLOPT_RANGE
 389 Range requests. See \fICURLOPT_RANGE(3)\fP
 390 .IP CURLOPT_RESUME_FROM
 391 Resume a transfer. See \fICURLOPT_RESUME_FROM(3)\fP
 392 .IP CURLOPT_RESUME_FROM_LARGE
 393 Resume a transfer. See \fICURLOPT_RESUME_FROM_LARGE(3)\fP
 394 .IP CURLOPT_CUSTOMREQUEST
 395 Custom request/method. See \fICURLOPT_CUSTOMREQUEST(3)\fP
 396 .IP CURLOPT_FILETIME
 397 Request file modification date and time. See \fICURLOPT_FILETIME(3)\fP
 398 .IP CURLOPT_DIRLISTONLY
 399 List only. See \fICURLOPT_DIRLISTONLY(3)\fP
 400 .IP CURLOPT_NOBODY
 401 Do not get the body contents. See \fICURLOPT_NOBODY(3)\fP
 402 .IP CURLOPT_INFILESIZE
 403 Size of file to send. \fICURLOPT_INFILESIZE(3)\fP
 404 .IP CURLOPT_INFILESIZE_LARGE
 405 Size of file to send. \fICURLOPT_INFILESIZE_LARGE(3)\fP
 406 .IP CURLOPT_UPLOAD
 407 Upload data. See \fICURLOPT_UPLOAD(3)\fP
 408 .IP CURLOPT_MAXFILESIZE
 409 Maximum file size to get. See \fICURLOPT_MAXFILESIZE(3)\fP
 410 .IP CURLOPT_MAXFILESIZE_LARGE
 411 Maximum file size to get. See \fICURLOPT_MAXFILESIZE_LARGE(3)\fP
 412 .IP CURLOPT_TIMECONDITION
 413 Make a time conditional request. See \fICURLOPT_TIMECONDITION(3)\fP
 414 .IP CURLOPT_TIMEVALUE
 415 Time value for the time conditional request. See \fICURLOPT_TIMEVALUE(3)\fP
 416 .SH CONNECTION OPTIONS
 417 .IP CURLOPT_TIMEOUT
 418 Timeout for the entire request. See \fICURLOPT_TIMEOUT(3)\fP
 419 .IP CURLOPT_TIMEOUT_MS
 420 Millisecond timeout for the entire request. See \fICURLOPT_TIMEOUT_MS(3)\fP
 421 .IP CURLOPT_LOW_SPEED_LIMIT
 422 Low speed limit to abort transfer. See \fICURLOPT_LOW_SPEED_LIMIT(3)\fP
 423 .IP CURLOPT_LOW_SPEED_TIME
 424 Time to be below the speed to trigger low speed abort. See \fICURLOPT_LOW_SPEED_TIME(3)\fP
 425 .IP CURLOPT_MAX_SEND_SPEED_LARGE
 426 Cap the upload speed to this. See \fICURLOPT_MAX_SEND_SPEED_LARGE(3)\fP
 427 .IP CURLOPT_MAX_RECV_SPEED_LARGE
 428 Cap the download speed to this. See \fICURLOPT_MAX_RECV_SPEED_LARGE(3)\fP
 429 .IP CURLOPT_MAXCONNECTS
 430 Maximum number of connections in the connection pool. See \fICURLOPT_MAXCONNECTS(3)\fP
 431 .IP CURLOPT_FRESH_CONNECT
 432 Use a new connection. \fICURLOPT_FRESH_CONNECT(3)\fP
 433 .IP CURLOPT_FORBID_REUSE
 434 Prevent subsequent connections from re-using this. See \fICURLOPT_FORBID_REUSE(3)\fP
 435 .IP CURLOPT_CONNECTTIMEOUT
 436 Timeout for the connection phase. See \fICURLOPT_CONNECTTIMEOUT(3)\fP
 437 .IP CURLOPT_CONNECTTIMEOUT_MS
 438 Millisecond timeout for the connection phase. See \fICURLOPT_CONNECTTIMEOUT_MS(3)\fP
 439 .IP CURLOPT_IPRESOLVE
 440 IP version to resolve to. See \fICURLOPT_IPRESOLVE(3)\fP
 441 .IP CURLOPT_CONNECT_ONLY
 442 Only connect, nothing else. See \fICURLOPT_CONNECT_ONLY(3)\fP
 443 .IP CURLOPT_USE_SSL
 444 Use TLS/SSL. See \fICURLOPT_USE_SSL(3)\fP
 445 .IP CURLOPT_RESOLVE
 446 Provide fixed/fake name resolves. See \fICURLOPT_RESOLVE(3)\fP
 447 .IP CURLOPT_DNS_INTERFACE
 448 Bind name resolves to this interface. See \fICURLOPT_DNS_INTERFACE(3)\fP
 449 .IP CURLOPT_DNS_LOCAL_IP4
 450 Bind name resolves to this IP4 address. See \fICURLOPT_DNS_LOCAL_IP4(3)\fP
 451 .IP CURLOPT_DNS_LOCAL_IP6
 452 Bind name resolves to this IP6 address. See \fICURLOPT_DNS_LOCAL_IP6(3)\fP
 453 .IP CURLOPT_DNS_SERVERS
 454 Preferred DNS servers. See \fICURLOPT_DNS_SERVERS(3)\fP
 455 .IP CURLOPT_ACCEPTTIMEOUT_MS
 456 Timeout for waiting for the server's connect back to be accepted. See \fICURLOPT_ACCEPTTIMEOUT_MS(3)\fP
 457 .SH SSL and SECURITY OPTIONS
 458 .IP CURLOPT_SSLCERT
 459 Client cert. See \fICURLOPT_SSLCERT(3)\fP
 460 .IP CURLOPT_PROXY_SSLCERT
 461 Proxy client cert. See \fICURLOPT_PROXY_SSLCERT(3)\fP
 462 .IP CURLOPT_SSLCERTTYPE
 463 Client cert type.  See \fICURLOPT_SSLCERTTYPE(3)\fP
 464 .IP CURLOPT_PROXY_SSLCERTTYPE
 465 Proxy client cert type.  See \fICURLOPT_PROXY_SSLCERTTYPE(3)\fP
 466 .IP CURLOPT_SSLKEY
 467 Client key. See \fICURLOPT_SSLKEY(3)\fP
 468 .IP CURLOPT_PROXY_SSLKEY
 469 Proxy client key. See \fICURLOPT_PROXY_SSLKEY(3)\fP
 470 .IP CURLOPT_SSLKEYTYPE
 471 Client key type. See \fICURLOPT_SSLKEYTYPE(3)\fP
 472 .IP CURLOPT_PROXY_SSLKEYTYPE
 473 Proxy client key type. See \fICURLOPT_PROXY_SSLKEYTYPE(3)\fP
 474 .IP CURLOPT_KEYPASSWD
 475 Client key password. See \fICURLOPT_KEYPASSWD(3)\fP
 476 .IP CURLOPT_PROXY_KEYPASSWD
 477 Proxy client key password. See \fICURLOPT_PROXY_KEYPASSWD(3)\fP
 478 .IP CURLOPT_SSL_ENABLE_ALPN
 479 Enable use of ALPN. See \fICURLOPT_SSL_ENABLE_ALPN(3)\fP
 480 .IP CURLOPT_SSL_ENABLE_NPN
 481 Enable use of NPN. See \fICURLOPT_SSL_ENABLE_NPN(3)\fP
 482 .IP CURLOPT_SSLENGINE
 483 Use identifier with SSL engine. See \fICURLOPT_SSLENGINE(3)\fP
 484 .IP CURLOPT_SSLENGINE_DEFAULT
 485 Default SSL engine. See \fICURLOPT_SSLENGINE_DEFAULT(3)\fP
 486 .IP CURLOPT_SSL_FALSESTART
 487 Enable TLS False Start. See \fICURLOPT_SSL_FALSESTART(3)\fP
 488 .IP CURLOPT_SSLVERSION
 489 SSL version to use. See \fICURLOPT_SSLVERSION(3)\fP
 490 .IP CURLOPT_PROXY_SSLVERSION
 491 Proxy SSL version to use. See \fICURLOPT_PROXY_SSLVERSION(3)\fP
 492 .IP CURLOPT_SSL_VERIFYHOST
 493 Verify the host name in the SSL certificate. See \fICURLOPT_SSL_VERIFYHOST(3)\fP
 494 .IP CURLOPT_PROXY_SSL_VERIFYHOST
 495 Verify the host name in the proxy SSL certificate. See \fICURLOPT_PROXY_SSL_VERIFYHOST(3)\fP
 496 .IP CURLOPT_SSL_VERIFYPEER
 497 Verify the SSL certificate. See \fICURLOPT_SSL_VERIFYPEER(3)\fP
 498 .IP CURLOPT_PROXY_SSL_VERIFYPEER
 499 Verify the proxy SSL certificate. See \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP
 500 .IP CURLOPT_SSL_VERIFYSTATUS
 501 Verify the SSL certificate's status. See \fICURLOPT_SSL_VERIFYSTATUS(3)\fP
 502 .IP CURLOPT_CAINFO
 503 CA cert bundle. See \fICURLOPT_CAINFO(3)\fP
 504 .IP CURLOPT_PROXY_CAINFO
 505 Proxy CA cert bundle. See \fICURLOPT_PROXY_CAINFO(3)\fP
 506 .IP CURLOPT_ISSUERCERT
 507 Issuer certificate. See \fICURLOPT_ISSUERCERT(3)\fP
 508 .IP CURLOPT_CAPATH
 509 Path to CA cert bundle. See \fICURLOPT_CAPATH(3)\fP
 510 .IP CURLOPT_PROXY_CAPATH
 511 Path to proxy CA cert bundle. See \fICURLOPT_PROXY_CAPATH(3)\fP
 512 .IP CURLOPT_CRLFILE
 513 Certificate Revocation List. See \fICURLOPT_CRLFILE(3)\fP
 514 .IP CURLOPT_PROXY_CRLFILE
 515 Proxy Certificate Revocation List. See \fICURLOPT_PROXY_CRLFILE(3)\fP
 516 .IP CURLOPT_CERTINFO
 517 Extract certificate info. See \fICURLOPT_CERTINFO(3)\fP
 518 .IP CURLOPT_PINNEDPUBLICKEY
 519 Set pinned SSL public key . See \fICURLOPT_PINNEDPUBLICKEY(3)\fP
 520 .IP CURLOPT_PROXY_PINNEDPUBLICKEY
 521 Set the proxy's pinned SSL public key. See
 522 \fICURLOPT_PROXY_PINNEDPUBLICKEY(3)\fP
 523 .IP CURLOPT_RANDOM_FILE
 524 Provide source for entropy random data. See \fICURLOPT_RANDOM_FILE(3)\fP
 525 .IP CURLOPT_EGDSOCKET
 526 Identify EGD socket for entropy. See \fICURLOPT_EGDSOCKET(3)\fP
 527 .IP CURLOPT_SSL_CIPHER_LIST
 528 Ciphers to use. See \fICURLOPT_SSL_CIPHER_LIST(3)\fP
 529 .IP CURLOPT_PROXY_SSL_CIPHER_LIST
 530 Proxy ciphers to use. See \fICURLOPT_PROXY_SSL_CIPHER_LIST(3)\fP
 531 .IP CURLOPT_SSL_SESSIONID_CACHE
 532 Disable SSL session-id cache. See \fICURLOPT_SSL_SESSIONID_CACHE(3)\fP
 533 .IP CURLOPT_SSL_OPTIONS
 534 Control SSL behavior. See \fICURLOPT_SSL_OPTIONS(3)\fP
 535 .IP CURLOPT_PROXY_SSL_OPTIONS
 536 Control proxy SSL behavior. See \fICURLOPT_PROXY_SSL_OPTIONS(3)\fP
 537 .IP CURLOPT_KRBLEVEL
 538 Kerberos security level. See \fICURLOPT_KRBLEVEL(3)\fP
 539 .IP CURLOPT_GSSAPI_DELEGATION
 540 Disable GSS-API delegation. See \fICURLOPT_GSSAPI_DELEGATION(3)\fP
 541 .SH SSH OPTIONS
 542 .IP CURLOPT_SSH_AUTH_TYPES
 543 SSH authentication types. See \fICURLOPT_SSH_AUTH_TYPES(3)\fP
 544 .IP CURLOPT_SSH_HOST_PUBLIC_KEY_MD5
 545 MD5 of host's public key. See \fICURLOPT_SSH_HOST_PUBLIC_KEY_MD5(3)\fP
 546 .IP CURLOPT_SSH_PUBLIC_KEYFILE
 547 File name of public key. See \fICURLOPT_SSH_PUBLIC_KEYFILE(3)\fP
 548 .IP CURLOPT_SSH_PRIVATE_KEYFILE
 549 File name of private key. See \fICURLOPT_SSH_PRIVATE_KEYFILE(3)\fP
 550 .IP CURLOPT_SSH_KNOWNHOSTS
 551 File name with known hosts. See \fICURLOPT_SSH_KNOWNHOSTS(3)\fP
 552 .IP CURLOPT_SSH_KEYFUNCTION
 553 Callback for known hosts handling. See \fICURLOPT_SSH_KEYFUNCTION(3)\fP
 554 .IP CURLOPT_SSH_KEYDATA
 555 Custom pointer to pass to ssh key callback. See \fICURLOPT_SSH_KEYDATA(3)\fP
 556 .SH OTHER OPTIONS
 557 .IP CURLOPT_PRIVATE
 558 Private pointer to store. See \fICURLOPT_PRIVATE(3)\fP
 559 .IP CURLOPT_SHARE
 560 Share object to use. See \fICURLOPT_SHARE(3)\fP
 561 .IP CURLOPT_NEW_FILE_PERMS
 562 Mode for creating new remote files. See \fICURLOPT_NEW_FILE_PERMS(3)\fP
 563 .IP CURLOPT_NEW_DIRECTORY_PERMS
 564 Mode for creating new remote directories. See \fICURLOPT_NEW_DIRECTORY_PERMS(3)\fP
 565 .SH TELNET OPTIONS
 566 .IP CURLOPT_TELNETOPTIONS
 567 TELNET options. See \fICURLOPT_TELNETOPTIONS(3)\fP
 568 .SH RETURN VALUE
 569 \fICURLE_OK\fP (zero) means that the option was set properly, non-zero means an
 570 error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl-errors(3)\fP
 571 man page for the full list with descriptions.
 572
 573 If you try to set an option that libcurl doesn't know about, perhaps because
 574 the library is too old to support it or the option was removed in a recent
 575 version, this function will return \fICURLE_UNKNOWN_OPTION\fP. If support for
 576 the option was disabled at compile-time, it will return
 577 \fICURLE_NOT_BUILT_IN\fP.
 578 .SH EXAMPLE
 579 .nf
 580 CURL *curl = curl_easy_init();
 581 if(curl) {
 582   CURLcode res;
 583   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
 584   res = curl_easy_perform(curl);
 585   curl_easy_cleanup(curl);
 586 }
 587 .fi
 588 .SH "SEE ALSO"
 589 .BR curl_easy_init "(3), " curl_easy_cleanup "(3), " curl_easy_reset "(3), "
 590 .BR curl_easy_getinfo "(3), " curl_multi_setopt "(3), "