curl_easy_setopt.3 30 KB

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