curl_easy_setopt.3 32 KB

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