curl_easy_setopt.3 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734
  1. .\" generated by cd2nroff 0.1 from curl_easy_setopt.md
  2. .TH curl_easy_setopt 3 "2025-01-17" libcurl
  3. .SH NAME
  4. curl_easy_setopt \- set options for a curl easy handle
  5. .SH SYNOPSIS
  6. .nf
  7. #include <curl/curl.h>
  8. CURLcode curl_easy_setopt(CURL *handle, CURLoption option, parameter);
  9. .fi
  10. .SH DESCRIPTION
  11. \fIcurl_easy_setopt(3)\fP is used to tell libcurl how to behave. By setting the
  12. appropriate options, the application can change libcurl\(aqs behavior. All
  13. options are set with an \fIoption\fP followed by a \fIparameter\fP. That parameter can
  14. be a \fBlong\fP, a \fBfunction pointer\fP, an \fBobject pointer\fP or a
  15. \fBcurl_off_t\fP, depending on what the specific option expects. Read this
  16. manual carefully as bad input values may cause libcurl to behave badly! You
  17. can only set one option in each function call. A typical application uses many
  18. \fIcurl_easy_setopt(3)\fP calls in the setup phase.
  19. Options set with this function call are valid for all forthcoming transfers
  20. performed using this \fIhandle\fP. The options are not in any way reset between
  21. transfers, so if you want subsequent transfers with different options, you
  22. must change them between the transfers. You can optionally reset all options
  23. back to internal default with \fIcurl_easy_reset(3)\fP.
  24. Strings passed to libcurl as \(aqchar *\(aq arguments, are copied by the library;
  25. the string storage associated to the pointer argument may be discarded or
  26. reused after \fIcurl_easy_setopt(3)\fP returns. The only exception to this rule is
  27. really \fICURLOPT_POSTFIELDS(3)\fP, but the alternative that copies the string
  28. \fICURLOPT_COPYPOSTFIELDS(3)\fP has some usage characteristics you need to read up
  29. on. This function does not accept input strings longer than
  30. \fBCURL_MAX_INPUT_LENGTH\fP (8 MB).
  31. The order in which the options are set does not matter.
  32. Before version 7.17.0, strings were not copied. Instead the user was forced
  33. keep them available until libcurl no longer needed them.
  34. The \fIhandle\fP is the return code from a \fIcurl_easy_init(3)\fP or
  35. \fIcurl_easy_duphandle(3)\fP call.
  36. .SH OPTIONS
  37. .IP CURLOPT_ABSTRACT_UNIX_SOCKET
  38. Path to an abstract Unix domain socket. See \fICURLOPT_ABSTRACT_UNIX_SOCKET(3)\fP
  39. .IP CURLOPT_ACCEPTTIMEOUT_MS
  40. Timeout for waiting for the server\(aqs connect back to be accepted. See
  41. \fICURLOPT_ACCEPTTIMEOUT_MS(3)\fP
  42. .IP CURLOPT_ACCEPT_ENCODING
  43. Accept\-Encoding and automatic decompressing data. See
  44. \fICURLOPT_ACCEPT_ENCODING(3)\fP
  45. .IP CURLOPT_ADDRESS_SCOPE
  46. IPv6 scope for local addresses. See \fICURLOPT_ADDRESS_SCOPE(3)\fP
  47. .IP CURLOPT_ALTSVC
  48. Specify the Alt\-Svc: cache filename. See \fICURLOPT_ALTSVC(3)\fP
  49. .IP CURLOPT_ALTSVC_CTRL
  50. Enable and configure Alt\-Svc: treatment. See \fICURLOPT_ALTSVC_CTRL(3)\fP
  51. .IP CURLOPT_APPEND
  52. Append to remote file. See \fICURLOPT_APPEND(3)\fP
  53. .IP CURLOPT_AUTOREFERER
  54. Automatically set Referer: header. See \fICURLOPT_AUTOREFERER(3)\fP
  55. .IP CURLOPT_AWS_SIGV4
  56. AWS HTTP V4 Signature. See \fICURLOPT_AWS_SIGV4(3)\fP
  57. .IP CURLOPT_BUFFERSIZE
  58. Ask for alternate buffer size. See \fICURLOPT_BUFFERSIZE(3)\fP
  59. .IP CURLOPT_CAINFO
  60. CA cert bundle. See \fICURLOPT_CAINFO(3)\fP
  61. .IP CURLOPT_CAINFO_BLOB
  62. CA cert bundle memory buffer. See \fICURLOPT_CAINFO_BLOB(3)\fP
  63. .IP CURLOPT_CAPATH
  64. Path to CA cert bundle. See \fICURLOPT_CAPATH(3)\fP
  65. .IP CURLOPT_CA_CACHE_TIMEOUT
  66. Timeout for CA cache. See \fICURLOPT_CA_CACHE_TIMEOUT(3)\fP
  67. .IP CURLOPT_CERTINFO
  68. Extract certificate info. See \fICURLOPT_CERTINFO(3)\fP
  69. .IP CURLOPT_CHUNK_BGN_FUNCTION
  70. Callback for wildcard download start of chunk. See
  71. \fICURLOPT_CHUNK_BGN_FUNCTION(3)\fP
  72. .IP CURLOPT_CHUNK_DATA
  73. Data pointer to pass to the chunk callbacks. See \fICURLOPT_CHUNK_DATA(3)\fP
  74. .IP CURLOPT_CHUNK_END_FUNCTION
  75. Callback for wildcard download end of chunk. See \fICURLOPT_CHUNK_END_FUNCTION(3)\fP
  76. .IP CURLOPT_CLOSESOCKETDATA
  77. Data pointer to pass to the close socket callback. See
  78. \fICURLOPT_CLOSESOCKETDATA(3)\fP
  79. .IP CURLOPT_CLOSESOCKETFUNCTION
  80. Callback for closing socket. See \fICURLOPT_CLOSESOCKETFUNCTION(3)\fP
  81. .IP CURLOPT_CONNECTTIMEOUT
  82. Timeout for the connection phase. See \fICURLOPT_CONNECTTIMEOUT(3)\fP
  83. .IP CURLOPT_CONNECTTIMEOUT_MS
  84. Millisecond timeout for the connection phase. See \fICURLOPT_CONNECTTIMEOUT_MS(3)\fP
  85. .IP CURLOPT_CONNECT_ONLY
  86. Only connect, nothing else. See \fICURLOPT_CONNECT_ONLY(3)\fP
  87. .IP CURLOPT_CONNECT_TO
  88. Connect to a specific host and port. See \fICURLOPT_CONNECT_TO(3)\fP
  89. .IP CURLOPT_CONV_FROM_NETWORK_FUNCTION
  90. \fBOBSOLETE\fP Callback for code base conversion.
  91. See \fICURLOPT_CONV_FROM_NETWORK_FUNCTION(3)\fP
  92. .IP CURLOPT_CONV_FROM_UTF8_FUNCTION
  93. \fBOBSOLETE\fP Callback for code base conversion.
  94. See \fICURLOPT_CONV_FROM_UTF8_FUNCTION(3)\fP
  95. .IP CURLOPT_CONV_TO_NETWORK_FUNCTION
  96. \fBOBSOLETE\fP Callback for code base conversion.
  97. See \fICURLOPT_CONV_TO_NETWORK_FUNCTION(3)\fP
  98. .IP CURLOPT_COOKIE
  99. Cookie(s) to send. See \fICURLOPT_COOKIE(3)\fP
  100. .IP CURLOPT_COOKIEFILE
  101. File to read cookies from. See \fICURLOPT_COOKIEFILE(3)\fP
  102. .IP CURLOPT_COOKIEJAR
  103. File to write cookies to. See \fICURLOPT_COOKIEJAR(3)\fP
  104. .IP CURLOPT_COOKIELIST
  105. Add or control cookies. See \fICURLOPT_COOKIELIST(3)\fP
  106. .IP CURLOPT_COOKIESESSION
  107. Start a new cookie session. See \fICURLOPT_COOKIESESSION(3)\fP
  108. .IP CURLOPT_COPYPOSTFIELDS
  109. Send a POST with this data \- and copy it. See \fICURLOPT_COPYPOSTFIELDS(3)\fP
  110. .IP CURLOPT_CRLF
  111. Convert newlines. See \fICURLOPT_CRLF(3)\fP
  112. .IP CURLOPT_CRLFILE
  113. Certificate Revocation List. See \fICURLOPT_CRLFILE(3)\fP
  114. .IP CURLOPT_CURLU
  115. Set URL to work on with a URL handle. See \fICURLOPT_CURLU(3)\fP
  116. .IP CURLOPT_CUSTOMREQUEST
  117. Custom request/method. See \fICURLOPT_CUSTOMREQUEST(3)\fP
  118. .IP CURLOPT_DEBUGDATA
  119. Data pointer to pass to the debug callback. See \fICURLOPT_DEBUGDATA(3)\fP
  120. .IP CURLOPT_DEBUGFUNCTION
  121. Callback for debug information. See \fICURLOPT_DEBUGFUNCTION(3)\fP
  122. .IP CURLOPT_DEFAULT_PROTOCOL
  123. Default protocol. See \fICURLOPT_DEFAULT_PROTOCOL(3)\fP
  124. .IP CURLOPT_DIRLISTONLY
  125. List only. See \fICURLOPT_DIRLISTONLY(3)\fP
  126. .IP CURLOPT_DISALLOW_USERNAME_IN_URL
  127. Do not allow username in URL. See \fICURLOPT_DISALLOW_USERNAME_IN_URL(3)\fP
  128. .IP CURLOPT_DNS_CACHE_TIMEOUT
  129. Timeout for DNS cache. See \fICURLOPT_DNS_CACHE_TIMEOUT(3)\fP
  130. .IP CURLOPT_DNS_INTERFACE
  131. Bind name resolves to this interface. See \fICURLOPT_DNS_INTERFACE(3)\fP
  132. .IP CURLOPT_DNS_LOCAL_IP4
  133. Bind name resolves to this IP4 address. See \fICURLOPT_DNS_LOCAL_IP4(3)\fP
  134. .IP CURLOPT_DNS_LOCAL_IP6
  135. Bind name resolves to this IP6 address. See \fICURLOPT_DNS_LOCAL_IP6(3)\fP
  136. .IP CURLOPT_DNS_SERVERS
  137. Preferred DNS servers. See \fICURLOPT_DNS_SERVERS(3)\fP
  138. .IP CURLOPT_DNS_SHUFFLE_ADDRESSES
  139. Shuffle addresses before use. See \fICURLOPT_DNS_SHUFFLE_ADDRESSES(3)\fP
  140. .IP CURLOPT_DNS_USE_GLOBAL_CACHE
  141. \fBOBSOLETE\fP Enable global DNS cache. See \fICURLOPT_DNS_USE_GLOBAL_CACHE(3)\fP
  142. .IP CURLOPT_DOH_SSL_VERIFYHOST
  143. Verify the hostname in the DoH (DNS\-over\-HTTPS) SSL certificate. See
  144. \fICURLOPT_DOH_SSL_VERIFYHOST(3)\fP
  145. .IP CURLOPT_DOH_SSL_VERIFYPEER
  146. Verify the DoH (DNS\-over\-HTTPS) SSL certificate. See
  147. \fICURLOPT_DOH_SSL_VERIFYPEER(3)\fP
  148. .IP CURLOPT_DOH_SSL_VERIFYSTATUS
  149. Verify the DoH (DNS\-over\-HTTPS) SSL certificate\(aqs status. See
  150. \fICURLOPT_DOH_SSL_VERIFYSTATUS(3)\fP
  151. .IP CURLOPT_DOH_URL
  152. Use this DoH server for name resolves. See \fICURLOPT_DOH_URL(3)\fP
  153. .IP CURLOPT_ECH
  154. Set the configuration for ECH. See \fICURLOPT_ECH(3)\fP
  155. .IP CURLOPT_EGDSOCKET
  156. \fBOBSOLETE\fP Identify EGD socket for entropy. See \fICURLOPT_EGDSOCKET(3)\fP
  157. .IP CURLOPT_ERRORBUFFER
  158. Error message buffer. See \fICURLOPT_ERRORBUFFER(3)\fP
  159. .IP CURLOPT_EXPECT_100_TIMEOUT_MS
  160. 100\-continue timeout. See \fICURLOPT_EXPECT_100_TIMEOUT_MS(3)\fP
  161. .IP CURLOPT_FAILONERROR
  162. Fail on HTTP 4xx errors. \fICURLOPT_FAILONERROR(3)\fP
  163. .IP CURLOPT_FILETIME
  164. Request file modification date and time. See \fICURLOPT_FILETIME(3)\fP
  165. .IP CURLOPT_FNMATCH_DATA
  166. Data pointer to pass to the wildcard matching callback. See
  167. \fICURLOPT_FNMATCH_DATA(3)\fP
  168. .IP CURLOPT_FNMATCH_FUNCTION
  169. Callback for wildcard matching. See \fICURLOPT_FNMATCH_FUNCTION(3)\fP
  170. .IP CURLOPT_FOLLOWLOCATION
  171. Follow HTTP redirects. See \fICURLOPT_FOLLOWLOCATION(3)\fP
  172. .IP CURLOPT_FORBID_REUSE
  173. Prevent subsequent connections from reusing this. See \fICURLOPT_FORBID_REUSE(3)\fP
  174. .IP CURLOPT_FRESH_CONNECT
  175. Use a new connection. \fICURLOPT_FRESH_CONNECT(3)\fP
  176. .IP CURLOPT_FTPPORT
  177. Use active FTP. See \fICURLOPT_FTPPORT(3)\fP
  178. .IP CURLOPT_FTPSSLAUTH
  179. Control how to do TLS. See \fICURLOPT_FTPSSLAUTH(3)\fP
  180. .IP CURLOPT_FTP_ACCOUNT
  181. Send ACCT command. See \fICURLOPT_FTP_ACCOUNT(3)\fP
  182. .IP CURLOPT_FTP_ALTERNATIVE_TO_USER
  183. Alternative to USER. See \fICURLOPT_FTP_ALTERNATIVE_TO_USER(3)\fP
  184. .IP CURLOPT_FTP_CREATE_MISSING_DIRS
  185. Create missing directories on the remote server. See
  186. \fICURLOPT_FTP_CREATE_MISSING_DIRS(3)\fP
  187. .IP CURLOPT_FTP_FILEMETHOD
  188. Specify how to reach files. See \fICURLOPT_FTP_FILEMETHOD(3)\fP
  189. .IP CURLOPT_FTP_SKIP_PASV_IP
  190. Ignore the IP address in the PASV response. See \fICURLOPT_FTP_SKIP_PASV_IP(3)\fP
  191. .IP CURLOPT_FTP_SSL_CCC
  192. Back to non\-TLS again after authentication. See \fICURLOPT_FTP_SSL_CCC(3)\fP
  193. .IP CURLOPT_FTP_USE_EPRT
  194. Use EPRT. See \fICURLOPT_FTP_USE_EPRT(3)\fP
  195. .IP CURLOPT_FTP_USE_EPSV
  196. Use EPSV. See \fICURLOPT_FTP_USE_EPSV(3)\fP
  197. .IP CURLOPT_FTP_USE_PRET
  198. Use PRET. See \fICURLOPT_FTP_USE_PRET(3)\fP
  199. .IP CURLOPT_GSSAPI_DELEGATION
  200. Disable GSS\-API delegation. See \fICURLOPT_GSSAPI_DELEGATION(3)\fP
  201. .IP CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS
  202. Timeout for happy eyeballs. See \fICURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS(3)\fP
  203. .IP CURLOPT_HAPROXYPROTOCOL
  204. Send an HAProxy PROXY protocol v1 header. See \fICURLOPT_HAPROXYPROTOCOL(3)\fP
  205. .IP CURLOPT_HAPROXY_CLIENT_IP
  206. Spoof the client IP in an HAProxy PROXY protocol v1 header. See
  207. \fICURLOPT_HAPROXY_CLIENT_IP(3)\fP
  208. .IP CURLOPT_HEADER
  209. Include the header in the body output. See \fICURLOPT_HEADER(3)\fP
  210. .IP CURLOPT_HEADERDATA
  211. Data pointer to pass to the header callback. See \fICURLOPT_HEADERDATA(3)\fP
  212. .IP CURLOPT_HEADERFUNCTION
  213. Callback for writing received headers. See \fICURLOPT_HEADERFUNCTION(3)\fP
  214. .IP CURLOPT_HEADEROPT
  215. Control custom headers. See \fICURLOPT_HEADEROPT(3)\fP
  216. .IP CURLOPT_HSTS
  217. Set HSTS cache file. See \fICURLOPT_HSTS(3)\fP
  218. .IP CURLOPT_HSTSREADDATA
  219. Pass pointer to the HSTS read callback. See \fICURLOPT_HSTSREADDATA(3)\fP
  220. .IP CURLOPT_HSTSREADFUNCTION
  221. Set HSTS read callback. See \fICURLOPT_HSTSREADFUNCTION(3)\fP
  222. .IP CURLOPT_HSTSWRITEDATA
  223. Pass pointer to the HSTS write callback. See \fICURLOPT_HSTSWRITEDATA(3)\fP
  224. .IP CURLOPT_HSTSWRITEFUNCTION
  225. Set HSTS write callback. See \fICURLOPT_HSTSWRITEFUNCTION(3)\fP
  226. .IP CURLOPT_HSTS_CTRL
  227. Enable HSTS. See \fICURLOPT_HSTS_CTRL(3)\fP
  228. .IP CURLOPT_HTTP09_ALLOWED
  229. Allow HTTP/0.9 responses. \fICURLOPT_HTTP09_ALLOWED(3)\fP
  230. .IP CURLOPT_HTTP200ALIASES
  231. Alternative versions of 200 OK. See \fICURLOPT_HTTP200ALIASES(3)\fP
  232. .IP CURLOPT_HTTPAUTH
  233. HTTP server authentication methods. See \fICURLOPT_HTTPAUTH(3)\fP
  234. .IP CURLOPT_HTTPGET
  235. Do an HTTP GET request. See \fICURLOPT_HTTPGET(3)\fP
  236. .IP CURLOPT_HTTPHEADER
  237. Custom HTTP headers. See \fICURLOPT_HTTPHEADER(3)\fP
  238. .IP CURLOPT_HTTPPOST
  239. \fBDeprecated option\fP Multipart formpost HTTP POST.
  240. See \fICURLOPT_HTTPPOST(3)\fP
  241. .IP CURLOPT_HTTPPROXYTUNNEL
  242. Tunnel through the HTTP proxy. \fICURLOPT_HTTPPROXYTUNNEL(3)\fP
  243. .IP CURLOPT_HTTP_CONTENT_DECODING
  244. Disable Content decoding. See \fICURLOPT_HTTP_CONTENT_DECODING(3)\fP
  245. .IP CURLOPT_HTTP_TRANSFER_DECODING
  246. Disable Transfer decoding. See \fICURLOPT_HTTP_TRANSFER_DECODING(3)\fP
  247. .IP CURLOPT_HTTP_VERSION
  248. HTTP version to use. \fICURLOPT_HTTP_VERSION(3)\fP
  249. .IP CURLOPT_IGNORE_CONTENT_LENGTH
  250. Ignore Content\-Length. See \fICURLOPT_IGNORE_CONTENT_LENGTH(3)\fP
  251. .IP CURLOPT_INFILESIZE
  252. Size of file to send. \fICURLOPT_INFILESIZE(3)\fP
  253. .IP CURLOPT_INFILESIZE_LARGE
  254. Size of file to send. \fICURLOPT_INFILESIZE_LARGE(3)\fP
  255. .IP CURLOPT_INTERFACE
  256. Bind connection locally to this. See \fICURLOPT_INTERFACE(3)\fP
  257. .IP CURLOPT_INTERLEAVEDATA
  258. Data pointer to pass to the RTSP interleave callback. See
  259. \fICURLOPT_INTERLEAVEDATA(3)\fP
  260. .IP CURLOPT_INTERLEAVEFUNCTION
  261. Callback for RTSP interleaved data. See \fICURLOPT_INTERLEAVEFUNCTION(3)\fP
  262. .IP CURLOPT_IOCTLDATA
  263. \fBDeprecated option\fP Data pointer to pass to the I/O callback.
  264. See \fICURLOPT_IOCTLDATA(3)\fP
  265. .IP CURLOPT_IOCTLFUNCTION
  266. \fBDeprecated option\fP Callback for I/O operations.
  267. See \fICURLOPT_IOCTLFUNCTION(3)\fP
  268. .IP CURLOPT_IPRESOLVE
  269. IP version to use. See \fICURLOPT_IPRESOLVE(3)\fP
  270. .IP CURLOPT_ISSUERCERT
  271. Issuer certificate. See \fICURLOPT_ISSUERCERT(3)\fP
  272. .IP CURLOPT_ISSUERCERT_BLOB
  273. Issuer certificate memory buffer. See \fICURLOPT_ISSUERCERT_BLOB(3)\fP
  274. .IP CURLOPT_KEEP_SENDING_ON_ERROR
  275. Keep sending on HTTP >= 300 errors. \fICURLOPT_KEEP_SENDING_ON_ERROR(3)\fP
  276. .IP CURLOPT_KEYPASSWD
  277. Client key password. See \fICURLOPT_KEYPASSWD(3)\fP
  278. .IP CURLOPT_KRBLEVEL
  279. Kerberos security level. See \fICURLOPT_KRBLEVEL(3)\fP
  280. .IP CURLOPT_LOCALPORT
  281. Bind connection locally to this port. See \fICURLOPT_LOCALPORT(3)\fP
  282. .IP CURLOPT_LOCALPORTRANGE
  283. Bind connection locally to port range. See \fICURLOPT_LOCALPORTRANGE(3)\fP
  284. .IP CURLOPT_LOGIN_OPTIONS
  285. Login options. See \fICURLOPT_LOGIN_OPTIONS(3)\fP
  286. .IP CURLOPT_LOW_SPEED_LIMIT
  287. Low speed limit to abort transfer. See \fICURLOPT_LOW_SPEED_LIMIT(3)\fP
  288. .IP CURLOPT_LOW_SPEED_TIME
  289. Time to be below the speed to trigger low speed abort. See
  290. \fICURLOPT_LOW_SPEED_TIME(3)\fP
  291. .IP CURLOPT_MAIL_AUTH
  292. Authentication address. See \fICURLOPT_MAIL_AUTH(3)\fP
  293. .IP CURLOPT_MAIL_FROM
  294. Address of the sender. See \fICURLOPT_MAIL_FROM(3)\fP
  295. .IP CURLOPT_MAIL_RCPT
  296. Address of the recipients. See \fICURLOPT_MAIL_RCPT(3)\fP
  297. .IP CURLOPT_MAIL_RCPT_ALLOWFAILS
  298. Allow RCPT TO command to fail for some recipients. See
  299. \fICURLOPT_MAIL_RCPT_ALLOWFAILS(3)\fP
  300. .IP CURLOPT_MAXAGE_CONN
  301. Limit the age (idle time) of connections for reuse. See \fICURLOPT_MAXAGE_CONN(3)\fP
  302. .IP CURLOPT_MAXCONNECTS
  303. Maximum number of connections in the connection pool. See
  304. \fICURLOPT_MAXCONNECTS(3)\fP
  305. .IP CURLOPT_MAXFILESIZE
  306. Maximum file size to get. See \fICURLOPT_MAXFILESIZE(3)\fP
  307. .IP CURLOPT_MAXFILESIZE_LARGE
  308. Maximum file size to get. See \fICURLOPT_MAXFILESIZE_LARGE(3)\fP
  309. .IP CURLOPT_MAXLIFETIME_CONN
  310. Limit the age (since creation) of connections for reuse. See
  311. \fICURLOPT_MAXLIFETIME_CONN(3)\fP
  312. .IP CURLOPT_MAXREDIRS
  313. Maximum number of redirects to follow. See \fICURLOPT_MAXREDIRS(3)\fP
  314. .IP CURLOPT_MAX_RECV_SPEED_LARGE
  315. Cap the download speed to this. See \fICURLOPT_MAX_RECV_SPEED_LARGE(3)\fP
  316. .IP CURLOPT_MAX_SEND_SPEED_LARGE
  317. Cap the upload speed to this. See \fICURLOPT_MAX_SEND_SPEED_LARGE(3)\fP
  318. .IP CURLOPT_MIMEPOST
  319. Post/send MIME data. See \fICURLOPT_MIMEPOST(3)\fP
  320. .IP CURLOPT_MIME_OPTIONS
  321. Set MIME option flags. See \fICURLOPT_MIME_OPTIONS(3)\fP
  322. .IP CURLOPT_NETRC
  323. Enable .netrc parsing. See \fICURLOPT_NETRC(3)\fP
  324. .IP CURLOPT_NETRC_FILE
  325. \&.netrc filename. See \fICURLOPT_NETRC_FILE(3)\fP
  326. .IP CURLOPT_NEW_DIRECTORY_PERMS
  327. Mode for creating new remote directories. See \fICURLOPT_NEW_DIRECTORY_PERMS(3)\fP
  328. .IP CURLOPT_NEW_FILE_PERMS
  329. Mode for creating new remote files. See \fICURLOPT_NEW_FILE_PERMS(3)\fP
  330. .IP CURLOPT_NOBODY
  331. Do not get the body contents. See \fICURLOPT_NOBODY(3)\fP
  332. .IP CURLOPT_NOPROGRESS
  333. Shut off the progress meter. See \fICURLOPT_NOPROGRESS(3)\fP
  334. .IP CURLOPT_NOPROXY
  335. Filter out hosts from proxy use. \fICURLOPT_NOPROXY(3)\fP
  336. .IP CURLOPT_NOSIGNAL
  337. Do not install signal handlers. See \fICURLOPT_NOSIGNAL(3)\fP
  338. .IP CURLOPT_OPENSOCKETDATA
  339. Data pointer to pass to the open socket callback. See \fICURLOPT_OPENSOCKETDATA(3)\fP
  340. .IP CURLOPT_OPENSOCKETFUNCTION
  341. Callback for socket creation. See \fICURLOPT_OPENSOCKETFUNCTION(3)\fP
  342. .IP CURLOPT_PASSWORD
  343. Password. See \fICURLOPT_PASSWORD(3)\fP
  344. .IP CURLOPT_PATH_AS_IS
  345. Disable squashing /../ and /./ sequences in the path. See \fICURLOPT_PATH_AS_IS(3)\fP
  346. .IP CURLOPT_PINNEDPUBLICKEY
  347. Set pinned SSL public key . See \fICURLOPT_PINNEDPUBLICKEY(3)\fP
  348. .IP CURLOPT_PIPEWAIT
  349. Wait on connection to pipeline on it. See \fICURLOPT_PIPEWAIT(3)\fP
  350. .IP CURLOPT_PORT
  351. Port number to connect to. See \fICURLOPT_PORT(3)\fP
  352. .IP CURLOPT_POST
  353. Make an HTTP POST. See \fICURLOPT_POST(3)\fP
  354. .IP CURLOPT_POSTFIELDSIZE
  355. The POST data is this big. See \fICURLOPT_POSTFIELDSIZE(3)\fP
  356. .IP CURLOPT_POSTFIELDSIZE_LARGE
  357. The POST data is this big. See \fICURLOPT_POSTFIELDSIZE_LARGE(3)\fP
  358. .IP CURLOPT_POSTQUOTE
  359. Commands to run after transfer. See \fICURLOPT_POSTQUOTE(3)\fP
  360. .IP CURLOPT_POSTREDIR
  361. How to act on redirects after POST. See \fICURLOPT_POSTREDIR(3)\fP
  362. .IP CURLOPT_PREQUOTE
  363. Commands to run just before transfer. See \fICURLOPT_PREQUOTE(3)\fP
  364. .IP CURLOPT_PREREQDATA
  365. Data pointer to pass to the CURLOPT_PREREQFUNCTION callback. See
  366. \fICURLOPT_PREREQDATA(3)\fP
  367. .IP CURLOPT_PREREQFUNCTION
  368. Callback to be called after a connection is established but before a request
  369. is made on that connection. See \fICURLOPT_PREREQFUNCTION(3)\fP
  370. .IP CURLOPT_PRE_PROXY
  371. Socks proxy to use. See \fICURLOPT_PRE_PROXY(3)\fP
  372. .IP CURLOPT_PRIVATE
  373. Private pointer to store. See \fICURLOPT_PRIVATE(3)\fP
  374. .IP CURLOPT_PROGRESSDATA
  375. Data pointer to pass to the progress meter callback. See
  376. \fICURLOPT_PROGRESSDATA(3)\fP
  377. .IP CURLOPT_PROGRESSFUNCTION
  378. \fBOBSOLETE\fP callback for progress meter. See \fICURLOPT_PROGRESSFUNCTION(3)\fP
  379. .IP CURLOPT_PROTOCOLS
  380. \fBDeprecated option\fP Allowed protocols. See \fICURLOPT_PROTOCOLS(3)\fP
  381. .IP CURLOPT_PROTOCOLS_STR
  382. Allowed protocols. See \fICURLOPT_PROTOCOLS_STR(3)\fP
  383. .IP CURLOPT_PROXY
  384. Proxy to use. See \fICURLOPT_PROXY(3)\fP
  385. .IP CURLOPT_PROXYAUTH
  386. HTTP proxy authentication methods. See \fICURLOPT_PROXYAUTH(3)\fP
  387. .IP CURLOPT_PROXYHEADER
  388. Custom HTTP headers sent to proxy. See \fICURLOPT_PROXYHEADER(3)\fP
  389. .IP CURLOPT_PROXYPASSWORD
  390. Proxy password. See \fICURLOPT_PROXYPASSWORD(3)\fP
  391. .IP CURLOPT_PROXYPORT
  392. Proxy port to use. See \fICURLOPT_PROXYPORT(3)\fP
  393. .IP CURLOPT_PROXYTYPE
  394. Proxy type. See \fICURLOPT_PROXYTYPE(3)\fP
  395. .IP CURLOPT_PROXYUSERNAME
  396. Proxy username. See \fICURLOPT_PROXYUSERNAME(3)\fP
  397. .IP CURLOPT_PROXYUSERPWD
  398. Proxy username and password. See \fICURLOPT_PROXYUSERPWD(3)\fP
  399. .IP CURLOPT_PROXY_CAINFO
  400. Proxy CA cert bundle. See \fICURLOPT_PROXY_CAINFO(3)\fP
  401. .IP CURLOPT_PROXY_CAINFO_BLOB
  402. Proxy CA cert bundle memory buffer. See \fICURLOPT_PROXY_CAINFO_BLOB(3)\fP
  403. .IP CURLOPT_PROXY_CAPATH
  404. Path to proxy CA cert bundle. See \fICURLOPT_PROXY_CAPATH(3)\fP
  405. .IP CURLOPT_PROXY_CRLFILE
  406. Proxy Certificate Revocation List. See \fICURLOPT_PROXY_CRLFILE(3)\fP
  407. .IP CURLOPT_PROXY_ISSUERCERT
  408. Proxy issuer certificate. See \fICURLOPT_PROXY_ISSUERCERT(3)\fP
  409. .IP CURLOPT_PROXY_ISSUERCERT_BLOB
  410. Proxy issuer certificate memory buffer. See \fICURLOPT_PROXY_ISSUERCERT_BLOB(3)\fP
  411. .IP CURLOPT_PROXY_KEYPASSWD
  412. Proxy client key password. See \fICURLOPT_PROXY_KEYPASSWD(3)\fP
  413. .IP CURLOPT_PROXY_PINNEDPUBLICKEY
  414. Set the proxy\(aqs pinned SSL public key. See
  415. \fICURLOPT_PROXY_PINNEDPUBLICKEY(3)\fP
  416. .IP CURLOPT_PROXY_SERVICE_NAME
  417. Proxy authentication service name. \fICURLOPT_PROXY_SERVICE_NAME(3)\fP
  418. .IP CURLOPT_PROXY_SSLCERT
  419. Proxy client cert. See \fICURLOPT_PROXY_SSLCERT(3)\fP
  420. .IP CURLOPT_PROXY_SSLCERTTYPE
  421. Proxy client cert type. See \fICURLOPT_PROXY_SSLCERTTYPE(3)\fP
  422. .IP CURLOPT_PROXY_SSLCERT_BLOB
  423. Proxy client cert memory buffer. See \fICURLOPT_PROXY_SSLCERT_BLOB(3)\fP
  424. .IP CURLOPT_PROXY_SSLKEY
  425. Proxy client key. See \fICURLOPT_PROXY_SSLKEY(3)\fP
  426. .IP CURLOPT_PROXY_SSLKEYTYPE
  427. Proxy client key type. See \fICURLOPT_PROXY_SSLKEYTYPE(3)\fP
  428. .IP CURLOPT_PROXY_SSLKEY_BLOB
  429. Proxy client key. See \fICURLOPT_PROXY_SSLKEY_BLOB(3)\fP
  430. .IP CURLOPT_PROXY_SSLVERSION
  431. Proxy SSL version to use. See \fICURLOPT_PROXY_SSLVERSION(3)\fP
  432. .IP CURLOPT_PROXY_SSL_CIPHER_LIST
  433. Proxy ciphers to use. See \fICURLOPT_PROXY_SSL_CIPHER_LIST(3)\fP
  434. .IP CURLOPT_PROXY_SSL_OPTIONS
  435. Control proxy SSL behavior. See \fICURLOPT_PROXY_SSL_OPTIONS(3)\fP
  436. .IP CURLOPT_PROXY_SSL_VERIFYHOST
  437. Verify the hostname in the proxy SSL certificate. See
  438. \fICURLOPT_PROXY_SSL_VERIFYHOST(3)\fP
  439. .IP CURLOPT_PROXY_SSL_VERIFYPEER
  440. Verify the proxy SSL certificate. See \fICURLOPT_PROXY_SSL_VERIFYPEER(3)\fP
  441. .IP CURLOPT_PROXY_TLS13_CIPHERS
  442. Proxy TLS 1.3 cipher suites to use. See \fICURLOPT_PROXY_TLS13_CIPHERS(3)\fP
  443. .IP CURLOPT_PROXY_TLSAUTH_PASSWORD
  444. Proxy TLS authentication password. See \fICURLOPT_PROXY_TLSAUTH_PASSWORD(3)\fP
  445. .IP CURLOPT_PROXY_TLSAUTH_TYPE
  446. Proxy TLS authentication methods. See \fICURLOPT_PROXY_TLSAUTH_TYPE(3)\fP
  447. .IP CURLOPT_PROXY_TLSAUTH_USERNAME
  448. Proxy TLS authentication username. See \fICURLOPT_PROXY_TLSAUTH_USERNAME(3)\fP
  449. .IP CURLOPT_PROXY_TRANSFER_MODE
  450. Add transfer mode to URL over proxy. See \fICURLOPT_PROXY_TRANSFER_MODE(3)\fP
  451. .IP CURLOPT_PUT
  452. \fBDeprecated option\fP Issue an HTTP PUT request. See \fICURLOPT_PUT(3)\fP
  453. .IP CURLOPT_QUICK_EXIT
  454. To be set by toplevel tools like "curl" to skip lengthy cleanups when they are
  455. about to call exit() anyway. See \fICURLOPT_QUICK_EXIT(3)\fP
  456. .IP CURLOPT_QUOTE
  457. Commands to run before transfer. See \fICURLOPT_QUOTE(3)\fP
  458. .IP CURLOPT_RANDOM_FILE
  459. \fBOBSOLETE\fP Provide source for entropy random data.
  460. See \fICURLOPT_RANDOM_FILE(3)\fP
  461. .IP CURLOPT_RANGE
  462. Range requests. See \fICURLOPT_RANGE(3)\fP
  463. .IP CURLOPT_READDATA
  464. Data pointer to pass to the read callback. See \fICURLOPT_READDATA(3)\fP
  465. .IP CURLOPT_READFUNCTION
  466. Callback for reading data. See \fICURLOPT_READFUNCTION(3)\fP
  467. .IP CURLOPT_REDIR_PROTOCOLS
  468. \fBDeprecated option\fP Protocols to allow redirects to. See
  469. \fICURLOPT_REDIR_PROTOCOLS(3)\fP
  470. .IP CURLOPT_REDIR_PROTOCOLS_STR
  471. Protocols to allow redirects to. See \fICURLOPT_REDIR_PROTOCOLS_STR(3)\fP
  472. .IP CURLOPT_REFERER
  473. Referer: header. See \fICURLOPT_REFERER(3)\fP
  474. .IP CURLOPT_REQUEST_TARGET
  475. Set the request target. \fICURLOPT_REQUEST_TARGET(3)\fP
  476. .IP CURLOPT_RESOLVE
  477. Provide fixed/fake name resolves. See \fICURLOPT_RESOLVE(3)\fP
  478. .IP CURLOPT_RESOLVER_START_DATA
  479. Data pointer to pass to resolver start callback. See
  480. \fICURLOPT_RESOLVER_START_DATA(3)\fP
  481. .IP CURLOPT_RESOLVER_START_FUNCTION
  482. Callback to be called before a new resolve request is started. See
  483. \fICURLOPT_RESOLVER_START_FUNCTION(3)\fP
  484. .IP CURLOPT_RESUME_FROM
  485. Resume a transfer. See \fICURLOPT_RESUME_FROM(3)\fP
  486. .IP CURLOPT_RESUME_FROM_LARGE
  487. Resume a transfer. See \fICURLOPT_RESUME_FROM_LARGE(3)\fP
  488. .IP CURLOPT_RTSP_CLIENT_CSEQ
  489. Client CSEQ number. See \fICURLOPT_RTSP_CLIENT_CSEQ(3)\fP
  490. .IP CURLOPT_RTSP_REQUEST
  491. RTSP request. See \fICURLOPT_RTSP_REQUEST(3)\fP
  492. .IP CURLOPT_RTSP_SERVER_CSEQ
  493. CSEQ number for RTSP Server\->Client request. See \fICURLOPT_RTSP_SERVER_CSEQ(3)\fP
  494. .IP CURLOPT_RTSP_SESSION_ID
  495. RTSP session\-id. See \fICURLOPT_RTSP_SESSION_ID(3)\fP
  496. .IP CURLOPT_RTSP_STREAM_URI
  497. RTSP stream URI. See \fICURLOPT_RTSP_STREAM_URI(3)\fP
  498. .IP CURLOPT_RTSP_TRANSPORT
  499. RTSP Transport: header. See \fICURLOPT_RTSP_TRANSPORT(3)\fP
  500. .IP CURLOPT_SASL_AUTHZID
  501. SASL authorization identity (identity to act as). See \fICURLOPT_SASL_AUTHZID(3)\fP
  502. .IP CURLOPT_SASL_IR
  503. Enable SASL initial response. See \fICURLOPT_SASL_IR(3)\fP
  504. .IP CURLOPT_SEEKDATA
  505. Data pointer to pass to the seek callback. See \fICURLOPT_SEEKDATA(3)\fP
  506. .IP CURLOPT_SEEKFUNCTION
  507. Callback for seek operations. See \fICURLOPT_SEEKFUNCTION(3)\fP
  508. .IP CURLOPT_SERVER_RESPONSE_TIMEOUT
  509. Timeout for server responses. See \fICURLOPT_SERVER_RESPONSE_TIMEOUT(3)\fP
  510. .IP CURLOPT_SERVER_RESPONSE_TIMEOUT_MS
  511. Timeout for server responses. See \fICURLOPT_SERVER_RESPONSE_TIMEOUT_MS(3)\fP
  512. .IP CURLOPT_SERVICE_NAME
  513. Authentication service name. \fICURLOPT_SERVICE_NAME(3)\fP
  514. .IP CURLOPT_SHARE
  515. Share object to use. See \fICURLOPT_SHARE(3)\fP
  516. .IP CURLOPT_SOCKOPTDATA
  517. Data pointer to pass to the sockopt callback. See \fICURLOPT_SOCKOPTDATA(3)\fP
  518. .IP CURLOPT_SOCKOPTFUNCTION
  519. Callback for sockopt operations. See \fICURLOPT_SOCKOPTFUNCTION(3)\fP
  520. .IP CURLOPT_SOCKS5_AUTH
  521. Socks5 authentication methods. See \fICURLOPT_SOCKS5_AUTH(3)\fP
  522. .IP CURLOPT_SOCKS5_GSSAPI_NEC
  523. Socks5 GSSAPI NEC mode. See \fICURLOPT_SOCKS5_GSSAPI_NEC(3)\fP
  524. .IP CURLOPT_SOCKS5_GSSAPI_SERVICE
  525. \fBDeprecated option\fP Socks5 GSSAPI service name.
  526. See \fICURLOPT_SOCKS5_GSSAPI_SERVICE(3)\fP
  527. .IP CURLOPT_SSH_AUTH_TYPES
  528. SSH authentication types. See \fICURLOPT_SSH_AUTH_TYPES(3)\fP
  529. .IP CURLOPT_SSH_COMPRESSION
  530. Enable SSH compression. See \fICURLOPT_SSH_COMPRESSION(3)\fP
  531. .IP CURLOPT_SSH_HOSTKEYDATA
  532. Custom pointer to pass to ssh host key callback. See \fICURLOPT_SSH_HOSTKEYDATA(3)\fP
  533. .IP CURLOPT_SSH_HOSTKEYFUNCTION
  534. Callback for checking host key handling. See \fICURLOPT_SSH_HOSTKEYFUNCTION(3)\fP
  535. .IP CURLOPT_SSH_HOST_PUBLIC_KEY_MD5
  536. MD5 of host\(aqs public key. See \fICURLOPT_SSH_HOST_PUBLIC_KEY_MD5(3)\fP
  537. .IP CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256
  538. SHA256 of host\(aqs public key. See \fICURLOPT_SSH_HOST_PUBLIC_KEY_SHA256(3)\fP
  539. .IP CURLOPT_SSH_KEYDATA
  540. Custom pointer to pass to ssh key callback. See \fICURLOPT_SSH_KEYDATA(3)\fP
  541. .IP CURLOPT_SSH_KEYFUNCTION
  542. Callback for known hosts handling. See \fICURLOPT_SSH_KEYFUNCTION(3)\fP
  543. .IP CURLOPT_SSH_KNOWNHOSTS
  544. Filename with known hosts. See \fICURLOPT_SSH_KNOWNHOSTS(3)\fP
  545. .IP CURLOPT_SSH_PRIVATE_KEYFILE
  546. Filename of the private key. See \fICURLOPT_SSH_PRIVATE_KEYFILE(3)\fP
  547. .IP CURLOPT_SSH_PUBLIC_KEYFILE
  548. Filename of the public key. See \fICURLOPT_SSH_PUBLIC_KEYFILE(3)\fP
  549. .IP CURLOPT_SSLCERT
  550. Client cert. See \fICURLOPT_SSLCERT(3)\fP
  551. .IP CURLOPT_SSLCERTTYPE
  552. Client cert type. See \fICURLOPT_SSLCERTTYPE(3)\fP
  553. .IP CURLOPT_SSLCERT_BLOB
  554. Client cert memory buffer. See \fICURLOPT_SSLCERT_BLOB(3)\fP
  555. .IP CURLOPT_SSLENGINE
  556. Use identifier with SSL engine. See \fICURLOPT_SSLENGINE(3)\fP
  557. .IP CURLOPT_SSLENGINE_DEFAULT
  558. Default SSL engine. See \fICURLOPT_SSLENGINE_DEFAULT(3)\fP
  559. .IP CURLOPT_SSLKEY
  560. Client key. See \fICURLOPT_SSLKEY(3)\fP
  561. .IP CURLOPT_SSLKEYTYPE
  562. Client key type. See \fICURLOPT_SSLKEYTYPE(3)\fP
  563. .IP CURLOPT_SSLKEY_BLOB
  564. Client key memory buffer. See \fICURLOPT_SSLKEY_BLOB(3)\fP
  565. .IP CURLOPT_SSLVERSION
  566. SSL version to use. See \fICURLOPT_SSLVERSION(3)\fP
  567. .IP CURLOPT_SSL_CIPHER_LIST
  568. Ciphers to use. See \fICURLOPT_SSL_CIPHER_LIST(3)\fP
  569. .IP CURLOPT_SSL_CTX_DATA
  570. Data pointer to pass to the SSL context callback. See \fICURLOPT_SSL_CTX_DATA(3)\fP
  571. .IP CURLOPT_SSL_CTX_FUNCTION
  572. Callback for SSL context logic. See \fICURLOPT_SSL_CTX_FUNCTION(3)\fP
  573. .IP CURLOPT_SSL_EC_CURVES
  574. Set key exchange curves. See \fICURLOPT_SSL_EC_CURVES(3)\fP
  575. .IP CURLOPT_SSL_ENABLE_ALPN
  576. Enable use of ALPN. See \fICURLOPT_SSL_ENABLE_ALPN(3)\fP
  577. .IP CURLOPT_SSL_ENABLE_NPN
  578. \fBOBSOLETE\fP Enable use of NPN. See \fICURLOPT_SSL_ENABLE_NPN(3)\fP
  579. .IP CURLOPT_SSL_FALSESTART
  580. Enable TLS False Start. See \fICURLOPT_SSL_FALSESTART(3)\fP
  581. .IP CURLOPT_SSL_OPTIONS
  582. Control SSL behavior. See \fICURLOPT_SSL_OPTIONS(3)\fP
  583. .IP CURLOPT_SSL_SESSIONID_CACHE
  584. Disable SSL session\-id cache. See \fICURLOPT_SSL_SESSIONID_CACHE(3)\fP
  585. .IP CURLOPT_SSL_VERIFYHOST
  586. Verify the hostname in the SSL certificate. See \fICURLOPT_SSL_VERIFYHOST(3)\fP
  587. .IP CURLOPT_SSL_VERIFYPEER
  588. Verify the SSL certificate. See \fICURLOPT_SSL_VERIFYPEER(3)\fP
  589. .IP CURLOPT_SSL_VERIFYSTATUS
  590. Verify the SSL certificate\(aqs status. See \fICURLOPT_SSL_VERIFYSTATUS(3)\fP
  591. .IP CURLOPT_STDERR
  592. Redirect stderr to another stream. See \fICURLOPT_STDERR(3)\fP
  593. .IP CURLOPT_STREAM_DEPENDS
  594. This HTTP/2 stream depends on another. See \fICURLOPT_STREAM_DEPENDS(3)\fP
  595. .IP CURLOPT_STREAM_DEPENDS_E
  596. This HTTP/2 stream depends on another exclusively. See
  597. \fICURLOPT_STREAM_DEPENDS_E(3)\fP
  598. .IP CURLOPT_STREAM_WEIGHT
  599. Set this HTTP/2 stream\(aqs weight. See \fICURLOPT_STREAM_WEIGHT(3)\fP
  600. .IP CURLOPT_SUPPRESS_CONNECT_HEADERS
  601. Suppress proxy CONNECT response headers from user callbacks. See
  602. \fICURLOPT_SUPPRESS_CONNECT_HEADERS(3)\fP
  603. .IP CURLOPT_TCP_FASTOPEN
  604. Enable TCP Fast Open. See \fICURLOPT_TCP_FASTOPEN(3)\fP
  605. .IP CURLOPT_TCP_KEEPALIVE
  606. Enable TCP keep\-alive. See \fICURLOPT_TCP_KEEPALIVE(3)\fP
  607. .IP CURLOPT_TCP_KEEPCNT
  608. Maximum number of keep\-alive probes. See \fICURLOPT_TCP_KEEPCNT(3)\fP
  609. .IP CURLOPT_TCP_KEEPIDLE
  610. Idle time before sending keep\-alive. See \fICURLOPT_TCP_KEEPIDLE(3)\fP
  611. .IP CURLOPT_TCP_KEEPINTVL
  612. Interval between keep\-alive probes. See \fICURLOPT_TCP_KEEPINTVL(3)\fP
  613. .IP CURLOPT_TCP_NODELAY
  614. Disable the Nagle algorithm. See \fICURLOPT_TCP_NODELAY(3)\fP
  615. .IP CURLOPT_TELNETOPTIONS
  616. TELNET options. See \fICURLOPT_TELNETOPTIONS(3)\fP
  617. .IP CURLOPT_TFTP_BLKSIZE
  618. TFTP block size. See \fICURLOPT_TFTP_BLKSIZE(3)\fP
  619. .IP CURLOPT_TFTP_NO_OPTIONS
  620. Do not send TFTP options requests. See \fICURLOPT_TFTP_NO_OPTIONS(3)\fP
  621. .IP CURLOPT_TIMECONDITION
  622. Make a time conditional request. See \fICURLOPT_TIMECONDITION(3)\fP
  623. .IP CURLOPT_TIMEOUT
  624. Timeout for the entire request. See \fICURLOPT_TIMEOUT(3)\fP
  625. .IP CURLOPT_TIMEOUT_MS
  626. Millisecond timeout for the entire request. See \fICURLOPT_TIMEOUT_MS(3)\fP
  627. .IP CURLOPT_TIMEVALUE
  628. Time value for the time conditional request. See \fICURLOPT_TIMEVALUE(3)\fP
  629. .IP CURLOPT_TIMEVALUE_LARGE
  630. Time value for the time conditional request. See \fICURLOPT_TIMEVALUE_LARGE(3)\fP
  631. .IP CURLOPT_TLS13_CIPHERS
  632. TLS 1.3 cipher suites to use. See \fICURLOPT_TLS13_CIPHERS(3)\fP
  633. .IP CURLOPT_TLSAUTH_PASSWORD
  634. TLS authentication password. See \fICURLOPT_TLSAUTH_PASSWORD(3)\fP
  635. .IP CURLOPT_TLSAUTH_TYPE
  636. TLS authentication methods. See \fICURLOPT_TLSAUTH_TYPE(3)\fP
  637. .IP CURLOPT_TLSAUTH_USERNAME
  638. TLS authentication username. See \fICURLOPT_TLSAUTH_USERNAME(3)\fP
  639. .IP CURLOPT_TRAILERDATA
  640. Custom pointer passed to the trailing headers callback. See
  641. \fICURLOPT_TRAILERDATA(3)\fP
  642. .IP CURLOPT_TRAILERFUNCTION
  643. Set callback for sending trailing headers. See
  644. \fICURLOPT_TRAILERFUNCTION(3)\fP
  645. .IP CURLOPT_TRANSFERTEXT
  646. Use text transfer. See \fICURLOPT_TRANSFERTEXT(3)\fP
  647. .IP CURLOPT_TRANSFER_ENCODING
  648. Request Transfer\-Encoding. See \fICURLOPT_TRANSFER_ENCODING(3)\fP
  649. .IP CURLOPT_UNIX_SOCKET_PATH
  650. Path to a Unix domain socket. See \fICURLOPT_UNIX_SOCKET_PATH(3)\fP
  651. .IP CURLOPT_UNRESTRICTED_AUTH
  652. Do not restrict authentication to original host. \fICURLOPT_UNRESTRICTED_AUTH(3)\fP
  653. .IP CURLOPT_UPKEEP_INTERVAL_MS
  654. Sets the interval at which connection upkeep are performed. See
  655. \fICURLOPT_UPKEEP_INTERVAL_MS(3)\fP
  656. .IP CURLOPT_UPLOAD
  657. Upload data. See \fICURLOPT_UPLOAD(3)\fP
  658. .IP CURLOPT_UPLOAD_BUFFERSIZE
  659. Set upload buffer size. See \fICURLOPT_UPLOAD_BUFFERSIZE(3)\fP
  660. .IP CURLOPT_URL
  661. URL to work on. See \fICURLOPT_URL(3)\fP
  662. .IP CURLOPT_USERAGENT
  663. User\-Agent: header. See \fICURLOPT_USERAGENT(3)\fP
  664. .IP CURLOPT_USERNAME
  665. Username. See \fICURLOPT_USERNAME(3)\fP
  666. .IP CURLOPT_USERPWD
  667. Username and password. See \fICURLOPT_USERPWD(3)\fP
  668. .IP CURLOPT_USE_SSL
  669. Use TLS/SSL. See \fICURLOPT_USE_SSL(3)\fP
  670. .IP CURLOPT_VERBOSE
  671. Display verbose information. See \fICURLOPT_VERBOSE(3)\fP
  672. .IP CURLOPT_WILDCARDMATCH
  673. Transfer multiple files according to a filename pattern. See
  674. \fICURLOPT_WILDCARDMATCH(3)\fP
  675. .IP CURLOPT_WRITEDATA
  676. Data pointer to pass to the write callback. See \fICURLOPT_WRITEDATA(3)\fP
  677. .IP CURLOPT_WRITEFUNCTION
  678. Callback for writing data. See \fICURLOPT_WRITEFUNCTION(3)\fP
  679. .IP CURLOPT_WS_OPTIONS
  680. Set WebSocket options. See \fICURLOPT_WS_OPTIONS(3)\fP
  681. .IP CURLOPT_XFERINFODATA
  682. Data pointer to pass to the progress meter callback. See
  683. \fICURLOPT_XFERINFODATA(3)\fP
  684. .IP CURLOPT_XFERINFOFUNCTION
  685. Callback for progress meter. See \fICURLOPT_XFERINFOFUNCTION(3)\fP
  686. .IP CURLOPT_XOAUTH2_BEARER
  687. OAuth2 bearer token. See \fICURLOPT_XOAUTH2_BEARER(3)\fP
  688. .SH PROTOCOLS
  689. This functionality affects all supported protocols
  690. .SH EXAMPLE
  691. .nf
  692. int main(void)
  693. {
  694. CURL *curl = curl_easy_init();
  695. if(curl) {
  696. CURLcode res;
  697. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  698. res = curl_easy_perform(curl);
  699. curl_easy_cleanup(curl);
  700. }
  701. }
  702. .fi
  703. .SH AVAILABILITY
  704. Added in curl 7.1
  705. .SH RETURN VALUE
  706. \fICURLE_OK\fP (zero) means that the option was set properly, non\-zero means an
  707. error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl\-errors(3)\fP man
  708. page for the full list with descriptions.
  709. Strings passed on to libcurl must be shorter than 8000000 bytes, otherwise
  710. \fIcurl_easy_setopt(3)\fP returns \fBCURLE_BAD_FUNCTION_ARGUMENT\fP (added in 7.65.0).
  711. \fBCURLE_BAD_FUNCTION_ARGUMENT\fP is returned when the argument to an option is
  712. invalid, like perhaps out of range.
  713. If you try to set an option that libcurl does not know about, perhaps because
  714. the library is too old to support it or the option was removed in a recent
  715. version, this function returns \fICURLE_UNKNOWN_OPTION\fP. If support for the
  716. option was disabled at compile\-time, it returns \fICURLE_NOT_BUILT_IN\fP.
  717. .SH SEE ALSO
  718. .BR curl_easy_cleanup (3),
  719. .BR curl_easy_getinfo (3),
  720. .BR curl_easy_init (3),
  721. .BR curl_easy_option_by_id (3),
  722. .BR curl_easy_option_by_name (3),
  723. .BR curl_easy_option_next (3),
  724. .BR curl_easy_reset (3),
  725. .BR curl_multi_setopt (3)