1curl_easy_setopt(3) libcurl Manual curl_easy_setopt(3)
2
6 curl_easy_setopt - set options for a curl easy handle
7
9 #include <curl/curl.h>
10 CURLcode curl_easy_setopt(CURL *handle, CURLoption option, parameter);
12
14 curl_easy_setopt(3) is used to tell libcurl how to behave. By setting
15 the appropriate options, the application can change libcurl's behavior.
16 All options are set with an option followed by a parameter. That param‐
17 eter can be a long, a function pointer, an object pointer or a
18 curl_off_t, depending on what the specific option expects. Read this
19 manual carefully as bad input values may cause libcurl to behave badly!
20 You can only set one option in each function call. A typical applica‐
21 tion uses many curl_easy_setopt(3) calls in the setup phase.
22 Options set with this function call are valid for all forthcoming
24 transfers performed using this handle. The options are not in any way
25 reset between transfers, so if you want subsequent transfers with dif‐
26 ferent options, you must change them between the transfers. You can
27 optionally reset all options back to internal default with
28 curl_easy_reset(3).
29 Strings passed to libcurl as 'char *' arguments, are copied by the
31 library; thus the string storage associated to the pointer argument may
32 be overwritten after curl_easy_setopt(3) returns. The only exception to
33 this rule is really CURLOPT_POSTFIELDS(3), but the alternative that
34 copies the string CURLOPT_COPYPOSTFIELDS(3) has some usage characteris‐
35 tics you need to read up on.
36 The order in which the options are set does not matter.
38 Before version 7.17.0, strings were not copied. Instead the user was
40 forced keep them available until libcurl no longer needed them.
41 The handle is the return code from a curl_easy_init(3) or
43 curl_easy_duphandle(3) call.
44
46 CURLOPT_VERBOSE
47 Display verbose information. See CURLOPT_VERBOSE(3)
48 CURLOPT_HEADER
50 Include the header in the body output. See CURLOPT_HEADER(3)
51 CURLOPT_NOPROGRESS
53 Shut off the progress meter. See CURLOPT_NOPROGRESS(3)
54 CURLOPT_NOSIGNAL
56 Do not install signal handlers. See CURLOPT_NOSIGNAL(3)
57 CURLOPT_WILDCARDMATCH
59 Transfer multiple files according to a file name pattern. See
60 CURLOPT_WILDCARDMATCH(3)
61
63 CURLOPT_WRITEFUNCTION
64 Callback for writing data. See CURLOPT_WRITEFUNCTION(3)
65 CURLOPT_WRITEDATA
67 Data pointer to pass to the write callback. See CURLOPT_WRITE‐
68 DATA(3)
69 CURLOPT_READFUNCTION
71 Callback for reading data. See CURLOPT_READFUNCTION(3)
72 CURLOPT_READDATA
74 Data pointer to pass to the read callback. See CURLOPT_READ‐
75 DATA(3)
76 CURLOPT_IOCTLFUNCTION
78 Callback for I/O operations. See CURLOPT_IOCTLFUNCTION(3)
79 CURLOPT_IOCTLDATA
81 Data pointer to pass to the I/O callback. See CURLOPT_IOCTL‐
82 DATA(3)
83 CURLOPT_SEEKFUNCTION
85 Callback for seek operations. See CURLOPT_SEEKFUNCTION(3)
86 CURLOPT_SEEKDATA
88 Data pointer to pass to the seek callback. See CURLOPT_SEEK‐
89 DATA(3)
90 CURLOPT_SOCKOPTFUNCTION
92 Callback for sockopt operations. See CURLOPT_SOCKOPTFUNCTION(3)
93 CURLOPT_SOCKOPTDATA
95 Data pointer to pass to the sockopt callback. See CURLOPT_SOCK‐
96 OPTDATA(3)
97 CURLOPT_OPENSOCKETFUNCTION
99 Callback for socket creation. See CURLOPT_OPENSOCKETFUNCTION(3)
100 CURLOPT_OPENSOCKETDATA
102 Data pointer to pass to the open socket callback. See CUR‐
103 LOPT_OPENSOCKETDATA(3)
104 CURLOPT_CLOSESOCKETFUNCTION
106 Callback for closing socket. See CURLOPT_CLOSESOCKETFUNCTION(3)
107 CURLOPT_CLOSESOCKETDATA
109 Data pointer to pass to the close socket callback. See CUR‐
110 LOPT_CLOSESOCKETDATA(3)
111 CURLOPT_PROGRESSFUNCTION
113 OBSOLETE callback for progress meter. See CURLOPT_PROGRESSFUNC‐
114 TION(3)
115 CURLOPT_PROGRESSDATA
117 Data pointer to pass to the progress meter callback. See CUR‐
118 LOPT_PROGRESSDATA(3)
119 CURLOPT_XFERINFOFUNCTION
121 Callback for progress meter. See CURLOPT_XFERINFOFUNCTION(3)
122 CURLOPT_XFERINFODATA
124 Data pointer to pass to the progress meter callback. See CUR‐
125 LOPT_XFERINFODATA(3)
126 CURLOPT_HEADERFUNCTION
128 Callback for writing received headers. See CURLOPT_HEADERFUNC‐
129 TION(3)
130 CURLOPT_HEADERDATA
132 Data pointer to pass to the header callback. See CURLOPT_HEADER‐
133 DATA(3)
134 CURLOPT_DEBUGFUNCTION
136 Callback for debug information. See CURLOPT_DEBUGFUNCTION(3)
137 CURLOPT_DEBUGDATA
139 Data pointer to pass to the debug callback. See CURLOPT_DEBUG‐
140 DATA(3)
141 CURLOPT_SSL_CTX_FUNCTION
143 Callback for SSL context logic. See CURLOPT_SSL_CTX_FUNCTION(3)
144 CURLOPT_SSL_CTX_DATA
146 Data pointer to pass to the SSL context callback. See CUR‐
147 LOPT_SSL_CTX_DATA(3)
148 CURLOPT_CONV_TO_NETWORK_FUNCTION
150 Callback for code base conversion. See CURLOPT_CONV_TO_NET‐
151 WORK_FUNCTION(3)
152 CURLOPT_CONV_FROM_NETWORK_FUNCTION
154 Callback for code base conversion. See CURLOPT_CONV_FROM_NET‐
155 WORK_FUNCTION(3)
156 CURLOPT_CONV_FROM_UTF8_FUNCTION
158 Callback for code base conversion. See CUR‐
159 LOPT_CONV_FROM_UTF8_FUNCTION(3)
160 CURLOPT_INTERLEAVEFUNCTION
162 Callback for RTSP interleaved data. See CURLOPT_INTERLEAVEFUNC‐
163 TION(3)
164 CURLOPT_INTERLEAVEDATA
166 Data pointer to pass to the RTSP interleave callback. See CUR‐
167 LOPT_INTERLEAVEDATA(3)
168 CURLOPT_CHUNK_BGN_FUNCTION
170 Callback for wildcard download start of chunk. See CUR‐
171 LOPT_CHUNK_BGN_FUNCTION(3)
172 CURLOPT_CHUNK_END_FUNCTION
174 Callback for wildcard download end of chunk. See CUR‐
175 LOPT_CHUNK_END_FUNCTION(3)
176 CURLOPT_CHUNK_DATA
178 Data pointer to pass to the chunk callbacks. See CUR‐
179 LOPT_CHUNK_DATA(3)
180 CURLOPT_FNMATCH_FUNCTION
182 Callback for wildcard matching. See CURLOPT_FNMATCH_FUNCTION(3)
183 CURLOPT_FNMATCH_DATA
185 Data pointer to pass to the wildcard matching callback. See CUR‐
186 LOPT_FNMATCH_DATA(3)
187 CURLOPT_SUPPRESS_CONNECT_HEADERS
189 Suppress proxy CONNECT response headers from user callbacks. See
190 CURLOPT_SUPPRESS_CONNECT_HEADERS(3)
191 CURLOPT_RESOLVER_START_FUNCTION
193 Callback to be called before a new resolve request is started.
194 See CURLOPT_RESOLVER_START_FUNCTION(3)
195 CURLOPT_RESOLVER_START_DATA
197 Data pointer to pass to resolver start callback. See CUR‐
198 LOPT_RESOLVER_START_DATA(3)
199
201 CURLOPT_ERRORBUFFER
202 Error message buffer. See CURLOPT_ERRORBUFFER(3)
203 CURLOPT_STDERR
205 stderr replacement stream. See CURLOPT_STDERR(3)
206 CURLOPT_FAILONERROR
208 Fail on HTTP 4xx errors. CURLOPT_FAILONERROR(3)
209 CURLOPT_KEEP_SENDING_ON_ERROR
211 Keep sending on HTTP >= 300 errors. CURLOPT_KEEP_SEND‐
212 ING_ON_ERROR(3)
213
215 CURLOPT_URL
216 URL to work on. See CURLOPT_URL(3)
217 CURLOPT_PATH_AS_IS
219 Disable squashing /../ and /./ sequences in the path. See CUR‐
220 LOPT_PATH_AS_IS(3)
221 CURLOPT_PROTOCOLS
223 Allowed protocols. See CURLOPT_PROTOCOLS(3)
224 CURLOPT_REDIR_PROTOCOLS
226 Protocols to allow redirects to. See CURLOPT_REDIR_PROTOCOLS(3)
227 CURLOPT_DEFAULT_PROTOCOL
229 Default protocol. See CURLOPT_DEFAULT_PROTOCOL(3)
230 CURLOPT_PROXY
232 Proxy to use. See CURLOPT_PROXY(3)
233 CURLOPT_PRE_PROXY
235 Socks proxy to use. See CURLOPT_PRE_PROXY(3)
236 CURLOPT_PROXYPORT
238 Proxy port to use. See CURLOPT_PROXYPORT(3)
239 CURLOPT_PROXYTYPE
241 Proxy type. See CURLOPT_PROXYTYPE(3)
242 CURLOPT_NOPROXY
244 Filter out hosts from proxy use. CURLOPT_NOPROXY(3)
245 CURLOPT_HTTPPROXYTUNNEL
247 Tunnel through the HTTP proxy. CURLOPT_HTTPPROXYTUNNEL(3)
248 CURLOPT_CONNECT_TO
250 Connect to a specific host and port. See CURLOPT_CONNECT_TO(3)
251 CURLOPT_SOCKS5_AUTH
253 Socks5 authentication methods. See CURLOPT_SOCKS5_AUTH(3)
254 CURLOPT_SOCKS5_GSSAPI_SERVICE
256 Socks5 GSSAPI service name. CURLOPT_SOCKS5_GSSAPI_SERVICE(3)
257 CURLOPT_SOCKS5_GSSAPI_NEC
259 Socks5 GSSAPI NEC mode. See CURLOPT_SOCKS5_GSSAPI_NEC(3)
260 CURLOPT_PROXY_SERVICE_NAME
262 Proxy authentication service name. CURLOPT_PROXY_SERVICE_NAME(3)
263 CURLOPT_HAPROXYPROTOCOL
265 Send an HAProxy PROXY protocol v1 header. See CURLOPT_HAPROX‐
266 YPROTOCOL(3)
267 CURLOPT_SERVICE_NAME
269 Authentication service name. CURLOPT_SERVICE_NAME(3)
270 CURLOPT_INTERFACE
272 Bind connection locally to this. See CURLOPT_INTERFACE(3)
273 CURLOPT_LOCALPORT
275 Bind connection locally to this port. See CURLOPT_LOCALPORT(3)
276 CURLOPT_LOCALPORTRANGE
278 Bind connection locally to port range. See CURLOPT_LOCALPOR‐
279 TRANGE(3)
280 CURLOPT_DNS_CACHE_TIMEOUT
282 Timeout for DNS cache. See CURLOPT_DNS_CACHE_TIMEOUT(3)
283 CURLOPT_DNS_USE_GLOBAL_CACHE
285 OBSOLETE Enable global DNS cache. See CUR‐
286 LOPT_DNS_USE_GLOBAL_CACHE(3)
287 CURLOPT_DOH_URL
289 Use this DOH server for name resolves. See CURLOPT_DOH_URL(3)
290 CURLOPT_BUFFERSIZE
292 Ask for alternate buffer size. See CURLOPT_BUFFERSIZE(3)
293 CURLOPT_PORT
295 Port number to connect to. See CURLOPT_PORT(3)
296 CURLOPT_TCP_FASTOPEN
298 Enable TFO, TCP Fast Open. See CURLOPT_TCP_FASTOPEN(3)
299 CURLOPT_TCP_NODELAY
301 Disable the Nagle algorithm. See CURLOPT_TCP_NODELAY(3)
302 CURLOPT_ADDRESS_SCOPE
304 IPv6 scope for local addresses. See CURLOPT_ADDRESS_SCOPE(3)
305 CURLOPT_TCP_KEEPALIVE
307 Enable TCP keep-alive. See CURLOPT_TCP_KEEPALIVE(3)
308 CURLOPT_TCP_KEEPIDLE
310 Idle time before sending keep-alive. See CURLOPT_TCP_KEEPIDLE(3)
311 CURLOPT_TCP_KEEPINTVL
313 Interval between keep-alive probes. See CURLOPT_TCP_KEEPINTVL(3)
314 CURLOPT_UNIX_SOCKET_PATH
316 Path to a Unix domain socket. See CURLOPT_UNIX_SOCKET_PATH(3)
317 CURLOPT_ABSTRACT_UNIX_SOCKET
319 Path to an abstract Unix domain socket. See CUR‐
320 LOPT_ABSTRACT_UNIX_SOCKET(3)
321
323 CURLOPT_NETRC
324 Enable .netrc parsing. See CURLOPT_NETRC(3)
325 CURLOPT_NETRC_FILE
327 .netrc file name. See CURLOPT_NETRC_FILE(3)
328 CURLOPT_USERPWD
330 User name and password. See CURLOPT_USERPWD(3)
331 CURLOPT_PROXYUSERPWD
333 Proxy user name and password. See CURLOPT_PROXYUSERPWD(3)
334 CURLOPT_USERNAME
336 User name. See CURLOPT_USERNAME(3)
337 CURLOPT_PASSWORD
339 Password. See CURLOPT_PASSWORD(3)
340 CURLOPT_LOGIN_OPTIONS
342 Login options. See CURLOPT_LOGIN_OPTIONS(3)
343 CURLOPT_PROXYUSERNAME
345 Proxy user name. See CURLOPT_PROXYUSERNAME(3)
346 CURLOPT_PROXYPASSWORD
348 Proxy password. See CURLOPT_PROXYPASSWORD(3)
349 CURLOPT_HTTPAUTH
351 HTTP server authentication methods. See CURLOPT_HTTPAUTH(3)
352 CURLOPT_TLSAUTH_USERNAME
354 TLS authentication user name. See CURLOPT_TLSAUTH_USERNAME(3)
355 CURLOPT_PROXY_TLSAUTH_USERNAME
357 Proxy TLS authentication user name. See CUR‐
358 LOPT_PROXY_TLSAUTH_USERNAME(3)
359 CURLOPT_TLSAUTH_PASSWORD
361 TLS authentication password. See CURLOPT_TLSAUTH_PASSWORD(3)
362 CURLOPT_PROXY_TLSAUTH_PASSWORD
364 Proxy TLS authentication password. See CUR‐
365 LOPT_PROXY_TLSAUTH_PASSWORD(3)
366 CURLOPT_TLSAUTH_TYPE
368 TLS authentication methods. See CURLOPT_TLSAUTH_TYPE(3)
369 CURLOPT_PROXY_TLSAUTH_TYPE
371 Proxy TLS authentication methods. See CUR‐
372 LOPT_PROXY_TLSAUTH_TYPE(3)
373 CURLOPT_PROXYAUTH
375 HTTP proxy authentication methods. See CURLOPT_PROXYAUTH(3)
376 CURLOPT_SASL_AUTHZID
378 SASL authorisation identity (identity to act as). See CUR‐
379 LOPT_SASL_AUTHZID(3)
380 CURLOPT_SASL_IR
382 Enable SASL initial response. See CURLOPT_SASL_IR(3)
383 CURLOPT_XOAUTH2_BEARER
385 OAuth2 bearer token. See CURLOPT_XOAUTH2_BEARER(3)
386 CURLOPT_DISALLOW_USERNAME_IN_URL
388 Don't allow username in URL. See CURLOPT_DISALLOW_USER‐
389 NAME_IN_URL(3)
390
392 CURLOPT_AUTOREFERER
393 Automatically set Referer: header. See CURLOPT_AUTOREFERER(3)
394 CURLOPT_ACCEPT_ENCODING
396 Accept-Encoding and automatic decompressing data. See CUR‐
397 LOPT_ACCEPT_ENCODING(3)
398 CURLOPT_TRANSFER_ENCODING
400 Request Transfer-Encoding. See CURLOPT_TRANSFER_ENCODING(3)
401 CURLOPT_FOLLOWLOCATION
403 Follow HTTP redirects. See CURLOPT_FOLLOWLOCATION(3)
404 CURLOPT_UNRESTRICTED_AUTH
406 Do not restrict authentication to original host. CURLOPT_UNRE‐
407 STRICTED_AUTH(3)
408 CURLOPT_MAXREDIRS
410 Maximum number of redirects to follow. See CURLOPT_MAXREDIRS(3)
411 CURLOPT_POSTREDIR
413 How to act on redirects after POST. See CURLOPT_POSTREDIR(3)
414 CURLOPT_PUT
416 Issue an HTTP PUT request. See CURLOPT_PUT(3)
417 CURLOPT_POST
419 Issue an HTTP POST request. See CURLOPT_POST(3)
420 CURLOPT_POSTFIELDS
422 Send a POST with this data. See CURLOPT_POSTFIELDS(3)
423 CURLOPT_POSTFIELDSIZE
425 The POST data is this big. See CURLOPT_POSTFIELDSIZE(3)
426 CURLOPT_POSTFIELDSIZE_LARGE
428 The POST data is this big. See CURLOPT_POSTFIELDSIZE_LARGE(3)
429 CURLOPT_COPYPOSTFIELDS
431 Send a POST with this data - and copy it. See CURLOPT_COPYPOST‐
432 FIELDS(3)
433 CURLOPT_HTTPPOST
435 Multipart formpost HTTP POST. See CURLOPT_HTTPPOST(3)
436 CURLOPT_REFERER
438 Referer: header. See CURLOPT_REFERER(3)
439 CURLOPT_USERAGENT
441 User-Agent: header. See CURLOPT_USERAGENT(3)
442 CURLOPT_HTTPHEADER
444 Custom HTTP headers. See CURLOPT_HTTPHEADER(3)
445 CURLOPT_HEADEROPT
447 Control custom headers. See CURLOPT_HEADEROPT(3)
448 CURLOPT_PROXYHEADER
450 Custom HTTP headers sent to proxy. See CURLOPT_PROXYHEADER(3)
451 CURLOPT_HTTP200ALIASES
453 Alternative versions of 200 OK. See CURLOPT_HTTP200ALIASES(3)
454 CURLOPT_COOKIE
456 Cookie(s) to send. See CURLOPT_COOKIE(3)
457 CURLOPT_COOKIEFILE
459 File to read cookies from. See CURLOPT_COOKIEFILE(3)
460 CURLOPT_COOKIEJAR
462 File to write cookies to. See CURLOPT_COOKIEJAR(3)
463 CURLOPT_COOKIESESSION
465 Start a new cookie session. See CURLOPT_COOKIESESSION(3)
466 CURLOPT_COOKIELIST
468 Add or control cookies. See CURLOPT_COOKIELIST(3)
469 CURLOPT_ALTSVC
471 Specify the Alt-Svc: cache file name. See CURLOPT_ALTSVC(3)
472 CURLOPT_ALTSVC_CTRL
474 Enable and configure Alt-Svc: treatment. See CUR‐
475 LOPT_ALTSVC_CTRL(3)
476 CURLOPT_HTTPGET
478 Do an HTTP GET request. See CURLOPT_HTTPGET(3)
479 CURLOPT_REQUEST_TARGET
481 Set the request target. CURLOPT_REQUEST_TARGET(3)
482 CURLOPT_HTTP_VERSION
484 HTTP version to use. CURLOPT_HTTP_VERSION(3)
485 CURLOPT_HTTP09_ALLOWED
487 Allow HTTP/0.9 responses. CURLOPT_HTTP09_ALLOWED(3)
488 CURLOPT_IGNORE_CONTENT_LENGTH
490 Ignore Content-Length. See CURLOPT_IGNORE_CONTENT_LENGTH(3)
491 CURLOPT_HTTP_CONTENT_DECODING
493 Disable Content decoding. See CURLOPT_HTTP_CONTENT_DECODING(3)
494 CURLOPT_HTTP_TRANSFER_DECODING
496 Disable Transfer decoding. See CURLOPT_HTTP_TRANSFER_DECODING(3)
497 CURLOPT_EXPECT_100_TIMEOUT_MS
499 100-continue timeout. See CURLOPT_EXPECT_100_TIMEOUT_MS(3)
500 CURLOPT_TRAILERFUNCTION
502 Set callback for sending trailing headers. See CURLOPT_TRAILER‐
503 FUNCTION(3)
504 CURLOPT_TRAILERDATA
506 Custom pointer passed to the trailing headers callback. See CUR‐
507 LOPT_TRAILERDATA(3)
508 CURLOPT_PIPEWAIT
510 Wait on connection to pipeline on it. See CURLOPT_PIPEWAIT(3)
511 CURLOPT_STREAM_DEPENDS
513 This HTTP/2 stream depends on another. See CUR‐
514 LOPT_STREAM_DEPENDS(3)
515 CURLOPT_STREAM_DEPENDS_E
517 This HTTP/2 stream depends on another exclusively. See CUR‐
518 LOPT_STREAM_DEPENDS_E(3)
519 CURLOPT_STREAM_WEIGHT
521 Set this HTTP/2 stream's weight. See CURLOPT_STREAM_WEIGHT(3)
522
524 CURLOPT_MAIL_FROM
525 Address of the sender. See CURLOPT_MAIL_FROM(3)
526 CURLOPT_MAIL_RCPT
528 Address of the recipients. See CURLOPT_MAIL_RCPT(3)
529 CURLOPT_MAIL_AUTH
531 Authentication address. See CURLOPT_MAIL_AUTH(3)
532 CURLOPT_MAIL_RCPT_ALLLOWFAILS
534 Allow RCPT TO command to fail for some recipients. See CUR‐
535 LOPT_MAIL_RCPT_ALLLOWFAILS(3)
536
538 CURLOPT_TFTP_BLKSIZE
539 TFTP block size. See CURLOPT_TFTP_BLKSIZE(3)
540 CURLOPT_TFTP_NO_OPTIONS
542 Do not send TFTP options requests. See CUR‐
543 LOPT_TFTP_NO_OPTIONS(3)
544
546 CURLOPT_FTPPORT
547 Use active FTP. See CURLOPT_FTPPORT(3)
548 CURLOPT_QUOTE
550 Commands to run before transfer. See CURLOPT_QUOTE(3)
551 CURLOPT_POSTQUOTE
553 Commands to run after transfer. See CURLOPT_POSTQUOTE(3)
554 CURLOPT_PREQUOTE
556 Commands to run just before transfer. See CURLOPT_PREQUOTE(3)
557 CURLOPT_APPEND
559 Append to remote file. See CURLOPT_APPEND(3)
560 CURLOPT_FTP_USE_EPRT
562 Use EPTR. See CURLOPT_FTP_USE_EPRT(3)
563 CURLOPT_FTP_USE_EPSV
565 Use EPSV. See CURLOPT_FTP_USE_EPSV(3)
566 CURLOPT_FTP_USE_PRET
568 Use PRET. See CURLOPT_FTP_USE_PRET(3)
569 CURLOPT_FTP_CREATE_MISSING_DIRS
571 Create missing directories on the remote server. See CUR‐
572 LOPT_FTP_CREATE_MISSING_DIRS(3)
573 CURLOPT_FTP_RESPONSE_TIMEOUT
575 Timeout for FTP responses. See CURLOPT_FTP_RESPONSE_TIMEOUT(3)
576 CURLOPT_FTP_ALTERNATIVE_TO_USER
578 Alternative to USER. See CURLOPT_FTP_ALTERNATIVE_TO_USER(3)
579 CURLOPT_FTP_SKIP_PASV_IP
581 Ignore the IP address in the PASV response. See CUR‐
582 LOPT_FTP_SKIP_PASV_IP(3)
583 CURLOPT_FTPSSLAUTH
585 Control how to do TLS. See CURLOPT_FTPSSLAUTH(3)
586 CURLOPT_FTP_SSL_CCC
588 Back to non-TLS again after authentication. See CUR‐
589 LOPT_FTP_SSL_CCC(3)
590 CURLOPT_FTP_ACCOUNT
592 Send ACCT command. See CURLOPT_FTP_ACCOUNT(3)
593 CURLOPT_FTP_FILEMETHOD
595 Specify how to reach files. See CURLOPT_FTP_FILEMETHOD(3)
596
598 CURLOPT_RTSP_REQUEST
599 RTSP request. See CURLOPT_RTSP_REQUEST(3)
600 CURLOPT_RTSP_SESSION_ID
602 RTSP session-id. See CURLOPT_RTSP_SESSION_ID(3)
603 CURLOPT_RTSP_STREAM_URI
605 RTSP stream URI. See CURLOPT_RTSP_STREAM_URI(3)
606 CURLOPT_RTSP_TRANSPORT
608 RTSP Transport: header. See CURLOPT_RTSP_TRANSPORT(3)
609 CURLOPT_RTSP_CLIENT_CSEQ
611 Client CSEQ number. See CURLOPT_RTSP_CLIENT_CSEQ(3)
612 CURLOPT_RTSP_SERVER_CSEQ
614 CSEQ number for RTSP Server->Client request. See CUR‐
615 LOPT_RTSP_SERVER_CSEQ(3)
616
618 CURLOPT_TRANSFERTEXT
619 Use text transfer. See CURLOPT_TRANSFERTEXT(3)
620 CURLOPT_PROXY_TRANSFER_MODE
622 Add transfer mode to URL over proxy. See CURLOPT_PROXY_TRANS‐
623 FER_MODE(3)
624 CURLOPT_CRLF
626 Convert newlines. See CURLOPT_CRLF(3)
627 CURLOPT_RANGE
629 Range requests. See CURLOPT_RANGE(3)
630 CURLOPT_RESUME_FROM
632 Resume a transfer. See CURLOPT_RESUME_FROM(3)
633 CURLOPT_RESUME_FROM_LARGE
635 Resume a transfer. See CURLOPT_RESUME_FROM_LARGE(3)
636 CURLOPT_CURLU
638 Set URL to work on with CURLU *. See CURLOPT_CURLU(3)
639 CURLOPT_CUSTOMREQUEST
641 Custom request/method. See CURLOPT_CUSTOMREQUEST(3)
642 CURLOPT_FILETIME
644 Request file modification date and time. See CURLOPT_FILETIME(3)
645 CURLOPT_DIRLISTONLY
647 List only. See CURLOPT_DIRLISTONLY(3)
648 CURLOPT_NOBODY
650 Do not get the body contents. See CURLOPT_NOBODY(3)
651 CURLOPT_INFILESIZE
653 Size of file to send. CURLOPT_INFILESIZE(3)
654 CURLOPT_INFILESIZE_LARGE
656 Size of file to send. CURLOPT_INFILESIZE_LARGE(3)
657 CURLOPT_UPLOAD
659 Upload data. See CURLOPT_UPLOAD(3)
660 CURLOPT_UPLOAD_BUFFERSIZE
662 Set upload buffer size. See CURLOPT_UPLOAD_BUFFERSIZE(3)
663 CURLOPT_MIMEPOST
665 Post/send MIME data. See CURLOPT_MIMEPOST(3)
666 CURLOPT_MAXFILESIZE
668 Maximum file size to get. See CURLOPT_MAXFILESIZE(3)
669 CURLOPT_MAXFILESIZE_LARGE
671 Maximum file size to get. See CURLOPT_MAXFILESIZE_LARGE(3)
672 CURLOPT_TIMECONDITION
674 Make a time conditional request. See CURLOPT_TIMECONDITION(3)
675 CURLOPT_TIMEVALUE
677 Time value for the time conditional request. See CUR‐
678 LOPT_TIMEVALUE(3)
679 CURLOPT_TIMEVALUE_LARGE
681 Time value for the time conditional request. See CUR‐
682 LOPT_TIMEVALUE_LARGE(3)
683
685 CURLOPT_TIMEOUT
686 Timeout for the entire request. See CURLOPT_TIMEOUT(3)
687 CURLOPT_TIMEOUT_MS
689 Millisecond timeout for the entire request. See CURLOPT_TIME‐
690 OUT_MS(3)
691 CURLOPT_LOW_SPEED_LIMIT
693 Low speed limit to abort transfer. See CUR‐
694 LOPT_LOW_SPEED_LIMIT(3)
695 CURLOPT_LOW_SPEED_TIME
697 Time to be below the speed to trigger low speed abort. See CUR‐
698 LOPT_LOW_SPEED_TIME(3)
699 CURLOPT_MAX_SEND_SPEED_LARGE
701 Cap the upload speed to this. See CUR‐
702 LOPT_MAX_SEND_SPEED_LARGE(3)
703 CURLOPT_MAX_RECV_SPEED_LARGE
705 Cap the download speed to this. See CUR‐
706 LOPT_MAX_RECV_SPEED_LARGE(3)
707 CURLOPT_MAXCONNECTS
709 Maximum number of connections in the connection pool. See CUR‐
710 LOPT_MAXCONNECTS(3)
711 CURLOPT_FRESH_CONNECT
713 Use a new connection. CURLOPT_FRESH_CONNECT(3)
714 CURLOPT_FORBID_REUSE
716 Prevent subsequent connections from re-using this. See CUR‐
717 LOPT_FORBID_REUSE(3)
718 CURLOPT_MAXAGE_CONN
720 Limit the age of connections for reuse. See CURLOPT_MAX‐
721 AGE_CONN(3)
722 CURLOPT_CONNECTTIMEOUT
724 Timeout for the connection phase. See CURLOPT_CONNECTTIMEOUT(3)
725 CURLOPT_CONNECTTIMEOUT_MS
727 Millisecond timeout for the connection phase. See CURLOPT_CON‐
728 NECTTIMEOUT_MS(3)
729 CURLOPT_IPRESOLVE
731 IP version to resolve to. See CURLOPT_IPRESOLVE(3)
732 CURLOPT_CONNECT_ONLY
734 Only connect, nothing else. See CURLOPT_CONNECT_ONLY(3)
735 CURLOPT_USE_SSL
737 Use TLS/SSL. See CURLOPT_USE_SSL(3)
738 CURLOPT_RESOLVE
740 Provide fixed/fake name resolves. See CURLOPT_RESOLVE(3)
741 CURLOPT_DNS_INTERFACE
743 Bind name resolves to this interface. See CURLOPT_DNS_INTER‐
744 FACE(3)
745 CURLOPT_DNS_LOCAL_IP4
747 Bind name resolves to this IP4 address. See CUR‐
748 LOPT_DNS_LOCAL_IP4(3)
749 CURLOPT_DNS_LOCAL_IP6
751 Bind name resolves to this IP6 address. See CUR‐
752 LOPT_DNS_LOCAL_IP6(3)
753 CURLOPT_DNS_SERVERS
755 Preferred DNS servers. See CURLOPT_DNS_SERVERS(3)
756 CURLOPT_DNS_SHUFFLE_ADDRESSES
758 Shuffle addresses before use. See CURLOPT_DNS_SHUF‐
759 FLE_ADDRESSES(3)
760 CURLOPT_ACCEPTTIMEOUT_MS
762 Timeout for waiting for the server's connect back to be
763 accepted. See CURLOPT_ACCEPTTIMEOUT_MS(3)
764 CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS
766 Timeout for happy eyeballs. See CURLOPT_HAPPY_EYEBALLS_TIME‐
767 OUT_MS(3)
768 CURLOPT_UPKEEP_INTERVAL_MS
770 Sets the interval at which connection upkeep are performed. See
771 CURLOPT_UPKEEP_INTERVAL_MS(3)
772
774 CURLOPT_SSLCERT
775 Client cert. See CURLOPT_SSLCERT(3)
776 CURLOPT_SSLCERT_BLOB
778 Client cert memory buffer. See CURLOPT_SSLCERT_BLOB(3)
779 CURLOPT_PROXY_SSLCERT
781 Proxy client cert. See CURLOPT_PROXY_SSLCERT(3)
782 CURLOPT_PROXY_SSLCERT_BLOB
784 Proxy client cert memory buffer. See CUR‐
785 LOPT_PROXY_SSLCERT_BLOB(3)
786 CURLOPT_SSLCERTTYPE
788 Client cert type. See CURLOPT_SSLCERTTYPE(3)
789 CURLOPT_PROXY_SSLCERTTYPE
791 Proxy client cert type. See CURLOPT_PROXY_SSLCERTTYPE(3)
792 CURLOPT_SSLKEY
794 Client key. See CURLOPT_SSLKEY(3)
795 CURLOPT_SSLKEY_BLOB
797 Client key memory buffer. See CURLOPT_SSLKEY_BLOB(3)
798 CURLOPT_PROXY_SSLKEY
800 Proxy client key. See CURLOPT_PROXY_SSLKEY(3)
801 CURLOPT_PROXY_SSLKEY_BLOB
803 Proxy client key. See CURLOPT_PROXY_SSLKEY_BLOB(3)
804 CURLOPT_SSLKEYTYPE
806 Client key type. See CURLOPT_SSLKEYTYPE(3)
807 CURLOPT_PROXY_SSLKEYTYPE
809 Proxy client key type. See CURLOPT_PROXY_SSLKEYTYPE(3)
810 CURLOPT_KEYPASSWD
812 Client key password. See CURLOPT_KEYPASSWD(3)
813 CURLOPT_PROXY_KEYPASSWD
815 Proxy client key password. See CURLOPT_PROXY_KEYPASSWD(3)
816 CURLOPT_SSL_ENABLE_ALPN
818 Enable use of ALPN. See CURLOPT_SSL_ENABLE_ALPN(3)
819 CURLOPT_SSL_ENABLE_NPN
821 Enable use of NPN. See CURLOPT_SSL_ENABLE_NPN(3)
822 CURLOPT_SSLENGINE
824 Use identifier with SSL engine. See CURLOPT_SSLENGINE(3)
825 CURLOPT_SSLENGINE_DEFAULT
827 Default SSL engine. See CURLOPT_SSLENGINE_DEFAULT(3)
828 CURLOPT_SSL_FALSESTART
830 Enable TLS False Start. See CURLOPT_SSL_FALSESTART(3)
831 CURLOPT_SSLVERSION
833 SSL version to use. See CURLOPT_SSLVERSION(3)
834 CURLOPT_PROXY_SSLVERSION
836 Proxy SSL version to use. See CURLOPT_PROXY_SSLVERSION(3)
837 CURLOPT_SSL_VERIFYHOST
839 Verify the host name in the SSL certificate. See CUR‐
840 LOPT_SSL_VERIFYHOST(3)
841 CURLOPT_PROXY_SSL_VERIFYHOST
843 Verify the host name in the proxy SSL certificate. See CUR‐
844 LOPT_PROXY_SSL_VERIFYHOST(3)
845 CURLOPT_SSL_VERIFYPEER
847 Verify the SSL certificate. See CURLOPT_SSL_VERIFYPEER(3)
848 CURLOPT_PROXY_SSL_VERIFYPEER
850 Verify the proxy SSL certificate. See CURLOPT_PROXY_SSL_VERI‐
851 FYPEER(3)
852 CURLOPT_SSL_VERIFYSTATUS
854 Verify the SSL certificate's status. See CURLOPT_SSL_VERIFYSTA‐
855 TUS(3)
856 CURLOPT_CAINFO
858 CA cert bundle. See CURLOPT_CAINFO(3)
859 CURLOPT_PROXY_CAINFO
861 Proxy CA cert bundle. See CURLOPT_PROXY_CAINFO(3)
862 CURLOPT_ISSUERCERT
864 Issuer certificate. See CURLOPT_ISSUERCERT(3)
865 CURLOPT_ISSUERCERT_BLOB
867 Issuer certificate memory buffer. See CURLOPT_ISSUERCERT_BLOB(3)
868 CURLOPT_PROXY_ISSUERCERT
870 Proxy issuer certificate. See CURLOPT_PROXY_ISSUERCERT(3)
871 CURLOPT_PROXY_ISSUERCERT_BLOB
873 Proxy issuer certificate memory buffer. See CUR‐
874 LOPT_PROXY_ISSUERCERT_BLOB(3)
875 CURLOPT_CAPATH
877 Path to CA cert bundle. See CURLOPT_CAPATH(3)
878 CURLOPT_PROXY_CAPATH
880 Path to proxy CA cert bundle. See CURLOPT_PROXY_CAPATH(3)
881 CURLOPT_CRLFILE
883 Certificate Revocation List. See CURLOPT_CRLFILE(3)
884 CURLOPT_PROXY_CRLFILE
886 Proxy Certificate Revocation List. See CURLOPT_PROXY_CRLFILE(3)
887 CURLOPT_CERTINFO
889 Extract certificate info. See CURLOPT_CERTINFO(3)
890 CURLOPT_PINNEDPUBLICKEY
892 Set pinned SSL public key . See CURLOPT_PINNEDPUBLICKEY(3)
893 CURLOPT_PROXY_PINNEDPUBLICKEY
895 Set the proxy's pinned SSL public key. See CURLOPT_PROXY_PINNED‐
896 PUBLICKEY(3)
897 CURLOPT_RANDOM_FILE
899 Provide source for entropy random data. See CURLOPT_RAN‐
900 DOM_FILE(3)
901 CURLOPT_EGDSOCKET
903 Identify EGD socket for entropy. See CURLOPT_EGDSOCKET(3)
904 CURLOPT_SSL_CIPHER_LIST
906 Ciphers to use. See CURLOPT_SSL_CIPHER_LIST(3)
907 CURLOPT_PROXY_SSL_CIPHER_LIST
909 Proxy ciphers to use. See CURLOPT_PROXY_SSL_CIPHER_LIST(3)
910 CURLOPT_TLS13_CIPHERS
912 TLS 1.3 cipher suites to use. See CURLOPT_TLS13_CIPHERS(3)
913 CURLOPT_PROXY_TLS13_CIPHERS
915 Proxy TLS 1.3 cipher suites to use. See CUR‐
916 LOPT_PROXY_TLS13_CIPHERS(3)
917 CURLOPT_SSL_SESSIONID_CACHE
919 Disable SSL session-id cache. See CURLOPT_SSL_SESSIONID_CACHE(3)
920 CURLOPT_SSL_OPTIONS
922 Control SSL behavior. See CURLOPT_SSL_OPTIONS(3)
923 CURLOPT_PROXY_SSL_OPTIONS
925 Control proxy SSL behavior. See CURLOPT_PROXY_SSL_OPTIONS(3)
926 CURLOPT_KRBLEVEL
928 Kerberos security level. See CURLOPT_KRBLEVEL(3)
929 CURLOPT_GSSAPI_DELEGATION
931 Disable GSS-API delegation. See CURLOPT_GSSAPI_DELEGATION(3)
932
934 CURLOPT_SSH_AUTH_TYPES
935 SSH authentication types. See CURLOPT_SSH_AUTH_TYPES(3)
936 CURLOPT_SSH_COMPRESSION
938 Enable SSH compression. See CURLOPT_SSH_COMPRESSION(3)
939 CURLOPT_SSH_HOST_PUBLIC_KEY_MD5
941 MD5 of host's public key. See CURLOPT_SSH_HOST_PUBLIC_KEY_MD5(3)
942 CURLOPT_SSH_PUBLIC_KEYFILE
944 File name of public key. See CURLOPT_SSH_PUBLIC_KEYFILE(3)
945 CURLOPT_SSH_PRIVATE_KEYFILE
947 File name of private key. See CURLOPT_SSH_PRIVATE_KEYFILE(3)
948 CURLOPT_SSH_KNOWNHOSTS
950 File name with known hosts. See CURLOPT_SSH_KNOWNHOSTS(3)
951 CURLOPT_SSH_KEYFUNCTION
953 Callback for known hosts handling. See CURLOPT_SSH_KEYFUNC‐
954 TION(3)
955 CURLOPT_SSH_KEYDATA
957 Custom pointer to pass to ssh key callback. See CURLOPT_SSH_KEY‐
958 DATA(3)
959
961 CURLOPT_PRIVATE
962 Private pointer to store. See CURLOPT_PRIVATE(3)
963 CURLOPT_SHARE
965 Share object to use. See CURLOPT_SHARE(3)
966 CURLOPT_NEW_FILE_PERMS
968 Mode for creating new remote files. See CUR‐
969 LOPT_NEW_FILE_PERMS(3)
970 CURLOPT_NEW_DIRECTORY_PERMS
972 Mode for creating new remote directories. See CURLOPT_NEW_DIREC‐
973 TORY_PERMS(3)
974
976 CURLOPT_TELNETOPTIONS
977 TELNET options. See CURLOPT_TELNETOPTIONS(3)
978
980 CURLE_OK (zero) means that the option was set properly, non-zero means
981 an error occurred as <curl/curl.h> defines. See the libcurl-errors(3)
982 man page for the full list with descriptions.
983 Strings passed on to libcurl must be shorter than 8000000 bytes, other‐
985 wise curl_easy_setopt(3) returns CURLE_BAD_FUNCTION_ARGUMENT (added in
986 7.65.0).
987 If you try to set an option that libcurl doesn't know about, perhaps
989 because the library is too old to support it or the option was removed
990 in a recent version, this function will return CURLE_UNKNOWN_OPTION. If
991 support for the option was disabled at compile-time, it will return
992 CURLE_NOT_BUILT_IN.
993
995 CURL *curl = curl_easy_init();
996 if(curl) {
997 CURLcode res;
998 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
999 res = curl_easy_perform(curl);
1000 curl_easy_cleanup(curl);
1001 }
1002
1004 curl_easy_init(3), curl_easy_cleanup(3), curl_easy_reset(3),
1005 curl_easy_getinfo(3), curl_multi_setopt(3),
1006libcurl 7.71.1 May 19, 2020 curl_easy_setopt(3)