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 .SH NETWORK OPTIONS
 148 .IP CURLOPT_URL
 149 URL to work on. See \fICURLOPT_URL(3)\fP
 150 .IP CURLOPT_PATH_AS_IS
 151 Disable squashing /../ and /./ sequences in the path. See \fICURLOPT_PATH_AS_IS(3)\fP
 152 .IP CURLOPT_PROTOCOLS
 153 Allowed protocols. See \fICURLOPT_PROTOCOLS(3)\fP
 154 .IP CURLOPT_REDIR_PROTOCOLS
 155 Protocols to allow redirects to. See \fICURLOPT_REDIR_PROTOCOLS(3)\fP
 156 .IP CURLOPT_DEFAULT_PROTOCOL
 157 Default protocol. See \fICURLOPT_DEFAULT_PROTOCOL(3)\fP
 158 .IP CURLOPT_PROXY
 159 Proxy to use. See \fICURLOPT_PROXY(3)\fP
 160 .IP CURLOPT_PROXYPORT
 161 Proxy port to use. See \fICURLOPT_PROXYPORT(3)\fP
 162 .IP CURLOPT_PROXYTYPE
 163 Proxy type. See \fICURLOPT_PROXYTYPE(3)\fP
 164 .IP CURLOPT_NOPROXY
 165 Filter out hosts from proxy use. \fICURLOPT_NOPROXY(3)\fP
 166 .IP CURLOPT_HTTPPROXYTUNNEL
 167 Tunnel through the HTTP proxy. \fICURLOPT_HTTPPROXYTUNNEL(3)\fP
 168 .IP CURLOPT_CONNECT_TO
 169 Connect to a specific host and port. See \fICURLOPT_CONNECT_TO(3)\fP
 170 .IP CURLOPT_SOCKS5_GSSAPI_SERVICE
 171 Socks5 GSSAPI service name. \fICURLOPT_SOCKS5_GSSAPI_SERVICE(3)\fP
 172 .IP CURLOPT_SOCKS5_GSSAPI_NEC
 173 Socks5 GSSAPI NEC mode. See \fICURLOPT_SOCKS5_GSSAPI_NEC(3)\fP
 174 .IP CURLOPT_PROXY_SERVICE_NAME
 175 Proxy authentication service name. \fICURLOPT_PROXY_SERVICE_NAME(3)\fP
 176 .IP CURLOPT_SERVICE_NAME
 177 Authentication service name. \fICURLOPT_SERVICE_NAME(3)\fP
 178 .IP CURLOPT_INTERFACE
 179 Bind connection locally to this. See \fICURLOPT_INTERFACE(3)\fP
 180 .IP CURLOPT_LOCALPORT
 181 Bind connection locally to this port. See \fICURLOPT_LOCALPORT(3)\fP
 182 .IP CURLOPT_LOCALPORTRANGE
 183 Bind connection locally to port range. See \fICURLOPT_LOCALPORTRANGE(3)\fP
 184 .IP CURLOPT_DNS_CACHE_TIMEOUT
 185 Timeout for DNS cache. See \fICURLOPT_DNS_CACHE_TIMEOUT(3)\fP
 186 .IP CURLOPT_DNS_USE_GLOBAL_CACHE
 187 OBSOLETE Enable global DNS cache. See \fICURLOPT_DNS_USE_GLOBAL_CACHE(3)\fP
 188 .IP CURLOPT_BUFFERSIZE
 189 Ask for smaller buffer size. See \fICURLOPT_BUFFERSIZE(3)\fP
 190 .IP CURLOPT_PORT
 191 Port number to connect to. See \fICURLOPT_PORT(3)\fP
 192 .IP CURLOPT_TCP_FASTOPEN
 193 Enable TFO, TCP Fast Open. See \fICURLOPT_TCP_FASTOPEN(3)\fP
 194 .IP CURLOPT_TCP_NODELAY
 195 Disable the Nagle algorithm. See \fICURLOPT_TCP_NODELAY(3)\fP
 196 .IP CURLOPT_ADDRESS_SCOPE
 197 IPv6 scope for local addresses. See \fICURLOPT_ADDRESS_SCOPE(3)\fP
 198 .IP CURLOPT_TCP_KEEPALIVE
 199 Enable TCP keep-alive. See \fICURLOPT_TCP_KEEPALIVE(3)\fP
 200 .IP CURLOPT_TCP_KEEPIDLE
 201 Idle time before sending keep-alive. See \fICURLOPT_TCP_KEEPIDLE(3)\fP
 202 .IP CURLOPT_TCP_KEEPINTVL
 203 Interval between keep-alive probes. See \fICURLOPT_TCP_KEEPINTVL(3)\fP
 204 .IP CURLOPT_UNIX_SOCKET_PATH
 205 Path to a Unix domain socket. See \fICURLOPT_UNIX_SOCKET_PATH(3)\fP
 206 .SH NAMES and PASSWORDS OPTIONS (Authentication)
 207 .IP CURLOPT_NETRC
 208 Enable .netrc parsing. See \fICURLOPT_NETRC(3)\fP
 209 .IP CURLOPT_NETRC_FILE
 210 \&.netrc file name. See \fICURLOPT_NETRC_FILE(3)\fP
 211 .IP CURLOPT_USERPWD
 212 User name and password. See \fICURLOPT_USERPWD(3)\fP
 213 .IP CURLOPT_PROXYUSERPWD
 214 Proxy user name and password. See \fICURLOPT_PROXYUSERPWD(3)\fP
 215 .IP CURLOPT_USERNAME
 216 User name. See \fICURLOPT_USERNAME(3)\fP
 217 .IP CURLOPT_PASSWORD
 218 Password. See \fICURLOPT_PASSWORD(3)\fP
 219 .IP CURLOPT_LOGIN_OPTIONS
 220 Login options. See \fICURLOPT_LOGIN_OPTIONS(3)\fP
 221 .IP CURLOPT_PROXYUSERNAME
 222 Proxy user name. See \fICURLOPT_PROXYUSERNAME(3)\fP
 223 .IP CURLOPT_PROXYPASSWORD
 224 Proxy password. See \fICURLOPT_PROXYPASSWORD(3)\fP
 225 .IP CURLOPT_HTTPAUTH
 226 HTTP server authentication methods. See \fICURLOPT_HTTPAUTH(3)\fP
 227 .IP CURLOPT_TLSAUTH_USERNAME
 228 TLS authentication user name. See \fICURLOPT_TLSAUTH_USERNAME(3)\fP
 229 .IP CURLOPT_TLSAUTH_PASSWORD
 230 TLS authentication password. See \fICURLOPT_TLSAUTH_PASSWORD(3)\fP
 231 .IP CURLOPT_TLSAUTH_TYPE
 232 TLS authentication methods. See \fICURLOPT_TLSAUTH_TYPE(3)\fP
 233 .IP CURLOPT_PROXYAUTH
 234 HTTP proxy authentication methods. See \fICURLOPT_PROXYAUTH(3)\fP
 235 .IP CURLOPT_SASL_IR
 236 Enable SASL initial response. See \fICURLOPT_SASL_IR(3)\fP
 237 .IP CURLOPT_XOAUTH2_BEARER
 238 OAuth2 bearer token. See \fICURLOPT_XOAUTH2_BEARER(3)\fP
 239 .SH HTTP OPTIONS
 240 .IP CURLOPT_AUTOREFERER
 241 Automatically set Referer: header. See \fICURLOPT_AUTOREFERER(3)\fP
 242 .IP CURLOPT_ACCEPT_ENCODING
 243 Accept-Encoding and automatic decompressing data. See \fICURLOPT_ACCEPT_ENCODING(3)\fP
 244 .IP CURLOPT_TRANSFER_ENCODING
 245 Request Transfer-Encoding. See \fICURLOPT_TRANSFER_ENCODING(3)\fP
 246 .IP CURLOPT_FOLLOWLOCATION
 247 Follow HTTP redirects. See \fICURLOPT_FOLLOWLOCATION(3)\fP
 248 .IP CURLOPT_UNRESTRICTED_AUTH
 249 Do not restrict authentication to original host. \fICURLOPT_UNRESTRICTED_AUTH(3)\fP
 250 .IP CURLOPT_MAXREDIRS
 251 Maximum number of redirects to follow. See \fICURLOPT_MAXREDIRS(3)\fP
 252 .IP CURLOPT_POSTREDIR
 253 How to act on redirects after POST. See \fICURLOPT_POSTREDIR(3)\fP
 254 .IP CURLOPT_PUT
 255 Issue a HTTP PUT request. See \fICURLOPT_PUT(3)\fP
 256 .IP CURLOPT_POST
 257 Issue a HTTP POST request. See \fICURLOPT_POST(3)\fP
 258 .IP CURLOPT_POSTFIELDS
 259 Send a POST with this data. See \fICURLOPT_POSTFIELDS(3)\fP
 260 .IP CURLOPT_POSTFIELDSIZE
 261 The POST data is this big. See \fICURLOPT_POSTFIELDSIZE(3)\fP
 262 .IP CURLOPT_POSTFIELDSIZE_LARGE
 263 The POST data is this big. See \fICURLOPT_POSTFIELDSIZE_LARGE(3)\fP
 264 .IP CURLOPT_COPYPOSTFIELDS
 265 Send a POST with this data - and copy it. See \fICURLOPT_COPYPOSTFIELDS(3)\fP
 266 .IP CURLOPT_HTTPPOST
 267 Multipart formpost HTTP POST. See \fICURLOPT_HTTPPOST(3)\fP
 268 .IP CURLOPT_REFERER
 269 Referer: header. See \fICURLOPT_REFERER(3)\fP
 270 .IP CURLOPT_USERAGENT
 271 User-Agent: header. See \fICURLOPT_USERAGENT(3)\fP
 272 .IP CURLOPT_HTTPHEADER
 273 Custom HTTP headers. See \fICURLOPT_HTTPHEADER(3)\fP
 274 .IP CURLOPT_HEADEROPT
 275 Control custom headers. See \fICURLOPT_HEADEROPT(3)\fP
 276 .IP CURLOPT_PROXYHEADER
 277 Custom HTTP headers sent to proxy. See \fICURLOPT_PROXYHEADER(3)\fP
 278 .IP CURLOPT_HTTP200ALIASES
 279 Alternative versions of 200 OK. See \fICURLOPT_HTTP200ALIASES(3)\fP
 280 .IP CURLOPT_COOKIE
 281 Cookie(s) to send. See \fICURLOPT_COOKIE(3)\fP
 282 .IP CURLOPT_COOKIEFILE
 283 File to read cookies from. See \fICURLOPT_COOKIEFILE(3)\fP
 284 .IP CURLOPT_COOKIEJAR
 285 File to write cookies to. See \fICURLOPT_COOKIEJAR(3)\fP
 286 .IP CURLOPT_COOKIESESSION
 287 Start a new cookie session. See \fICURLOPT_COOKIESESSION(3)\fP
 288 .IP CURLOPT_COOKIELIST
 289 Add or control cookies. See \fICURLOPT_COOKIELIST(3)\fP
 290 .IP CURLOPT_HTTPGET
 291 Do a HTTP GET request. See \fICURLOPT_HTTPGET(3)\fP
 292 .IP CURLOPT_HTTP_VERSION
 293 HTTP version to use. \fICURLOPT_HTTP_VERSION(3)\fP
 294 .IP CURLOPT_IGNORE_CONTENT_LENGTH
 295 Ignore Content-Length. See \fICURLOPT_IGNORE_CONTENT_LENGTH(3)\fP
 296 .IP CURLOPT_HTTP_CONTENT_DECODING
 297 Disable Content decoding. See \fICURLOPT_HTTP_CONTENT_DECODING(3)\fP
 298 .IP CURLOPT_HTTP_TRANSFER_DECODING
 299 Disable Transfer decoding. See \fICURLOPT_HTTP_TRANSFER_DECODING(3)\fP
 300 .IP CURLOPT_EXPECT_100_TIMEOUT_MS
 301 100-continue timeout. See \fICURLOPT_EXPECT_100_TIMEOUT_MS(3)\fP
 302 .IP CURLOPT_PIPEWAIT
 303 Wait on connection to pipeline on it. See \fICURLOPT_PIPEWAIT(3)\fP
 304 .IP CURLOPT_STREAM_DEPENDS
 305 This HTTP/2 stream depends on another. See \fICURLOPT_STREAM_DEPENDS(3)\fP
 306 .IP CURLOPT_STREAM_DEPENDS_E
 307 This HTTP/2 stream depends on another exclusively. See
 308 \fICURLOPT_STREAM_DEPENDS_E(3)\fP
 309 .IP CURLOPT_STREAM_WEIGHT
 310 Set this HTTP/2 stream's weight. See \fICURLOPT_STREAM_WEIGHT(3)\fP
 311 .SH SMTP OPTIONS
 312 .IP CURLOPT_MAIL_FROM
 313 Address of the sender. See \fICURLOPT_MAIL_FROM(3)\fP
 314 .IP CURLOPT_MAIL_RCPT
 315 Address of the recipients. See \fICURLOPT_MAIL_RCPT(3)\fP
 316 .IP CURLOPT_MAIL_AUTH
 317 Authentication address. See \fICURLOPT_MAIL_AUTH(3)\fP
 318 .SH TFTP OPTIONS
 319 .IP CURLOPT_TFTP_BLKSIZE
 320 TFTP block size. See \fICURLOPT_TFTP_BLKSIZE(3)\fP
 321 .IP CURLOPT_TFTP_NO_OPTIONS
 322 Do not send TFTP options requests. See \fICURLOPT_TFTP_NO_OPTIONS(3)\fP
 323 .SH FTP OPTIONS
 324 .IP CURLOPT_FTPPORT
 325 Use active FTP. See \fICURLOPT_FTPPORT(3)\fP
 326 .IP CURLOPT_QUOTE
 327 Commands to run before transfer. See \fICURLOPT_QUOTE(3)\fP
 328 .IP CURLOPT_POSTQUOTE
 329 Commands to run after transfer. See \fICURLOPT_POSTQUOTE(3)\fP
 330 .IP CURLOPT_PREQUOTE
 331 Commands to run just before transfer. See \fICURLOPT_PREQUOTE(3)\fP
 332 .IP CURLOPT_APPEND
 333 Append to remote file. See \fICURLOPT_APPEND(3)\fP
 334 .IP CURLOPT_FTP_USE_EPRT
 335 Use EPTR. See \fICURLOPT_FTP_USE_EPRT(3)\fP
 336 .IP CURLOPT_FTP_USE_EPSV
 337 Use EPSV. See \fICURLOPT_FTP_USE_EPSV(3)\fP
 338 .IP CURLOPT_FTP_USE_PRET
 339 Use PRET. See \fICURLOPT_FTP_USE_PRET(3)\fP
 340 .IP CURLOPT_FTP_CREATE_MISSING_DIRS
 341 Create missing directories on the remote server. See \fICURLOPT_FTP_CREATE_MISSING_DIRS(3)\fP
 342 .IP CURLOPT_FTP_RESPONSE_TIMEOUT
 343 Timeout for FTP responses. See \fICURLOPT_FTP_RESPONSE_TIMEOUT(3)\fP
 344 .IP CURLOPT_FTP_ALTERNATIVE_TO_USER
 345 Alternative to USER. See \fICURLOPT_FTP_ALTERNATIVE_TO_USER(3)\fP
 346 .IP CURLOPT_FTP_SKIP_PASV_IP
 347 Ignore the IP address in the PASV response. See \fICURLOPT_FTP_SKIP_PASV_IP(3)\fP
 348 .IP CURLOPT_FTPSSLAUTH
 349 Control how to do TLS. See \fICURLOPT_FTPSSLAUTH(3)\fP
 350 .IP CURLOPT_FTP_SSL_CCC
 351 Back to non-TLS again after authentication. See \fICURLOPT_FTP_SSL_CCC(3)\fP
 352 .IP CURLOPT_FTP_ACCOUNT
 353 Send ACCT command. See \fICURLOPT_FTP_ACCOUNT(3)\fP
 354 .IP CURLOPT_FTP_FILEMETHOD
 355 Specify how to reach files. See \fICURLOPT_FTP_FILEMETHOD(3)\fP
 356 .SH RTSP OPTIONS
 357 .IP CURLOPT_RTSP_REQUEST
 358 RTSP request. See \fICURLOPT_RTSP_REQUEST(3)\fP
 359 .IP CURLOPT_RTSP_SESSION_ID
 360 RTSP session-id. See \fICURLOPT_RTSP_SESSION_ID(3)\fP
 361 .IP CURLOPT_RTSP_STREAM_URI
 362 RTSP stream URI. See \fICURLOPT_RTSP_STREAM_URI(3)\fP
 363 .IP CURLOPT_RTSP_TRANSPORT
 364 RTSP Transport: header. See \fICURLOPT_RTSP_TRANSPORT(3)\fP
 365 .IP CURLOPT_RTSP_CLIENT_CSEQ
 366 Client CSEQ number. See \fICURLOPT_RTSP_CLIENT_CSEQ(3)\fP
 367 .IP CURLOPT_RTSP_SERVER_CSEQ
 368 CSEQ number for RTSP Server->Client request. See \fICURLOPT_RTSP_SERVER_CSEQ(3)\fP
 369 .SH PROTOCOL OPTIONS
 370 .IP CURLOPT_TRANSFERTEXT
 371 Use text transfer. See \fICURLOPT_TRANSFERTEXT(3)\fP
 372 .IP CURLOPT_PROXY_TRANSFER_MODE
 373 Add transfer mode to URL over proxy. See \fICURLOPT_PROXY_TRANSFER_MODE(3)\fP
 374 .IP CURLOPT_CRLF
 375 Convert newlines. See \fICURLOPT_CRLF(3)\fP
 376 .IP CURLOPT_RANGE
 377 Range requests. See \fICURLOPT_RANGE(3)\fP
 378 .IP CURLOPT_RESUME_FROM
 379 Resume a transfer. See \fICURLOPT_RESUME_FROM(3)\fP
 380 .IP CURLOPT_RESUME_FROM_LARGE
 381 Resume a transfer. See \fICURLOPT_RESUME_FROM_LARGE(3)\fP
 382 .IP CURLOPT_CUSTOMREQUEST
 383 Custom request/method. See \fICURLOPT_CUSTOMREQUEST(3)\fP
 384 .IP CURLOPT_FILETIME
 385 Request file modification date and time. See \fICURLOPT_FILETIME(3)\fP
 386 .IP CURLOPT_DIRLISTONLY
 387 List only. See \fICURLOPT_DIRLISTONLY(3)\fP
 388 .IP CURLOPT_NOBODY
 389 Do not get the body contents. See \fICURLOPT_NOBODY(3)\fP
 390 .IP CURLOPT_INFILESIZE
 391 Size of file to send. \fICURLOPT_INFILESIZE(3)\fP
 392 .IP CURLOPT_INFILESIZE_LARGE
 393 Size of file to send. \fICURLOPT_INFILESIZE_LARGE(3)\fP
 394 .IP CURLOPT_UPLOAD
 395 Upload data. See \fICURLOPT_UPLOAD(3)\fP
 396 .IP CURLOPT_MAXFILESIZE
 397 Maximum file size to get. See \fICURLOPT_MAXFILESIZE(3)\fP
 398 .IP CURLOPT_MAXFILESIZE_LARGE
 399 Maximum file size to get. See \fICURLOPT_MAXFILESIZE_LARGE(3)\fP
 400 .IP CURLOPT_TIMECONDITION
 401 Make a time conditional request. See \fICURLOPT_TIMECONDITION(3)\fP
 402 .IP CURLOPT_TIMEVALUE
 403 Time value for the time conditional request. See \fICURLOPT_TIMEVALUE(3)\fP
 404 .SH CONNECTION OPTIONS
 405 .IP CURLOPT_TIMEOUT
 406 Timeout for the entire request. See \fICURLOPT_TIMEOUT(3)\fP
 407 .IP CURLOPT_TIMEOUT_MS
 408 Millisecond timeout for the entire request. See \fICURLOPT_TIMEOUT_MS(3)\fP
 409 .IP CURLOPT_LOW_SPEED_LIMIT
 410 Low speed limit to abort transfer. See \fICURLOPT_LOW_SPEED_LIMIT(3)\fP
 411 .IP CURLOPT_LOW_SPEED_TIME
 412 Time to be below the speed to trigger low speed abort. See \fICURLOPT_LOW_SPEED_TIME(3)\fP
 413 .IP CURLOPT_MAX_SEND_SPEED_LARGE
 414 Cap the upload speed to this. See \fICURLOPT_MAX_SEND_SPEED_LARGE(3)\fP
 415 .IP CURLOPT_MAX_RECV_SPEED_LARGE
 416 Cap the download speed to this. See \fICURLOPT_MAX_RECV_SPEED_LARGE(3)\fP
 417 .IP CURLOPT_MAXCONNECTS
 418 Maximum number of connections in the connection pool. See \fICURLOPT_MAXCONNECTS(3)\fP
 419 .IP CURLOPT_FRESH_CONNECT
 420 Use a new connection. \fICURLOPT_FRESH_CONNECT(3)\fP
 421 .IP CURLOPT_FORBID_REUSE
 422 Prevent subsequent connections from re-using this. See \fICURLOPT_FORBID_REUSE(3)\fP
 423 .IP CURLOPT_CONNECTTIMEOUT
 424 Timeout for the connection phase. See \fICURLOPT_CONNECTTIMEOUT(3)\fP
 425 .IP CURLOPT_CONNECTTIMEOUT_MS
 426 Millisecond timeout for the connection phase. See \fICURLOPT_CONNECTTIMEOUT_MS(3)\fP
 427 .IP CURLOPT_IPRESOLVE
 428 IP version to resolve to. See \fICURLOPT_IPRESOLVE(3)\fP
 429 .IP CURLOPT_CONNECT_ONLY
 430 Only connect, nothing else. See \fICURLOPT_CONNECT_ONLY(3)\fP
 431 .IP CURLOPT_USE_SSL
 432 Use TLS/SSL. See \fICURLOPT_USE_SSL(3)\fP
 433 .IP CURLOPT_RESOLVE
 434 Provide fixed/fake name resolves. See \fICURLOPT_RESOLVE(3)\fP
 435 .IP CURLOPT_DNS_INTERFACE
 436 Bind name resolves to this interface. See \fICURLOPT_DNS_INTERFACE(3)\fP
 437 .IP CURLOPT_DNS_LOCAL_IP4
 438 Bind name resolves to this IP4 address. See \fICURLOPT_DNS_LOCAL_IP4(3)\fP
 439 .IP CURLOPT_DNS_LOCAL_IP6
 440 Bind name resolves to this IP6 address. See \fICURLOPT_DNS_LOCAL_IP6(3)\fP
 441 .IP CURLOPT_DNS_SERVERS
 442 Preferred DNS servers. See \fICURLOPT_DNS_SERVERS(3)\fP
 443 .IP CURLOPT_ACCEPTTIMEOUT_MS
 444 Timeout for waiting for the server's connect back to be accepted. See \fICURLOPT_ACCEPTTIMEOUT_MS(3)\fP
 445 .SH SSL and SECURITY OPTIONS
 446 .IP CURLOPT_SSLCERT
 447 Client cert. See \fICURLOPT_SSLCERT(3)\fP
 448 .IP CURLOPT_SSLCERTTYPE
 449 Client cert type.  See \fICURLOPT_SSLCERTTYPE(3)\fP
 450 .IP CURLOPT_SSLKEY
 451 Client key. See \fICURLOPT_SSLKEY(3)\fP
 452 .IP CURLOPT_SSLKEYTYPE
 453 Client key type. See \fICURLOPT_SSLKEYTYPE(3)\fP
 454 .IP CURLOPT_KEYPASSWD
 455 Client key password. See \fICURLOPT_KEYPASSWD(3)\fP
 456 .IP CURLOPT_SSL_ENABLE_ALPN
 457 Enable use of ALPN. See \fICURLOPT_SSL_ENABLE_ALPN(3)\fP
 458 .IP CURLOPT_SSL_ENABLE_NPN
 459 Enable use of NPN. See \fICURLOPT_SSL_ENABLE_NPN(3)\fP
 460 .IP CURLOPT_SSLENGINE
 461 Use identifier with SSL engine. See \fICURLOPT_SSLENGINE(3)\fP
 462 .IP CURLOPT_SSLENGINE_DEFAULT
 463 Default SSL engine. See \fICURLOPT_SSLENGINE_DEFAULT(3)\fP
 464 .IP CURLOPT_SSL_FALSESTART
 465 Enable TLS False Start. See \fICURLOPT_SSL_FALSESTART(3)\fP
 466 .IP CURLOPT_SSLVERSION
 467 SSL version to use. See \fICURLOPT_SSLVERSION(3)\fP
 468 .IP CURLOPT_SSL_VERIFYHOST
 469 Verify the host name in the SSL certificate. See \fICURLOPT_SSL_VERIFYHOST(3)\fP
 470 .IP CURLOPT_SSL_VERIFYPEER
 471 Verify the SSL certificate. See \fICURLOPT_SSL_VERIFYPEER(3)\fP
 472 .IP CURLOPT_SSL_VERIFYSTATUS
 473 Verify the SSL certificate's status. See \fICURLOPT_SSL_VERIFYSTATUS(3)\fP
 474 .IP CURLOPT_CAINFO
 475 CA cert bundle. See \fICURLOPT_CAINFO(3)\fP
 476 .IP CURLOPT_ISSUERCERT
 477 Issuer certificate. See \fICURLOPT_ISSUERCERT(3)\fP
 478 .IP CURLOPT_CAPATH
 479 Path to CA cert bundle. See \fICURLOPT_CAPATH(3)\fP
 480 .IP CURLOPT_CRLFILE
 481 Certificate Revocation List. See \fICURLOPT_CRLFILE(3)\fP
 482 .IP CURLOPT_CERTINFO
 483 Extract certificate info. See \fICURLOPT_CERTINFO(3)\fP
 484 .IP CURLOPT_PINNEDPUBLICKEY
 485 Set pinned SSL public key . See \fICURLOPT_PINNEDPUBLICKEY(3)\fP
 486 .IP CURLOPT_RANDOM_FILE
 487 Provide source for entropy random data. See \fICURLOPT_RANDOM_FILE(3)\fP
 488 .IP CURLOPT_EGDSOCKET
 489 Identify EGD socket for entropy. See \fICURLOPT_EGDSOCKET(3)\fP
 490 .IP CURLOPT_SSL_CIPHER_LIST
 491 Ciphers to use. See \fICURLOPT_SSL_CIPHER_LIST(3)\fP
 492 .IP CURLOPT_SSL_SESSIONID_CACHE
 493 Disable SSL session-id cache. See \fICURLOPT_SSL_SESSIONID_CACHE(3)\fP
 494 .IP CURLOPT_SSL_OPTIONS
 495 Control SSL behavior. See \fICURLOPT_SSL_OPTIONS(3)\fP
 496 .IP CURLOPT_KRBLEVEL
 497 Kerberos security level. See \fICURLOPT_KRBLEVEL(3)\fP
 498 .IP CURLOPT_GSSAPI_DELEGATION
 499 Disable GSS-API delegation. See \fICURLOPT_GSSAPI_DELEGATION(3)\fP
 500 .SH SSH OPTIONS
 501 .IP CURLOPT_SSH_AUTH_TYPES
 502 SSH authentication types. See \fICURLOPT_SSH_AUTH_TYPES(3)\fP
 503 .IP CURLOPT_SSH_HOST_PUBLIC_KEY_MD5
 504 MD5 of host's public key. See \fICURLOPT_SSH_HOST_PUBLIC_KEY_MD5(3)\fP
 505 .IP CURLOPT_SSH_PUBLIC_KEYFILE
 506 File name of public key. See \fICURLOPT_SSH_PUBLIC_KEYFILE(3)\fP
 507 .IP CURLOPT_SSH_PRIVATE_KEYFILE
 508 File name of private key. See \fICURLOPT_SSH_PRIVATE_KEYFILE(3)\fP
 509 .IP CURLOPT_SSH_KNOWNHOSTS
 510 File name with known hosts. See \fICURLOPT_SSH_KNOWNHOSTS(3)\fP
 511 .IP CURLOPT_SSH_KEYFUNCTION
 512 Callback for known hosts handling. See \fICURLOPT_SSH_KEYFUNCTION(3)\fP
 513 .IP CURLOPT_SSH_KEYDATA
 514 Custom pointer to pass to ssh key callback. See \fICURLOPT_SSH_KEYDATA(3)\fP
 515 .SH OTHER OPTIONS
 516 .IP CURLOPT_PRIVATE
 517 Private pointer to store. See \fICURLOPT_PRIVATE(3)\fP
 518 .IP CURLOPT_SHARE
 519 Share object to use. See \fICURLOPT_SHARE(3)\fP
 520 .IP CURLOPT_NEW_FILE_PERMS
 521 Mode for creating new remote files. See \fICURLOPT_NEW_FILE_PERMS(3)\fP
 522 .IP CURLOPT_NEW_DIRECTORY_PERMS
 523 Mode for creating new remote directories. See \fICURLOPT_NEW_DIRECTORY_PERMS(3)\fP
 524 .SH TELNET OPTIONS
 525 .IP CURLOPT_TELNETOPTIONS
 526 TELNET options. See \fICURLOPT_TELNETOPTIONS(3)\fP
 527 .SH RETURN VALUE
 528 \fICURLE_OK\fP (zero) means that the option was set properly, non-zero means an
 529 error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl-errors(3)\fP
 530 man page for the full list with descriptions.
 531
 532 If you try to set an option that libcurl doesn't know about, perhaps because
 533 the library is too old to support it or the option was removed in a recent
 534 version, this function will return \fICURLE_UNKNOWN_OPTION\fP. If support for
 535 the option was disabled at compile-time, it will return
 536 \fICURLE_NOT_BUILT_IN\fP.
 537 .SH EXAMPLE
 538 .nf
 539 CURL *curl = curl_easy_init();
 540 if(curl) {
 541   CURLcode res;
 542   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
 543   res = curl_easy_perform(curl);
 544   curl_easy_cleanup(curl);
 545 }
 546 .fi
 547 .SH "SEE ALSO"
 548 .BR curl_easy_init "(3), " curl_easy_cleanup "(3), " curl_easy_reset "(3), "
 549 .BR curl_easy_getinfo "(3), " curl_multi_setopt "(3), "