From: Daniel Stenberg Date: Thu, 11 Jul 2024 13:54:25 +0000 (+0200) Subject: libcurl-docs: make option lists alpha-sorted X-Git-Tag: curl-8_9_0~48 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8dab7465a594b1fb4b;p=thirdparty%2Fcurl.git libcurl-docs: make option lists alpha-sorted The man pages for curl_easy_getinfo, curl_easy_setopt and curl_multi_setopt now feature the lists of options alphabetically sorted. Test 1139 verify that they are. The curl_multi_setopt page also got brief explanations of the listed options. Closes #14156 --- diff --git a/docs/libcurl/curl_easy_getinfo.md b/docs/libcurl/curl_easy_getinfo.md index a4e4e4715d..f222ebd2de 100644 --- a/docs/libcurl/curl_easy_getinfo.md +++ b/docs/libcurl/curl_easy_getinfo.md @@ -33,362 +33,335 @@ performed transfer if you want to get transfer related data. You should not free the memory returned by this function unless it is explicitly mentioned below. -# AVAILABLE INFORMATION +# OPTIONS The following information can be extracted: -## CURLINFO_EFFECTIVE_METHOD +## CURLINFO_ACTIVESOCKET -Last used HTTP method. See CURLINFO_EFFECTIVE_METHOD(3) +The session's active socket. See CURLINFO_ACTIVESOCKET(3) -## CURLINFO_EFFECTIVE_URL +## CURLINFO_APPCONNECT_TIME -Last used URL. See CURLINFO_EFFECTIVE_URL(3) +The time it took from the start until the SSL connect/handshake with the +remote host was completed as a double in number of seconds. (Added in 7.19.0) -## CURLINFO_RESPONSE_CODE +## CURLINFO_APPCONNECT_TIME_T -Last received response code. See CURLINFO_RESPONSE_CODE(3) +The time it took from the start until the SSL connect/handshake with the +remote host was completed in number of microseconds. (Added in 7.60.0) See +CURLINFO_APPCONNECT_TIME_T(3) -## CURLINFO_REFERER +## CURLINFO_CAINFO -Referrer header. See CURLINFO_REFERER(3) +Get the default value for CURLOPT_CAINFO(3). See CURLINFO_CAINFO(3) -## CURLINFO_HTTP_CONNECTCODE +## CURLINFO_CAPATH -Last proxy CONNECT response code. See CURLINFO_HTTP_CONNECTCODE(3) +Get the default value for CURLOPT_CAPATH(3). See CURLINFO_CAPATH(3) -## CURLINFO_HTTP_VERSION +## CURLINFO_CERTINFO -The http version used in the connection. See CURLINFO_HTTP_VERSION(3) +Certificate chain. See CURLINFO_CERTINFO(3) -## CURLINFO_FILETIME +## CURLINFO_CONDITION_UNMET -Remote time of the retrieved document. See CURLINFO_FILETIME(3) +Whether or not a time conditional was met or 304 HTTP response. +See CURLINFO_CONDITION_UNMET(3) -## CURLINFO_FILETIME_T +## CURLINFO_CONNECT_TIME -Remote time of the retrieved document. See CURLINFO_FILETIME_T(3) +The time it took from the start until the connect to the remote host (or +proxy) was completed. As a double. See CURLINFO_CONNECT_TIME(3) -## CURLINFO_TOTAL_TIME +## CURLINFO_CONNECT_TIME_T -Total time of previous transfer. See CURLINFO_TOTAL_TIME(3) +The time it took from the start until the connect to the remote host (or +proxy) was completed. In microseconds. See CURLINFO_CONNECT_TIME_T(3). -## CURLINFO_TOTAL_TIME_T +## CURLINFO_CONN_ID -Total time of previous transfer. See CURLINFO_TOTAL_TIME_T(3) +The ID of the last connection used by the transfer. (Added in 8.2.0) +See CURLINFO_CONN_ID(3) -## CURLINFO_NAMELOOKUP_TIME +## CURLINFO_CONTENT_LENGTH_DOWNLOAD -Time from start until name resolving completed. See -CURLINFO_NAMELOOKUP_TIME(3) +(**Deprecated**) Content length from the Content-Length header. +See CURLINFO_CONTENT_LENGTH_DOWNLOAD(3) -## CURLINFO_NAMELOOKUP_TIME_T +## CURLINFO_CONTENT_LENGTH_DOWNLOAD_T -Time from start until name resolving completed. See -CURLINFO_NAMELOOKUP_TIME_T(3) +Content length from the Content-Length header. +See CURLINFO_CONTENT_LENGTH_DOWNLOAD_T(3) -## CURLINFO_CONNECT_TIME +## CURLINFO_CONTENT_LENGTH_UPLOAD -Time from start until remote host or proxy completed. -See CURLINFO_CONNECT_TIME(3) +(**Deprecated**) Upload size. See CURLINFO_CONTENT_LENGTH_UPLOAD(3) -## CURLINFO_CONNECT_TIME_T +## CURLINFO_CONTENT_LENGTH_UPLOAD_T -Time from start until remote host or proxy completed. -See CURLINFO_CONNECT_TIME_T(3) +Upload size. See CURLINFO_CONTENT_LENGTH_UPLOAD_T(3) -## CURLINFO_APPCONNECT_TIME +## CURLINFO_CONTENT_TYPE -Time from start until SSL/SSH handshake completed. -See CURLINFO_APPCONNECT_TIME(3) +Content type from the `Content-Type:` header. We recommend using +curl_easy_header(3) instead. See CURLINFO_CONTENT_TYPE(3) -## CURLINFO_APPCONNECT_TIME_T +## CURLINFO_COOKIELIST -Time from start until SSL/SSH handshake completed. -See CURLINFO_APPCONNECT_TIME_T(3) +List of all known cookies. See CURLINFO_COOKIELIST(3) -## CURLINFO_PRETRANSFER_TIME +## CURLINFO_EFFECTIVE_METHOD -Time from start until just before the transfer begins. -See CURLINFO_PRETRANSFER_TIME(3) +Last used HTTP method. See CURLINFO_EFFECTIVE_METHOD(3) -## CURLINFO_PRETRANSFER_TIME_T +## CURLINFO_EFFECTIVE_URL -Time from start until just before the transfer begins. -See CURLINFO_PRETRANSFER_TIME_T(3) +Last used URL. See CURLINFO_EFFECTIVE_URL(3) -## CURLINFO_QUEUE_TIME_T +## CURLINFO_FILETIME -Time during which this transfer was held in a waiting queue. -See CURLINFO_QUEUE_TIME_T(3) +Remote time of the retrieved document. See CURLINFO_FILETIME(3) -## CURLINFO_USED_PROXY +## CURLINFO_FILETIME_T -Whether the proxy was used (Added in 8.7.0). See CURLINFO_USED_PROXY(3) +Remote time of the retrieved document. See CURLINFO_FILETIME_T(3) -## CURLINFO_STARTTRANSFER_TIME +## CURLINFO_FTP_ENTRY_PATH -Time from start until just when the first byte is received. -See CURLINFO_STARTTRANSFER_TIME(3) +The entry path after logging in to an FTP server. See +CURLINFO_FTP_ENTRY_PATH(3) -## CURLINFO_STARTTRANSFER_TIME_T +## CURLINFO_HEADER_SIZE -Time from start until just when the first byte is received. -See CURLINFO_STARTTRANSFER_TIME_T(3) +Number of bytes of all headers received. See CURLINFO_HEADER_SIZE(3) -## CURLINFO_REDIRECT_TIME +## CURLINFO_HTTPAUTH_AVAIL -Time taken for all redirect steps before the final transfer. -See CURLINFO_REDIRECT_TIME(3) +Available HTTP authentication methods. See CURLINFO_HTTPAUTH_AVAIL(3) -## CURLINFO_REDIRECT_TIME_T +## CURLINFO_HTTP_CONNECTCODE -Time taken for all redirect steps before the final transfer. -See CURLINFO_REDIRECT_TIME_T(3) +Last proxy CONNECT response code. See CURLINFO_HTTP_CONNECTCODE(3) -## CURLINFO_REDIRECT_COUNT +## CURLINFO_HTTP_VERSION -Total number of redirects that were followed. -See CURLINFO_REDIRECT_COUNT(3) +The http version used in the connection. See CURLINFO_HTTP_VERSION(3) -## CURLINFO_REDIRECT_URL +## CURLINFO_LASTSOCKET -URL a redirect would take you to, had you enabled redirects. -See CURLINFO_REDIRECT_URL(3) +(**Deprecated**) Last socket used. See CURLINFO_LASTSOCKET(3) -## CURLINFO_SIZE_UPLOAD +## CURLINFO_LOCAL_IP -(Deprecated) Number of bytes uploaded. -See CURLINFO_SIZE_UPLOAD(3) +Source IP address of the last connection. See CURLINFO_LOCAL_IP(3) -## CURLINFO_SIZE_UPLOAD_T +## CURLINFO_LOCAL_PORT -Number of bytes uploaded. -See CURLINFO_SIZE_UPLOAD_T(3) +Source port number of the last connection. See CURLINFO_LOCAL_PORT(3) -## CURLINFO_SIZE_DOWNLOAD +## CURLINFO_NAMELOOKUP_TIME -(Deprecated) Number of bytes downloaded. -See CURLINFO_SIZE_DOWNLOAD(3) +Time from start until name resolving completed as a double. See +CURLINFO_NAMELOOKUP_TIME(3) -## CURLINFO_SIZE_DOWNLOAD_T +## CURLINFO_NAMELOOKUP_TIME_T -Number of bytes downloaded. -See CURLINFO_SIZE_DOWNLOAD_T(3) +Time from start until name resolving completed in number of microseconds. See +CURLINFO_NAMELOOKUP_TIME_T(3) -## CURLINFO_SPEED_DOWNLOAD +## CURLINFO_NUM_CONNECTS -(Deprecated) Average download speed. -See CURLINFO_SPEED_DOWNLOAD(3) +Number of new successful connections used for previous transfer. +See CURLINFO_NUM_CONNECTS(3) -## CURLINFO_SPEED_DOWNLOAD_T +## CURLINFO_OS_ERRNO -Average download speed. -See CURLINFO_SPEED_DOWNLOAD_T(3) +The errno from the last failure to connect. See CURLINFO_OS_ERRNO(3) -## CURLINFO_SPEED_UPLOAD +## CURLINFO_PRETRANSFER_TIME -(Deprecated) Average upload speed. -See CURLINFO_SPEED_UPLOAD(3) +The time it took from the start until the file transfer is just about to +begin. This includes all pre-transfer commands and negotiations that are +specific to the particular protocol(s) involved. See +CURLINFO_PRETRANSFER_TIME(3) -## CURLINFO_SPEED_UPLOAD_T +## CURLINFO_PRETRANSFER_TIME_T -Average upload speed. -See CURLINFO_SPEED_UPLOAD_T(3) +The time it took from the start until the file transfer is just about to +begin. This includes all pre-transfer commands and negotiations that are +specific to the particular protocol(s) involved. In microseconds. See +CURLINFO_PRETRANSFER_TIME_T(3) -## CURLINFO_HEADER_SIZE +## CURLINFO_PRIMARY_IP -Number of bytes of all headers received. -See CURLINFO_HEADER_SIZE(3) +Destination IP address of the last connection. See CURLINFO_PRIMARY_IP(3) -## CURLINFO_REQUEST_SIZE +## CURLINFO_PRIMARY_PORT -Number of bytes sent in the issued HTTP requests. -See CURLINFO_REQUEST_SIZE(3) +Destination port of the last connection. See CURLINFO_PRIMARY_PORT(3) -## CURLINFO_SSL_VERIFYRESULT +## CURLINFO_PRIVATE -Certificate verification result. -See CURLINFO_SSL_VERIFYRESULT(3) +User's private data pointer. See CURLINFO_PRIVATE(3) -## CURLINFO_PROXY_ERROR +## CURLINFO_PROTOCOL -Detailed proxy error. -See CURLINFO_PROXY_ERROR(3) +(**Deprecated**) The protocol used for the connection. (Added in 7.52.0) See +CURLINFO_PROTOCOL(3) -## CURLINFO_PROXY_SSL_VERIFYRESULT +## CURLINFO_PROXYAUTH_AVAIL -Proxy certificate verification result. -See CURLINFO_PROXY_SSL_VERIFYRESULT(3) +Available HTTP proxy authentication methods. See CURLINFO_PROXYAUTH_AVAIL(3) -## CURLINFO_SSL_ENGINES +## CURLINFO_PROXY_ERROR -A list of OpenSSL crypto engines. -See CURLINFO_SSL_ENGINES(3) +Detailed proxy error. See CURLINFO_PROXY_ERROR(3) -## CURLINFO_CONTENT_LENGTH_DOWNLOAD +## CURLINFO_PROXY_SSL_VERIFYRESULT -(Deprecated) Content length from the Content-Length header. -See CURLINFO_CONTENT_LENGTH_DOWNLOAD(3) +Proxy certificate verification result. See CURLINFO_PROXY_SSL_VERIFYRESULT(3) -## CURLINFO_CONTENT_LENGTH_DOWNLOAD_T +## CURLINFO_QUEUE_TIME_T -Content length from the Content-Length header. -See CURLINFO_CONTENT_LENGTH_DOWNLOAD_T(3) +The time during which the transfer was held in a waiting queue before it could +start for real in number of microseconds. (Added in 8.6.0) See +CURLINFO_QUEUE_TIME_T(3) -## CURLINFO_CONTENT_LENGTH_UPLOAD +## CURLINFO_REDIRECT_COUNT -(Deprecated) Upload size. See CURLINFO_CONTENT_LENGTH_UPLOAD(3) +Total number of redirects that were followed. See CURLINFO_REDIRECT_COUNT(3) -## CURLINFO_CONTENT_LENGTH_UPLOAD_T +## CURLINFO_REDIRECT_TIME -Upload size. See CURLINFO_CONTENT_LENGTH_UPLOAD_T(3) +The time it took for all redirection steps include name lookup, connect, +pretransfer and transfer before final transaction was started. So, this is +zero if no redirection took place. As a double. See CURLINFO_REDIRECT_TIME(3) -## CURLINFO_CONTENT_TYPE +## CURLINFO_REDIRECT_TIME_T -Content type from the Content-Type header. -See CURLINFO_CONTENT_TYPE(3) +The time it took for all redirection steps include name lookup, connect, +pretransfer and transfer before final transaction was started. So, this is +zero if no redirection took place. In number of microseconds. See +CURLINFO_REDIRECT_TIME_T(3) -## CURLINFO_RETRY_AFTER +## CURLINFO_REDIRECT_URL -The value from the Retry-After header. -See CURLINFO_RETRY_AFTER(3) +URL a redirect would take you to, had you enabled redirects. See +CURLINFO_REDIRECT_URL(3) -## CURLINFO_PRIVATE +## CURLINFO_REFERER -User's private data pointer. -See CURLINFO_PRIVATE(3) +Referrer header. See CURLINFO_REFERER(3) -## CURLINFO_HTTPAUTH_AVAIL +## CURLINFO_REQUEST_SIZE -Available HTTP authentication methods. -See CURLINFO_HTTPAUTH_AVAIL(3) +Number of bytes sent in the issued HTTP requests. See CURLINFO_REQUEST_SIZE(3) -## CURLINFO_PROXYAUTH_AVAIL +## CURLINFO_RESPONSE_CODE -Available HTTP proxy authentication methods. -See CURLINFO_PROXYAUTH_AVAIL(3) +Last received response code. See CURLINFO_RESPONSE_CODE(3) -## CURLINFO_OS_ERRNO +## CURLINFO_RETRY_AFTER -The errno from the last failure to connect. -See CURLINFO_OS_ERRNO(3) +The value from the Retry-After header. See CURLINFO_RETRY_AFTER(3) -## CURLINFO_NUM_CONNECTS +## CURLINFO_RTSP_CLIENT_CSEQ -Number of new successful connections used for previous transfer. -See CURLINFO_NUM_CONNECTS(3) +The RTSP client CSeq that is expected next. See CURLINFO_RTSP_CLIENT_CSEQ(3) -## CURLINFO_PRIMARY_IP +## CURLINFO_RTSP_CSEQ_RECV -Destination IP address of the last connection. -See CURLINFO_PRIMARY_IP(3) +RTSP CSeq last received. See CURLINFO_RTSP_CSEQ_RECV(3) -## CURLINFO_PRIMARY_PORT +## CURLINFO_RTSP_SERVER_CSEQ -Destination port of the last connection. -See CURLINFO_PRIMARY_PORT(3) +The RTSP server CSeq that is expected next. See CURLINFO_RTSP_SERVER_CSEQ(3) -## CURLINFO_LOCAL_IP +## CURLINFO_RTSP_SESSION_ID -Source IP address of the last connection. -See CURLINFO_LOCAL_IP(3) +RTSP session ID. See CURLINFO_RTSP_SESSION_ID(3) -## CURLINFO_LOCAL_PORT +## CURLINFO_SCHEME -Source port number of the last connection. -See CURLINFO_LOCAL_PORT(3) +The scheme used for the connection. (Added in 7.52.0) See CURLINFO_SCHEME(3) -## CURLINFO_COOKIELIST +## CURLINFO_SIZE_DOWNLOAD -List of all known cookies. -See CURLINFO_COOKIELIST(3) +(**Deprecated**) Number of bytes downloaded. See CURLINFO_SIZE_DOWNLOAD(3) -## CURLINFO_LASTSOCKET +## CURLINFO_SIZE_DOWNLOAD_T -(Deprecated) Last socket used. -See CURLINFO_LASTSOCKET(3) +Number of bytes downloaded. See CURLINFO_SIZE_DOWNLOAD_T(3) -## CURLINFO_ACTIVESOCKET +## CURLINFO_SIZE_UPLOAD -The session's active socket. -See CURLINFO_ACTIVESOCKET(3) +(**Deprecated**) Number of bytes uploaded. See CURLINFO_SIZE_UPLOAD(3) -## CURLINFO_FTP_ENTRY_PATH +## CURLINFO_SIZE_UPLOAD_T -The entry path after logging in to an FTP server. -See CURLINFO_FTP_ENTRY_PATH(3) +Number of bytes uploaded. See CURLINFO_SIZE_UPLOAD_T(3) -## CURLINFO_CAPATH +## CURLINFO_SPEED_DOWNLOAD -Get the default value for CURLOPT_CAPATH(3). -See CURLINFO_CAPATH(3) +(**Deprecated**) Average download speed. See CURLINFO_SPEED_DOWNLOAD(3) -## CURLINFO_CAINFO +## CURLINFO_SPEED_DOWNLOAD_T -Get the default value for CURLOPT_CAINFO(3). -See CURLINFO_CAINFO(3) +Average download speed. See CURLINFO_SPEED_DOWNLOAD_T(3) -## CURLINFO_CERTINFO +## CURLINFO_SPEED_UPLOAD -Certificate chain. -See CURLINFO_CERTINFO(3) +(**Deprecated**) Average upload speed. See CURLINFO_SPEED_UPLOAD(3) -## CURLINFO_TLS_SSL_PTR +## CURLINFO_SPEED_UPLOAD_T -TLS session info that can be used for further processing. -See CURLINFO_TLS_SSL_PTR(3) +Average upload speed in number of bytes per second. See +CURLINFO_SPEED_UPLOAD_T(3) -## CURLINFO_TLS_SESSION +## CURLINFO_SSL_ENGINES -TLS session info that can be used for further processing. See -CURLINFO_TLS_SESSION(3). Deprecated option, use -CURLINFO_TLS_SSL_PTR(3) instead! +A list of OpenSSL crypto engines. See CURLINFO_SSL_ENGINES(3) -## CURLINFO_CONDITION_UNMET +## CURLINFO_SSL_VERIFYRESULT -Whether or not a time conditional was met or 304 HTTP response. -See CURLINFO_CONDITION_UNMET(3) +Certificate verification result. See CURLINFO_SSL_VERIFYRESULT(3) -## CURLINFO_RTSP_SESSION_ID +## CURLINFO_STARTTRANSFER_TIME -RTSP session ID. -See CURLINFO_RTSP_SESSION_ID(3) +The time it took from the start until the first byte is received by libcurl. +As a double. See CURLINFO_STARTTRANSFER_TIME(3) -## CURLINFO_RTSP_CLIENT_CSEQ +## CURLINFO_STARTTRANSFER_TIME_T -The RTSP client CSeq that is expected next. -See CURLINFO_RTSP_CLIENT_CSEQ(3) +The time it took from the start until the first byte is received by libcurl. +In microseconds. See CURLINFO_STARTTRANSFER_TIME_T(3) -## CURLINFO_RTSP_SERVER_CSEQ +## CURLINFO_TLS_SESSION -The RTSP server CSeq that is expected next. -See CURLINFO_RTSP_SERVER_CSEQ(3) +(**Deprecated**) TLS session info that can be used for further processing. See +CURLINFO_TLS_SESSION(3). Use CURLINFO_TLS_SSL_PTR(3) instead! -## CURLINFO_RTSP_CSEQ_RECV +## CURLINFO_TLS_SSL_PTR -RTSP CSeq last received. -See CURLINFO_RTSP_CSEQ_RECV(3) +TLS session info that can be used for further processing. See +CURLINFO_TLS_SSL_PTR(3) -## CURLINFO_PROTOCOL +## CURLINFO_TOTAL_TIME -(Deprecated) The protocol used for the connection. (Added in 7.52.0) -See CURLINFO_PROTOCOL(3) +Total time of previous transfer. See CURLINFO_TOTAL_TIME(3) -## CURLINFO_SCHEME +## CURLINFO_TOTAL_TIME_T -The scheme used for the connection. (Added in 7.52.0) -See CURLINFO_SCHEME(3) +Total time of previous transfer. See CURLINFO_TOTAL_TIME_T(3) -## CURLINFO_CONN_ID +## CURLINFO_USED_PROXY -The ID of the last connection used by the transfer. (Added in 8.2.0) -See CURLINFO_CONN_ID(3) +Whether the proxy was used (Added in 8.7.0). See CURLINFO_USED_PROXY(3) ## CURLINFO_XFER_ID -The ID of the transfer. (Added in 8.2.0) -See CURLINFO_XFER_ID(3) +The ID of the transfer. (Added in 8.2.0) See CURLINFO_XFER_ID(3) # TIMES @@ -405,51 +378,11 @@ An overview of the time values available from curl_easy_getinfo(3) |--|--|--|--|--|--|--TOTAL |--|--|--|--|--|--|--REDIRECT -## CURLINFO_QUEUE_TIME - -CURLINFO_QUEUE_TIME_T(3). The time during which the transfer was held in a -waiting queue before it could start for real. (Added in 8.6.0) - -## CURLINFO_NAMELOOKUP_TIME - -CURLINFO_NAMELOOKUP_TIME(3) and CURLINFO_NAMELOOKUP_TIME_T(3). The time it -took from the start until the name resolving was completed. - -## CURLINFO_CONNECT_TIME - -CURLINFO_CONNECT_TIME(3) and CURLINFO_CONNECT_TIME_T(3). The time it took from -the start until the connect to the remote host (or proxy) was completed. - -## CURLINFO_APPCONNECT_TIME - -CURLINFO_APPCONNECT_TIME(3) and CURLINFO_APPCONNECT_TIME_T(3). The time it -took from the start until the SSL connect/handshake with the remote host was -completed. (Added in 7.19.0) The latter is the integer version (measuring -microseconds). (Added in 7.60.0) - -## CURLINFO_PRETRANSFER_TIME - -CURLINFO_PRETRANSFER_TIME(3) and CURLINFO_PRETRANSFER_TIME_T(3). The time it -took from the start until the file transfer is just about to begin. This -includes all pre-transfer commands and negotiations that are specific to the -particular protocol(s) involved. - -## CURLINFO_STARTTRANSFER_TIME - -CURLINFO_STARTTRANSFER_TIME(3) and CURLINFO_STARTTRANSFER_TIME_T(3). The time -it took from the start until the first byte is received by libcurl. - -## CURLINFO_TOTAL_TIME - -CURLINFO_TOTAL_TIME(3) and CURLINFO_TOTAL_TIME_T(3). Total time -of the previous request. - -## CURLINFO_REDIRECT_TIME -CURLINFO_REDIRECT_TIME(3) and CURLINFO_REDIRECT_TIME_T(3). The time it took -for all redirection steps include name lookup, connect, pretransfer and -transfer before final transaction was started. So, this is zero if no -redirection took place. + CURLINFO_QUEUE_TIME_T(3), CURLINFO_NAMELOOKUP_TIME_T(3), + CURLINFO_CONNECT_TIME_T(3), CURLINFO_APPCONNECT_TIME_T(3), + CURLINFO_PRETRANSFER_TIME_T(3), CURLINFO_STARTTRANSFER_TIME_T(3), + CURLINFO_TOTAL_TIME_T(3), CURLINFO_REDIRECT_TIME_T(3) # EXAMPLE diff --git a/docs/libcurl/curl_easy_setopt.md b/docs/libcurl/curl_easy_setopt.md index e571b60cc3..0e68934fd5 100644 --- a/docs/libcurl/curl_easy_setopt.md +++ b/docs/libcurl/curl_easy_setopt.md @@ -62,1034 +62,1046 @@ keep them available until libcurl no longer needed them. The *handle* is the return code from a curl_easy_init(3) or curl_easy_duphandle(3) call. -# BEHAVIOR OPTIONS +# OPTIONS -## CURLOPT_VERBOSE +## CURLOPT_ABSTRACT_UNIX_SOCKET -Display verbose information. See CURLOPT_VERBOSE(3) +Path to an abstract Unix domain socket. See CURLOPT_ABSTRACT_UNIX_SOCKET(3) -## CURLOPT_HEADER +## CURLOPT_ACCEPTTIMEOUT_MS -Include the header in the body output. See CURLOPT_HEADER(3) +Timeout for waiting for the server's connect back to be accepted. See +CURLOPT_ACCEPTTIMEOUT_MS(3) -## CURLOPT_NOPROGRESS +## CURLOPT_ACCEPT_ENCODING -Shut off the progress meter. See CURLOPT_NOPROGRESS(3) +Accept-Encoding and automatic decompressing data. See +CURLOPT_ACCEPT_ENCODING(3) -## CURLOPT_NOSIGNAL +## CURLOPT_ADDRESS_SCOPE -Do not install signal handlers. See CURLOPT_NOSIGNAL(3) +IPv6 scope for local addresses. See CURLOPT_ADDRESS_SCOPE(3) -## CURLOPT_WILDCARDMATCH +## CURLOPT_ALTSVC -Transfer multiple files according to a filename pattern. See -CURLOPT_WILDCARDMATCH(3) +Specify the Alt-Svc: cache filename. See CURLOPT_ALTSVC(3) -# CALLBACK OPTIONS +## CURLOPT_ALTSVC_CTRL -## CURLOPT_WRITEFUNCTION +Enable and configure Alt-Svc: treatment. See CURLOPT_ALTSVC_CTRL(3) -Callback for writing data. See CURLOPT_WRITEFUNCTION(3) +## CURLOPT_APPEND -## CURLOPT_WRITEDATA +Append to remote file. See CURLOPT_APPEND(3) -Data pointer to pass to the write callback. See CURLOPT_WRITEDATA(3) +## CURLOPT_AUTOREFERER -## CURLOPT_READFUNCTION +Automatically set Referer: header. See CURLOPT_AUTOREFERER(3) -Callback for reading data. See CURLOPT_READFUNCTION(3) +## CURLOPT_AWS_SIGV4 -## CURLOPT_READDATA +AWS HTTP V4 Signature. See CURLOPT_AWS_SIGV4(3) -Data pointer to pass to the read callback. See CURLOPT_READDATA(3) +## CURLOPT_BUFFERSIZE -## CURLOPT_IOCTLFUNCTION +Ask for alternate buffer size. See CURLOPT_BUFFERSIZE(3) -**Deprecated option** Callback for I/O operations. -See CURLOPT_IOCTLFUNCTION(3) +## CURLOPT_CAINFO -## CURLOPT_IOCTLDATA +CA cert bundle. See CURLOPT_CAINFO(3) -**Deprecated option** Data pointer to pass to the I/O callback. -See CURLOPT_IOCTLDATA(3) +## CURLOPT_CAINFO_BLOB -## CURLOPT_SEEKFUNCTION +CA cert bundle memory buffer. See CURLOPT_CAINFO_BLOB(3) -Callback for seek operations. See CURLOPT_SEEKFUNCTION(3) +## CURLOPT_CAPATH -## CURLOPT_SEEKDATA +Path to CA cert bundle. See CURLOPT_CAPATH(3) -Data pointer to pass to the seek callback. See CURLOPT_SEEKDATA(3) +## CURLOPT_CA_CACHE_TIMEOUT -## CURLOPT_SOCKOPTFUNCTION +Timeout for CA cache. See CURLOPT_CA_CACHE_TIMEOUT(3) -Callback for sockopt operations. See CURLOPT_SOCKOPTFUNCTION(3) +## CURLOPT_CERTINFO -## CURLOPT_SOCKOPTDATA +Extract certificate info. See CURLOPT_CERTINFO(3) -Data pointer to pass to the sockopt callback. See CURLOPT_SOCKOPTDATA(3) +## CURLOPT_CHUNK_BGN_FUNCTION -## CURLOPT_OPENSOCKETFUNCTION +Callback for wildcard download start of chunk. See +CURLOPT_CHUNK_BGN_FUNCTION(3) -Callback for socket creation. See CURLOPT_OPENSOCKETFUNCTION(3) +## CURLOPT_CHUNK_DATA -## CURLOPT_OPENSOCKETDATA +Data pointer to pass to the chunk callbacks. See CURLOPT_CHUNK_DATA(3) -Data pointer to pass to the open socket callback. See CURLOPT_OPENSOCKETDATA(3) +## CURLOPT_CHUNK_END_FUNCTION + +Callback for wildcard download end of chunk. See CURLOPT_CHUNK_END_FUNCTION(3) + +## CURLOPT_CLOSESOCKETDATA + +Data pointer to pass to the close socket callback. See +CURLOPT_CLOSESOCKETDATA(3) ## CURLOPT_CLOSESOCKETFUNCTION Callback for closing socket. See CURLOPT_CLOSESOCKETFUNCTION(3) -## CURLOPT_CLOSESOCKETDATA +## CURLOPT_CONNECTTIMEOUT -Data pointer to pass to the close socket callback. See CURLOPT_CLOSESOCKETDATA(3) +Timeout for the connection phase. See CURLOPT_CONNECTTIMEOUT(3) -## CURLOPT_PROGRESSFUNCTION +## CURLOPT_CONNECTTIMEOUT_MS -**OBSOLETE** callback for progress meter. -See CURLOPT_PROGRESSFUNCTION(3) +Millisecond timeout for the connection phase. See CURLOPT_CONNECTTIMEOUT_MS(3) -## CURLOPT_PROGRESSDATA +## CURLOPT_CONNECT_ONLY -Data pointer to pass to the progress meter callback. See CURLOPT_PROGRESSDATA(3) +Only connect, nothing else. See CURLOPT_CONNECT_ONLY(3) -## CURLOPT_XFERINFOFUNCTION +## CURLOPT_CONNECT_TO -Callback for progress meter. See CURLOPT_XFERINFOFUNCTION(3) +Connect to a specific host and port. See CURLOPT_CONNECT_TO(3) -## CURLOPT_XFERINFODATA +## CURLOPT_CONV_FROM_NETWORK_FUNCTION -Data pointer to pass to the progress meter callback. See CURLOPT_XFERINFODATA(3) +**OBSOLETE** Callback for code base conversion. +See CURLOPT_CONV_FROM_NETWORK_FUNCTION(3) -## CURLOPT_HEADERFUNCTION +## CURLOPT_CONV_FROM_UTF8_FUNCTION -Callback for writing received headers. See CURLOPT_HEADERFUNCTION(3) +**OBSOLETE** Callback for code base conversion. +See CURLOPT_CONV_FROM_UTF8_FUNCTION(3) -## CURLOPT_HEADERDATA +## CURLOPT_CONV_TO_NETWORK_FUNCTION -Data pointer to pass to the header callback. See CURLOPT_HEADERDATA(3) +**OBSOLETE** Callback for code base conversion. +See CURLOPT_CONV_TO_NETWORK_FUNCTION(3) -## CURLOPT_DEBUGFUNCTION +## CURLOPT_COOKIE -Callback for debug information. See CURLOPT_DEBUGFUNCTION(3) +Cookie(s) to send. See CURLOPT_COOKIE(3) -## CURLOPT_DEBUGDATA +## CURLOPT_COOKIEFILE -Data pointer to pass to the debug callback. See CURLOPT_DEBUGDATA(3) +File to read cookies from. See CURLOPT_COOKIEFILE(3) -## CURLOPT_SSL_CTX_FUNCTION +## CURLOPT_COOKIEJAR -Callback for SSL context logic. See CURLOPT_SSL_CTX_FUNCTION(3) +File to write cookies to. See CURLOPT_COOKIEJAR(3) -## CURLOPT_SSL_CTX_DATA +## CURLOPT_COOKIELIST -Data pointer to pass to the SSL context callback. See CURLOPT_SSL_CTX_DATA(3) +Add or control cookies. See CURLOPT_COOKIELIST(3) -## CURLOPT_CONV_TO_NETWORK_FUNCTION +## CURLOPT_COOKIESESSION -**OBSOLETE** Callback for code base conversion. -See CURLOPT_CONV_TO_NETWORK_FUNCTION(3) +Start a new cookie session. See CURLOPT_COOKIESESSION(3) -## CURLOPT_CONV_FROM_NETWORK_FUNCTION +## CURLOPT_COPYPOSTFIELDS -**OBSOLETE** Callback for code base conversion. -See CURLOPT_CONV_FROM_NETWORK_FUNCTION(3) +Send a POST with this data - and copy it. See CURLOPT_COPYPOSTFIELDS(3) -## CURLOPT_CONV_FROM_UTF8_FUNCTION +## CURLOPT_CRLF -**OBSOLETE** Callback for code base conversion. -See CURLOPT_CONV_FROM_UTF8_FUNCTION(3) +Convert newlines. See CURLOPT_CRLF(3) -## CURLOPT_INTERLEAVEFUNCTION +## CURLOPT_CRLFILE -Callback for RTSP interleaved data. See CURLOPT_INTERLEAVEFUNCTION(3) +Certificate Revocation List. See CURLOPT_CRLFILE(3) -## CURLOPT_INTERLEAVEDATA +## CURLOPT_CURLU -Data pointer to pass to the RTSP interleave callback. See CURLOPT_INTERLEAVEDATA(3) +Set URL to work on with a URL handle. See CURLOPT_CURLU(3) -## CURLOPT_CHUNK_BGN_FUNCTION +## CURLOPT_CUSTOMREQUEST -Callback for wildcard download start of chunk. See CURLOPT_CHUNK_BGN_FUNCTION(3) +Custom request/method. See CURLOPT_CUSTOMREQUEST(3) -## CURLOPT_CHUNK_END_FUNCTION +## CURLOPT_DEBUGDATA -Callback for wildcard download end of chunk. See CURLOPT_CHUNK_END_FUNCTION(3) +Data pointer to pass to the debug callback. See CURLOPT_DEBUGDATA(3) -## CURLOPT_CHUNK_DATA +## CURLOPT_DEBUGFUNCTION -Data pointer to pass to the chunk callbacks. See CURLOPT_CHUNK_DATA(3) +Callback for debug information. See CURLOPT_DEBUGFUNCTION(3) -## CURLOPT_FNMATCH_FUNCTION +## CURLOPT_DEFAULT_PROTOCOL -Callback for wildcard matching. See CURLOPT_FNMATCH_FUNCTION(3) +Default protocol. See CURLOPT_DEFAULT_PROTOCOL(3) -## CURLOPT_FNMATCH_DATA +## CURLOPT_DIRLISTONLY -Data pointer to pass to the wildcard matching callback. See CURLOPT_FNMATCH_DATA(3) +List only. See CURLOPT_DIRLISTONLY(3) -## CURLOPT_SUPPRESS_CONNECT_HEADERS +## CURLOPT_DISALLOW_USERNAME_IN_URL -Suppress proxy CONNECT response headers from user callbacks. See -CURLOPT_SUPPRESS_CONNECT_HEADERS(3) +Do not allow username in URL. See CURLOPT_DISALLOW_USERNAME_IN_URL(3) -## CURLOPT_RESOLVER_START_FUNCTION +## CURLOPT_DNS_CACHE_TIMEOUT -Callback to be called before a new resolve request is started. See -CURLOPT_RESOLVER_START_FUNCTION(3) +Timeout for DNS cache. See CURLOPT_DNS_CACHE_TIMEOUT(3) -## CURLOPT_RESOLVER_START_DATA +## CURLOPT_DNS_INTERFACE -Data pointer to pass to resolver start callback. See CURLOPT_RESOLVER_START_DATA(3) +Bind name resolves to this interface. See CURLOPT_DNS_INTERFACE(3) -## CURLOPT_PREREQFUNCTION +## CURLOPT_DNS_LOCAL_IP4 -Callback to be called after a connection is established but before a request -is made on that connection. See CURLOPT_PREREQFUNCTION(3) +Bind name resolves to this IP4 address. See CURLOPT_DNS_LOCAL_IP4(3) -## CURLOPT_PREREQDATA +## CURLOPT_DNS_LOCAL_IP6 -Data pointer to pass to the CURLOPT_PREREQFUNCTION callback. See -CURLOPT_PREREQDATA(3) +Bind name resolves to this IP6 address. See CURLOPT_DNS_LOCAL_IP6(3) -# ERROR OPTIONS +## CURLOPT_DNS_SERVERS -## CURLOPT_ERRORBUFFER +Preferred DNS servers. See CURLOPT_DNS_SERVERS(3) -Error message buffer. See CURLOPT_ERRORBUFFER(3) +## CURLOPT_DNS_SHUFFLE_ADDRESSES -## CURLOPT_STDERR +Shuffle addresses before use. See CURLOPT_DNS_SHUFFLE_ADDRESSES(3) -stderr replacement stream. See CURLOPT_STDERR(3) +## CURLOPT_DNS_USE_GLOBAL_CACHE -## CURLOPT_FAILONERROR +**OBSOLETE** Enable global DNS cache. See CURLOPT_DNS_USE_GLOBAL_CACHE(3) -Fail on HTTP 4xx errors. CURLOPT_FAILONERROR(3) +## CURLOPT_DOH_SSL_VERIFYHOST -## CURLOPT_KEEP_SENDING_ON_ERROR +Verify the hostname in the DoH (DNS-over-HTTPS) SSL certificate. See +CURLOPT_DOH_SSL_VERIFYHOST(3) -Keep sending on HTTP \>= 300 errors. CURLOPT_KEEP_SENDING_ON_ERROR(3) +## CURLOPT_DOH_SSL_VERIFYPEER -# NETWORK OPTIONS +Verify the DoH (DNS-over-HTTPS) SSL certificate. See +CURLOPT_DOH_SSL_VERIFYPEER(3) -## CURLOPT_URL +## CURLOPT_DOH_SSL_VERIFYSTATUS -URL to work on. See CURLOPT_URL(3) +Verify the DoH (DNS-over-HTTPS) SSL certificate's status. See +CURLOPT_DOH_SSL_VERIFYSTATUS(3) -## CURLOPT_PATH_AS_IS +## CURLOPT_DOH_URL -Disable squashing /../ and /./ sequences in the path. See CURLOPT_PATH_AS_IS(3) +Use this DoH server for name resolves. See CURLOPT_DOH_URL(3) -## CURLOPT_PROTOCOLS +## CURLOPT_ECH -**Deprecated option** Allowed protocols. See CURLOPT_PROTOCOLS(3) +Set the configuration for ECH. See CURLOPT_ECH(3) -## CURLOPT_PROTOCOLS_STR +## CURLOPT_EGDSOCKET -Allowed protocols. See CURLOPT_PROTOCOLS_STR(3) +**OBSOLETE** Identify EGD socket for entropy. See CURLOPT_EGDSOCKET(3) -## CURLOPT_REDIR_PROTOCOLS +## CURLOPT_ERRORBUFFER -**Deprecated option** Protocols to allow redirects to. See -CURLOPT_REDIR_PROTOCOLS(3) +Error message buffer. See CURLOPT_ERRORBUFFER(3) -## CURLOPT_REDIR_PROTOCOLS_STR +## CURLOPT_EXPECT_100_TIMEOUT_MS -Protocols to allow redirects to. See CURLOPT_REDIR_PROTOCOLS_STR(3) +100-continue timeout. See CURLOPT_EXPECT_100_TIMEOUT_MS(3) -## CURLOPT_DEFAULT_PROTOCOL +## CURLOPT_FAILONERROR -Default protocol. See CURLOPT_DEFAULT_PROTOCOL(3) +Fail on HTTP 4xx errors. CURLOPT_FAILONERROR(3) -## CURLOPT_PROXY +## CURLOPT_FILETIME -Proxy to use. See CURLOPT_PROXY(3) +Request file modification date and time. See CURLOPT_FILETIME(3) -## CURLOPT_PRE_PROXY +## CURLOPT_FNMATCH_DATA -Socks proxy to use. See CURLOPT_PRE_PROXY(3) +Data pointer to pass to the wildcard matching callback. See +CURLOPT_FNMATCH_DATA(3) -## CURLOPT_PROXYPORT +## CURLOPT_FNMATCH_FUNCTION -Proxy port to use. See CURLOPT_PROXYPORT(3) +Callback for wildcard matching. See CURLOPT_FNMATCH_FUNCTION(3) -## CURLOPT_PROXYTYPE +## CURLOPT_FOLLOWLOCATION -Proxy type. See CURLOPT_PROXYTYPE(3) +Follow HTTP redirects. See CURLOPT_FOLLOWLOCATION(3) -## CURLOPT_NOPROXY +## CURLOPT_FORBID_REUSE -Filter out hosts from proxy use. CURLOPT_NOPROXY(3) +Prevent subsequent connections from reusing this. See CURLOPT_FORBID_REUSE(3) -## CURLOPT_HTTPPROXYTUNNEL +## CURLOPT_FRESH_CONNECT -Tunnel through the HTTP proxy. CURLOPT_HTTPPROXYTUNNEL(3) +Use a new connection. CURLOPT_FRESH_CONNECT(3) -## CURLOPT_CONNECT_TO +## CURLOPT_FTPPORT -Connect to a specific host and port. See CURLOPT_CONNECT_TO(3) +Use active FTP. See CURLOPT_FTPPORT(3) -## CURLOPT_SOCKS5_AUTH +## CURLOPT_FTPSSLAUTH -Socks5 authentication methods. See CURLOPT_SOCKS5_AUTH(3) +Control how to do TLS. See CURLOPT_FTPSSLAUTH(3) -## CURLOPT_SOCKS5_GSSAPI_SERVICE +## CURLOPT_FTP_ACCOUNT -**Deprecated option** Socks5 GSSAPI service name. -See CURLOPT_SOCKS5_GSSAPI_SERVICE(3) +Send ACCT command. See CURLOPT_FTP_ACCOUNT(3) -## CURLOPT_SOCKS5_GSSAPI_NEC +## CURLOPT_FTP_ALTERNATIVE_TO_USER -Socks5 GSSAPI NEC mode. See CURLOPT_SOCKS5_GSSAPI_NEC(3) +Alternative to USER. See CURLOPT_FTP_ALTERNATIVE_TO_USER(3) -## CURLOPT_PROXY_SERVICE_NAME +## CURLOPT_FTP_CREATE_MISSING_DIRS -Proxy authentication service name. CURLOPT_PROXY_SERVICE_NAME(3) +Create missing directories on the remote server. See +CURLOPT_FTP_CREATE_MISSING_DIRS(3) -## CURLOPT_HAPROXYPROTOCOL +## CURLOPT_FTP_FILEMETHOD -Send an HAProxy PROXY protocol v1 header. See CURLOPT_HAPROXYPROTOCOL(3) +Specify how to reach files. See CURLOPT_FTP_FILEMETHOD(3) -## CURLOPT_HAPROXY_CLIENT_IP +## CURLOPT_FTP_SKIP_PASV_IP -Spoof the client IP in an HAProxy PROXY protocol v1 header. See -CURLOPT_HAPROXY_CLIENT_IP(3) +Ignore the IP address in the PASV response. See CURLOPT_FTP_SKIP_PASV_IP(3) -## CURLOPT_SERVICE_NAME +## CURLOPT_FTP_SSL_CCC -Authentication service name. CURLOPT_SERVICE_NAME(3) +Back to non-TLS again after authentication. See CURLOPT_FTP_SSL_CCC(3) -## CURLOPT_INTERFACE +## CURLOPT_FTP_USE_EPRT -Bind connection locally to this. See CURLOPT_INTERFACE(3) +Use EPRT. See CURLOPT_FTP_USE_EPRT(3) -## CURLOPT_LOCALPORT +## CURLOPT_FTP_USE_EPSV -Bind connection locally to this port. See CURLOPT_LOCALPORT(3) +Use EPSV. See CURLOPT_FTP_USE_EPSV(3) -## CURLOPT_LOCALPORTRANGE +## CURLOPT_FTP_USE_PRET -Bind connection locally to port range. See CURLOPT_LOCALPORTRANGE(3) +Use PRET. See CURLOPT_FTP_USE_PRET(3) -## CURLOPT_DNS_CACHE_TIMEOUT +## CURLOPT_GSSAPI_DELEGATION -Timeout for DNS cache. See CURLOPT_DNS_CACHE_TIMEOUT(3) +Disable GSS-API delegation. See CURLOPT_GSSAPI_DELEGATION(3) -## CURLOPT_DNS_USE_GLOBAL_CACHE +## CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS -**OBSOLETE** Enable global DNS cache. -See CURLOPT_DNS_USE_GLOBAL_CACHE(3) +Timeout for happy eyeballs. See CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS(3) -## CURLOPT_DOH_URL +## CURLOPT_HAPROXYPROTOCOL -Use this DoH server for name resolves. See CURLOPT_DOH_URL(3) +Send an HAProxy PROXY protocol v1 header. See CURLOPT_HAPROXYPROTOCOL(3) -## CURLOPT_BUFFERSIZE +## CURLOPT_HAPROXY_CLIENT_IP -Ask for alternate buffer size. See CURLOPT_BUFFERSIZE(3) +Spoof the client IP in an HAProxy PROXY protocol v1 header. See +CURLOPT_HAPROXY_CLIENT_IP(3) -## CURLOPT_PORT +## CURLOPT_HEADER -Port number to connect to. See CURLOPT_PORT(3) +Include the header in the body output. See CURLOPT_HEADER(3) -## CURLOPT_TCP_FASTOPEN +## CURLOPT_HEADERDATA -Enable TCP Fast Open. See CURLOPT_TCP_FASTOPEN(3) +Data pointer to pass to the header callback. See CURLOPT_HEADERDATA(3) -## CURLOPT_TCP_NODELAY +## CURLOPT_HEADERFUNCTION -Disable the Nagle algorithm. See CURLOPT_TCP_NODELAY(3) +Callback for writing received headers. See CURLOPT_HEADERFUNCTION(3) -## CURLOPT_ADDRESS_SCOPE +## CURLOPT_HEADEROPT -IPv6 scope for local addresses. See CURLOPT_ADDRESS_SCOPE(3) +Control custom headers. See CURLOPT_HEADEROPT(3) -## CURLOPT_TCP_KEEPALIVE +## CURLOPT_HSTS -Enable TCP keep-alive. See CURLOPT_TCP_KEEPALIVE(3) +Set HSTS cache file. See CURLOPT_HSTS(3) -## CURLOPT_TCP_KEEPIDLE +## CURLOPT_HSTSREADDATA -Idle time before sending keep-alive. See CURLOPT_TCP_KEEPIDLE(3) +Pass pointer to the HSTS read callback. See CURLOPT_HSTSREADDATA(3) -## CURLOPT_TCP_KEEPINTVL +## CURLOPT_HSTSREADFUNCTION -Interval between keep-alive probes. See CURLOPT_TCP_KEEPINTVL(3) +Set HSTS read callback. See CURLOPT_HSTSREADFUNCTION(3) -## CURLOPT_TCP_KEEPCNT +## CURLOPT_HSTSWRITEDATA -Maximum number of keep-alive probes. See CURLOPT_TCP_KEEPCNT(3) +Pass pointer to the HSTS write callback. See CURLOPT_HSTSWRITEDATA(3) -## CURLOPT_UNIX_SOCKET_PATH +## CURLOPT_HSTSWRITEFUNCTION -Path to a Unix domain socket. See CURLOPT_UNIX_SOCKET_PATH(3) +Set HSTS write callback. See CURLOPT_HSTSWRITEFUNCTION(3) -## CURLOPT_ABSTRACT_UNIX_SOCKET +## CURLOPT_HSTS_CTRL -Path to an abstract Unix domain socket. See CURLOPT_ABSTRACT_UNIX_SOCKET(3) +Enable HSTS. See CURLOPT_HSTS_CTRL(3) -# NAMES and PASSWORDS OPTIONS (Authentication) +## CURLOPT_HTTP09_ALLOWED -## CURLOPT_NETRC +Allow HTTP/0.9 responses. CURLOPT_HTTP09_ALLOWED(3) -Enable .netrc parsing. See CURLOPT_NETRC(3) +## CURLOPT_HTTP200ALIASES -## CURLOPT_NETRC_FILE +Alternative versions of 200 OK. See CURLOPT_HTTP200ALIASES(3) -.netrc filename. See CURLOPT_NETRC_FILE(3) +## CURLOPT_HTTPAUTH -## CURLOPT_USERPWD +HTTP server authentication methods. See CURLOPT_HTTPAUTH(3) -Username and password. See CURLOPT_USERPWD(3) +## CURLOPT_HTTPGET -## CURLOPT_PROXYUSERPWD +Do an HTTP GET request. See CURLOPT_HTTPGET(3) -Proxy username and password. See CURLOPT_PROXYUSERPWD(3) +## CURLOPT_HTTPHEADER -## CURLOPT_USERNAME +Custom HTTP headers. See CURLOPT_HTTPHEADER(3) -Username. See CURLOPT_USERNAME(3) +## CURLOPT_HTTPPOST -## CURLOPT_PASSWORD +**Deprecated option** Multipart formpost HTTP POST. +See CURLOPT_HTTPPOST(3) -Password. See CURLOPT_PASSWORD(3) +## CURLOPT_HTTPPROXYTUNNEL -## CURLOPT_LOGIN_OPTIONS +Tunnel through the HTTP proxy. CURLOPT_HTTPPROXYTUNNEL(3) -Login options. See CURLOPT_LOGIN_OPTIONS(3) +## CURLOPT_HTTP_CONTENT_DECODING -## CURLOPT_PROXYUSERNAME +Disable Content decoding. See CURLOPT_HTTP_CONTENT_DECODING(3) -Proxy username. See CURLOPT_PROXYUSERNAME(3) +## CURLOPT_HTTP_TRANSFER_DECODING -## CURLOPT_PROXYPASSWORD +Disable Transfer decoding. See CURLOPT_HTTP_TRANSFER_DECODING(3) -Proxy password. See CURLOPT_PROXYPASSWORD(3) +## CURLOPT_HTTP_VERSION -## CURLOPT_HTTPAUTH +HTTP version to use. CURLOPT_HTTP_VERSION(3) -HTTP server authentication methods. See CURLOPT_HTTPAUTH(3) +## CURLOPT_IGNORE_CONTENT_LENGTH -## CURLOPT_TLSAUTH_USERNAME +Ignore Content-Length. See CURLOPT_IGNORE_CONTENT_LENGTH(3) -TLS authentication username. See CURLOPT_TLSAUTH_USERNAME(3) +## CURLOPT_INFILESIZE -## CURLOPT_PROXY_TLSAUTH_USERNAME +Size of file to send. CURLOPT_INFILESIZE(3) -Proxy TLS authentication username. See CURLOPT_PROXY_TLSAUTH_USERNAME(3) +## CURLOPT_INFILESIZE_LARGE -## CURLOPT_TLSAUTH_PASSWORD +Size of file to send. CURLOPT_INFILESIZE_LARGE(3) -TLS authentication password. See CURLOPT_TLSAUTH_PASSWORD(3) +## CURLOPT_INTERFACE -## CURLOPT_PROXY_TLSAUTH_PASSWORD +Bind connection locally to this. See CURLOPT_INTERFACE(3) -Proxy TLS authentication password. See CURLOPT_PROXY_TLSAUTH_PASSWORD(3) +## CURLOPT_INTERLEAVEDATA -## CURLOPT_TLSAUTH_TYPE +Data pointer to pass to the RTSP interleave callback. See +CURLOPT_INTERLEAVEDATA(3) -TLS authentication methods. See CURLOPT_TLSAUTH_TYPE(3) +## CURLOPT_INTERLEAVEFUNCTION -## CURLOPT_PROXY_TLSAUTH_TYPE +Callback for RTSP interleaved data. See CURLOPT_INTERLEAVEFUNCTION(3) -Proxy TLS authentication methods. See CURLOPT_PROXY_TLSAUTH_TYPE(3) +## CURLOPT_IOCTLDATA -## CURLOPT_PROXYAUTH +**Deprecated option** Data pointer to pass to the I/O callback. +See CURLOPT_IOCTLDATA(3) -HTTP proxy authentication methods. See CURLOPT_PROXYAUTH(3) +## CURLOPT_IOCTLFUNCTION -## CURLOPT_SASL_AUTHZID +**Deprecated option** Callback for I/O operations. +See CURLOPT_IOCTLFUNCTION(3) -SASL authorization identity (identity to act as). See CURLOPT_SASL_AUTHZID(3) +## CURLOPT_IPRESOLVE -## CURLOPT_SASL_IR +IP version to use. See CURLOPT_IPRESOLVE(3) -Enable SASL initial response. See CURLOPT_SASL_IR(3) +## CURLOPT_ISSUERCERT -## CURLOPT_XOAUTH2_BEARER +Issuer certificate. See CURLOPT_ISSUERCERT(3) -OAuth2 bearer token. See CURLOPT_XOAUTH2_BEARER(3) +## CURLOPT_ISSUERCERT_BLOB -## CURLOPT_DISALLOW_USERNAME_IN_URL +Issuer certificate memory buffer. See CURLOPT_ISSUERCERT_BLOB(3) -Do not allow username in URL. See CURLOPT_DISALLOW_USERNAME_IN_URL(3) +## CURLOPT_KEEP_SENDING_ON_ERROR -# HTTP OPTIONS +Keep sending on HTTP \>= 300 errors. CURLOPT_KEEP_SENDING_ON_ERROR(3) -## CURLOPT_AUTOREFERER +## CURLOPT_KEYPASSWD -Automatically set Referer: header. See CURLOPT_AUTOREFERER(3) +Client key password. See CURLOPT_KEYPASSWD(3) -## CURLOPT_ACCEPT_ENCODING +## CURLOPT_KRBLEVEL -Accept-Encoding and automatic decompressing data. See CURLOPT_ACCEPT_ENCODING(3) +Kerberos security level. See CURLOPT_KRBLEVEL(3) -## CURLOPT_TRANSFER_ENCODING +## CURLOPT_LOCALPORT -Request Transfer-Encoding. See CURLOPT_TRANSFER_ENCODING(3) +Bind connection locally to this port. See CURLOPT_LOCALPORT(3) -## CURLOPT_FOLLOWLOCATION +## CURLOPT_LOCALPORTRANGE -Follow HTTP redirects. See CURLOPT_FOLLOWLOCATION(3) +Bind connection locally to port range. See CURLOPT_LOCALPORTRANGE(3) -## CURLOPT_UNRESTRICTED_AUTH +## CURLOPT_LOGIN_OPTIONS -Do not restrict authentication to original host. CURLOPT_UNRESTRICTED_AUTH(3) +Login options. See CURLOPT_LOGIN_OPTIONS(3) -## CURLOPT_MAXREDIRS +## CURLOPT_LOW_SPEED_LIMIT + +Low speed limit to abort transfer. See CURLOPT_LOW_SPEED_LIMIT(3) + +## CURLOPT_LOW_SPEED_TIME -Maximum number of redirects to follow. See CURLOPT_MAXREDIRS(3) +Time to be below the speed to trigger low speed abort. See +CURLOPT_LOW_SPEED_TIME(3) -## CURLOPT_POSTREDIR +## CURLOPT_MAIL_AUTH -How to act on redirects after POST. See CURLOPT_POSTREDIR(3) +Authentication address. See CURLOPT_MAIL_AUTH(3) -## CURLOPT_PUT +## CURLOPT_MAIL_FROM -**Deprecated option** Issue an HTTP PUT request. See CURLOPT_PUT(3) +Address of the sender. See CURLOPT_MAIL_FROM(3) -## CURLOPT_POST +## CURLOPT_MAIL_RCPT -Issue an HTTP POST request. See CURLOPT_POST(3) +Address of the recipients. See CURLOPT_MAIL_RCPT(3) -## CURLOPT_POSTFIELDS +## CURLOPT_MAIL_RCPT_ALLOWFAILS -Send a POST with this data. See CURLOPT_POSTFIELDS(3) +Allow RCPT TO command to fail for some recipients. See +CURLOPT_MAIL_RCPT_ALLOWFAILS(3) -## CURLOPT_POSTFIELDSIZE +## CURLOPT_MAXAGE_CONN -The POST data is this big. See CURLOPT_POSTFIELDSIZE(3) +Limit the age (idle time) of connections for reuse. See CURLOPT_MAXAGE_CONN(3) -## CURLOPT_POSTFIELDSIZE_LARGE +## CURLOPT_MAXCONNECTS -The POST data is this big. See CURLOPT_POSTFIELDSIZE_LARGE(3) +Maximum number of connections in the connection pool. See +CURLOPT_MAXCONNECTS(3) -## CURLOPT_COPYPOSTFIELDS +## CURLOPT_MAXFILESIZE -Send a POST with this data - and copy it. See CURLOPT_COPYPOSTFIELDS(3) +Maximum file size to get. See CURLOPT_MAXFILESIZE(3) -## CURLOPT_HTTPPOST +## CURLOPT_MAXFILESIZE_LARGE -**Deprecated option** Multipart formpost HTTP POST. -See CURLOPT_HTTPPOST(3) +Maximum file size to get. See CURLOPT_MAXFILESIZE_LARGE(3) -## CURLOPT_REFERER +## CURLOPT_MAXLIFETIME_CONN -Referer: header. See CURLOPT_REFERER(3) +Limit the age (since creation) of connections for reuse. See +CURLOPT_MAXLIFETIME_CONN(3) -## CURLOPT_USERAGENT +## CURLOPT_MAXREDIRS -User-Agent: header. See CURLOPT_USERAGENT(3) +Maximum number of redirects to follow. See CURLOPT_MAXREDIRS(3) -## CURLOPT_HTTPHEADER +## CURLOPT_MAX_RECV_SPEED_LARGE -Custom HTTP headers. See CURLOPT_HTTPHEADER(3) +Cap the download speed to this. See CURLOPT_MAX_RECV_SPEED_LARGE(3) -## CURLOPT_HEADEROPT +## CURLOPT_MAX_SEND_SPEED_LARGE -Control custom headers. See CURLOPT_HEADEROPT(3) +Cap the upload speed to this. See CURLOPT_MAX_SEND_SPEED_LARGE(3) -## CURLOPT_PROXYHEADER +## CURLOPT_MIMEPOST -Custom HTTP headers sent to proxy. See CURLOPT_PROXYHEADER(3) +Post/send MIME data. See CURLOPT_MIMEPOST(3) -## CURLOPT_HTTP200ALIASES +## CURLOPT_MIME_OPTIONS -Alternative versions of 200 OK. See CURLOPT_HTTP200ALIASES(3) +Set MIME option flags. See CURLOPT_MIME_OPTIONS(3) -## CURLOPT_COOKIE +## CURLOPT_NETRC -Cookie(s) to send. See CURLOPT_COOKIE(3) +Enable .netrc parsing. See CURLOPT_NETRC(3) -## CURLOPT_COOKIEFILE +## CURLOPT_NETRC_FILE -File to read cookies from. See CURLOPT_COOKIEFILE(3) +.netrc filename. See CURLOPT_NETRC_FILE(3) -## CURLOPT_COOKIEJAR +## CURLOPT_NEW_DIRECTORY_PERMS -File to write cookies to. See CURLOPT_COOKIEJAR(3) +Mode for creating new remote directories. See CURLOPT_NEW_DIRECTORY_PERMS(3) -## CURLOPT_COOKIESESSION +## CURLOPT_NEW_FILE_PERMS -Start a new cookie session. See CURLOPT_COOKIESESSION(3) +Mode for creating new remote files. See CURLOPT_NEW_FILE_PERMS(3) -## CURLOPT_COOKIELIST +## CURLOPT_NOBODY -Add or control cookies. See CURLOPT_COOKIELIST(3) +Do not get the body contents. See CURLOPT_NOBODY(3) -## CURLOPT_ALTSVC +## CURLOPT_NOPROGRESS -Specify the Alt-Svc: cache filename. See CURLOPT_ALTSVC(3) +Shut off the progress meter. See CURLOPT_NOPROGRESS(3) -## CURLOPT_ALTSVC_CTRL +## CURLOPT_NOPROXY -Enable and configure Alt-Svc: treatment. See CURLOPT_ALTSVC_CTRL(3) +Filter out hosts from proxy use. CURLOPT_NOPROXY(3) -## CURLOPT_HSTS +## CURLOPT_NOSIGNAL -Set HSTS cache file. See CURLOPT_HSTS(3) +Do not install signal handlers. See CURLOPT_NOSIGNAL(3) -## CURLOPT_HSTS_CTRL +## CURLOPT_OPENSOCKETDATA -Enable HSTS. See CURLOPT_HSTS_CTRL(3) +Data pointer to pass to the open socket callback. See CURLOPT_OPENSOCKETDATA(3) -## CURLOPT_HSTSREADFUNCTION +## CURLOPT_OPENSOCKETFUNCTION -Set HSTS read callback. See CURLOPT_HSTSREADFUNCTION(3) +Callback for socket creation. See CURLOPT_OPENSOCKETFUNCTION(3) -## CURLOPT_HSTSREADDATA +## CURLOPT_PASSWORD -Pass pointer to the HSTS read callback. See CURLOPT_HSTSREADDATA(3) +Password. See CURLOPT_PASSWORD(3) -## CURLOPT_HSTSWRITEFUNCTION +## CURLOPT_PATH_AS_IS -Set HSTS write callback. See CURLOPT_HSTSWRITEFUNCTION(3) +Disable squashing /../ and /./ sequences in the path. See CURLOPT_PATH_AS_IS(3) -## CURLOPT_HSTSWRITEDATA +## CURLOPT_PINNEDPUBLICKEY -Pass pointer to the HSTS write callback. See CURLOPT_HSTSWRITEDATA(3) +Set pinned SSL public key . See CURLOPT_PINNEDPUBLICKEY(3) -## CURLOPT_HTTPGET +## CURLOPT_PIPEWAIT -Do an HTTP GET request. See CURLOPT_HTTPGET(3) +Wait on connection to pipeline on it. See CURLOPT_PIPEWAIT(3) -## CURLOPT_REQUEST_TARGET +## CURLOPT_PORT -Set the request target. CURLOPT_REQUEST_TARGET(3) +Port number to connect to. See CURLOPT_PORT(3) -## CURLOPT_HTTP_VERSION +## CURLOPT_POST -HTTP version to use. CURLOPT_HTTP_VERSION(3) +Make an HTTP POST. See CURLOPT_POST(3) -## CURLOPT_HTTP09_ALLOWED +## CURLOPT_POSTFIELDSIZE -Allow HTTP/0.9 responses. CURLOPT_HTTP09_ALLOWED(3) +The POST data is this big. See CURLOPT_POSTFIELDSIZE(3) -## CURLOPT_IGNORE_CONTENT_LENGTH +## CURLOPT_POSTFIELDSIZE_LARGE -Ignore Content-Length. See CURLOPT_IGNORE_CONTENT_LENGTH(3) +The POST data is this big. See CURLOPT_POSTFIELDSIZE_LARGE(3) -## CURLOPT_HTTP_CONTENT_DECODING +## CURLOPT_POSTQUOTE -Disable Content decoding. See CURLOPT_HTTP_CONTENT_DECODING(3) +Commands to run after transfer. See CURLOPT_POSTQUOTE(3) -## CURLOPT_HTTP_TRANSFER_DECODING +## CURLOPT_POSTREDIR -Disable Transfer decoding. See CURLOPT_HTTP_TRANSFER_DECODING(3) +How to act on redirects after POST. See CURLOPT_POSTREDIR(3) -## CURLOPT_EXPECT_100_TIMEOUT_MS +## CURLOPT_PREQUOTE -100-continue timeout. See CURLOPT_EXPECT_100_TIMEOUT_MS(3) +Commands to run just before transfer. See CURLOPT_PREQUOTE(3) -## CURLOPT_TRAILERFUNCTION +## CURLOPT_PREREQDATA -Set callback for sending trailing headers. See -CURLOPT_TRAILERFUNCTION(3) +Data pointer to pass to the CURLOPT_PREREQFUNCTION callback. See +CURLOPT_PREREQDATA(3) -## CURLOPT_TRAILERDATA +## CURLOPT_PREREQFUNCTION -Custom pointer passed to the trailing headers callback. See -CURLOPT_TRAILERDATA(3) +Callback to be called after a connection is established but before a request +is made on that connection. See CURLOPT_PREREQFUNCTION(3) -## CURLOPT_PIPEWAIT +## CURLOPT_PRE_PROXY -Wait on connection to pipeline on it. See CURLOPT_PIPEWAIT(3) +Socks proxy to use. See CURLOPT_PRE_PROXY(3) -## CURLOPT_STREAM_DEPENDS +## CURLOPT_PRIVATE -This HTTP/2 stream depends on another. See CURLOPT_STREAM_DEPENDS(3) +Private pointer to store. See CURLOPT_PRIVATE(3) -## CURLOPT_STREAM_DEPENDS_E +## CURLOPT_PROGRESSDATA -This HTTP/2 stream depends on another exclusively. See -CURLOPT_STREAM_DEPENDS_E(3) +Data pointer to pass to the progress meter callback. See +CURLOPT_PROGRESSDATA(3) -## CURLOPT_STREAM_WEIGHT +## CURLOPT_PROGRESSFUNCTION -Set this HTTP/2 stream's weight. See CURLOPT_STREAM_WEIGHT(3) +**OBSOLETE** callback for progress meter. See CURLOPT_PROGRESSFUNCTION(3) -# SMTP OPTIONS +## CURLOPT_PROTOCOLS -## CURLOPT_MAIL_FROM +**Deprecated option** Allowed protocols. See CURLOPT_PROTOCOLS(3) -Address of the sender. See CURLOPT_MAIL_FROM(3) +## CURLOPT_PROTOCOLS_STR -## CURLOPT_MAIL_RCPT +Allowed protocols. See CURLOPT_PROTOCOLS_STR(3) -Address of the recipients. See CURLOPT_MAIL_RCPT(3) +## CURLOPT_PROXY -## CURLOPT_MAIL_AUTH +Proxy to use. See CURLOPT_PROXY(3) -Authentication address. See CURLOPT_MAIL_AUTH(3) +## CURLOPT_PROXYAUTH -## CURLOPT_MAIL_RCPT_ALLOWFAILS +HTTP proxy authentication methods. See CURLOPT_PROXYAUTH(3) -Allow RCPT TO command to fail for some recipients. See -CURLOPT_MAIL_RCPT_ALLOWFAILS(3) +## CURLOPT_PROXYHEADER -# TFTP OPTIONS +Custom HTTP headers sent to proxy. See CURLOPT_PROXYHEADER(3) -## CURLOPT_TFTP_BLKSIZE +## CURLOPT_PROXYPASSWORD -TFTP block size. See CURLOPT_TFTP_BLKSIZE(3) +Proxy password. See CURLOPT_PROXYPASSWORD(3) -## CURLOPT_TFTP_NO_OPTIONS +## CURLOPT_PROXYPORT -Do not send TFTP options requests. See CURLOPT_TFTP_NO_OPTIONS(3) +Proxy port to use. See CURLOPT_PROXYPORT(3) -# FTP OPTIONS +## CURLOPT_PROXYTYPE -## CURLOPT_FTPPORT +Proxy type. See CURLOPT_PROXYTYPE(3) -Use active FTP. See CURLOPT_FTPPORT(3) +## CURLOPT_PROXYUSERNAME +Proxy username. See CURLOPT_PROXYUSERNAME(3) -## CURLOPT_QUOTE +## CURLOPT_PROXYUSERPWD -Commands to run before transfer. See CURLOPT_QUOTE(3) +Proxy username and password. See CURLOPT_PROXYUSERPWD(3) -## CURLOPT_POSTQUOTE +## CURLOPT_PROXY_CAINFO -Commands to run after transfer. See CURLOPT_POSTQUOTE(3) +Proxy CA cert bundle. See CURLOPT_PROXY_CAINFO(3) -## CURLOPT_PREQUOTE +## CURLOPT_PROXY_CAINFO_BLOB -Commands to run just before transfer. See CURLOPT_PREQUOTE(3) +Proxy CA cert bundle memory buffer. See CURLOPT_PROXY_CAINFO_BLOB(3) -## CURLOPT_APPEND +## CURLOPT_PROXY_CAPATH -Append to remote file. See CURLOPT_APPEND(3) +Path to proxy CA cert bundle. See CURLOPT_PROXY_CAPATH(3) -## CURLOPT_FTP_USE_EPRT +## CURLOPT_PROXY_CRLFILE -Use EPRT. See CURLOPT_FTP_USE_EPRT(3) +Proxy Certificate Revocation List. See CURLOPT_PROXY_CRLFILE(3) -## CURLOPT_FTP_USE_EPSV +## CURLOPT_PROXY_ISSUERCERT -Use EPSV. See CURLOPT_FTP_USE_EPSV(3) +Proxy issuer certificate. See CURLOPT_PROXY_ISSUERCERT(3) -## CURLOPT_FTP_USE_PRET +## CURLOPT_PROXY_ISSUERCERT_BLOB -Use PRET. See CURLOPT_FTP_USE_PRET(3) +Proxy issuer certificate memory buffer. See CURLOPT_PROXY_ISSUERCERT_BLOB(3) -## CURLOPT_FTP_CREATE_MISSING_DIRS +## CURLOPT_PROXY_KEYPASSWD -Create missing directories on the remote server. See CURLOPT_FTP_CREATE_MISSING_DIRS(3) +Proxy client key password. See CURLOPT_PROXY_KEYPASSWD(3) -## CURLOPT_SERVER_RESPONSE_TIMEOUT +## CURLOPT_PROXY_PINNEDPUBLICKEY -Timeout for server responses. See CURLOPT_SERVER_RESPONSE_TIMEOUT(3) +Set the proxy's pinned SSL public key. See +CURLOPT_PROXY_PINNEDPUBLICKEY(3) -## CURLOPT_SERVER_RESPONSE_TIMEOUT_MS +## CURLOPT_PROXY_SERVICE_NAME -Timeout for server responses. See CURLOPT_SERVER_RESPONSE_TIMEOUT_MS(3) +Proxy authentication service name. CURLOPT_PROXY_SERVICE_NAME(3) -## CURLOPT_FTP_ALTERNATIVE_TO_USER +## CURLOPT_PROXY_SSLCERT -Alternative to USER. See CURLOPT_FTP_ALTERNATIVE_TO_USER(3) +Proxy client cert. See CURLOPT_PROXY_SSLCERT(3) -## CURLOPT_FTP_SKIP_PASV_IP +## CURLOPT_PROXY_SSLCERTTYPE -Ignore the IP address in the PASV response. See CURLOPT_FTP_SKIP_PASV_IP(3) +Proxy client cert type. See CURLOPT_PROXY_SSLCERTTYPE(3) -## CURLOPT_FTPSSLAUTH +## CURLOPT_PROXY_SSLCERT_BLOB -Control how to do TLS. See CURLOPT_FTPSSLAUTH(3) +Proxy client cert memory buffer. See CURLOPT_PROXY_SSLCERT_BLOB(3) -## CURLOPT_FTP_SSL_CCC +## CURLOPT_PROXY_SSLKEY -Back to non-TLS again after authentication. See CURLOPT_FTP_SSL_CCC(3) +Proxy client key. See CURLOPT_PROXY_SSLKEY(3) -## CURLOPT_FTP_ACCOUNT +## CURLOPT_PROXY_SSLKEYTYPE -Send ACCT command. See CURLOPT_FTP_ACCOUNT(3) +Proxy client key type. See CURLOPT_PROXY_SSLKEYTYPE(3) -## CURLOPT_FTP_FILEMETHOD +## CURLOPT_PROXY_SSLKEY_BLOB -Specify how to reach files. See CURLOPT_FTP_FILEMETHOD(3) +Proxy client key. See CURLOPT_PROXY_SSLKEY_BLOB(3) -# RTSP OPTIONS +## CURLOPT_PROXY_SSLVERSION -## CURLOPT_RTSP_REQUEST +Proxy SSL version to use. See CURLOPT_PROXY_SSLVERSION(3) -RTSP request. See CURLOPT_RTSP_REQUEST(3) +## CURLOPT_PROXY_SSL_CIPHER_LIST -## CURLOPT_RTSP_SESSION_ID +Proxy ciphers to use. See CURLOPT_PROXY_SSL_CIPHER_LIST(3) -RTSP session-id. See CURLOPT_RTSP_SESSION_ID(3) +## CURLOPT_PROXY_SSL_OPTIONS -## CURLOPT_RTSP_STREAM_URI +Control proxy SSL behavior. See CURLOPT_PROXY_SSL_OPTIONS(3) -RTSP stream URI. See CURLOPT_RTSP_STREAM_URI(3) +## CURLOPT_PROXY_SSL_VERIFYHOST -## CURLOPT_RTSP_TRANSPORT +Verify the hostname in the proxy SSL certificate. See +CURLOPT_PROXY_SSL_VERIFYHOST(3) -RTSP Transport: header. See CURLOPT_RTSP_TRANSPORT(3) +## CURLOPT_PROXY_SSL_VERIFYPEER -## CURLOPT_RTSP_CLIENT_CSEQ +Verify the proxy SSL certificate. See CURLOPT_PROXY_SSL_VERIFYPEER(3) -Client CSEQ number. See CURLOPT_RTSP_CLIENT_CSEQ(3) +## CURLOPT_PROXY_TLS13_CIPHERS -## CURLOPT_RTSP_SERVER_CSEQ +Proxy TLS 1.3 cipher suites to use. See CURLOPT_PROXY_TLS13_CIPHERS(3) -CSEQ number for RTSP Server-\>Client request. See CURLOPT_RTSP_SERVER_CSEQ(3) +## CURLOPT_PROXY_TLSAUTH_PASSWORD -## CURLOPT_AWS_SIGV4 +Proxy TLS authentication password. See CURLOPT_PROXY_TLSAUTH_PASSWORD(3) -AWS HTTP V4 Signature. See CURLOPT_AWS_SIGV4(3) +## CURLOPT_PROXY_TLSAUTH_TYPE -# PROTOCOL OPTIONS +Proxy TLS authentication methods. See CURLOPT_PROXY_TLSAUTH_TYPE(3) -## CURLOPT_TRANSFERTEXT +## CURLOPT_PROXY_TLSAUTH_USERNAME -Use text transfer. See CURLOPT_TRANSFERTEXT(3) +Proxy TLS authentication username. See CURLOPT_PROXY_TLSAUTH_USERNAME(3) ## CURLOPT_PROXY_TRANSFER_MODE Add transfer mode to URL over proxy. See CURLOPT_PROXY_TRANSFER_MODE(3) -## CURLOPT_CRLF +## CURLOPT_PUT -Convert newlines. See CURLOPT_CRLF(3) +**Deprecated option** Issue an HTTP PUT request. See CURLOPT_PUT(3) -## CURLOPT_RANGE +## CURLOPT_QUICK_EXIT -Range requests. See CURLOPT_RANGE(3) +To be set by toplevel tools like "curl" to skip lengthy cleanups when they are +about to call exit() anyway. See CURLOPT_QUICK_EXIT(3) -## CURLOPT_RESUME_FROM +## CURLOPT_QUOTE -Resume a transfer. See CURLOPT_RESUME_FROM(3) +Commands to run before transfer. See CURLOPT_QUOTE(3) -## CURLOPT_RESUME_FROM_LARGE +## CURLOPT_RANDOM_FILE -Resume a transfer. See CURLOPT_RESUME_FROM_LARGE(3) +**OBSOLETE** Provide source for entropy random data. +See CURLOPT_RANDOM_FILE(3) -## CURLOPT_CURLU +## CURLOPT_RANGE -Set URL to work on with a URL handle. See CURLOPT_CURLU(3) +Range requests. See CURLOPT_RANGE(3) -## CURLOPT_CUSTOMREQUEST +## CURLOPT_READDATA -Custom request/method. See CURLOPT_CUSTOMREQUEST(3) +Data pointer to pass to the read callback. See CURLOPT_READDATA(3) -## CURLOPT_FILETIME +## CURLOPT_READFUNCTION -Request file modification date and time. See CURLOPT_FILETIME(3) +Callback for reading data. See CURLOPT_READFUNCTION(3) -## CURLOPT_DIRLISTONLY +## CURLOPT_REDIR_PROTOCOLS -List only. See CURLOPT_DIRLISTONLY(3) +**Deprecated option** Protocols to allow redirects to. See +CURLOPT_REDIR_PROTOCOLS(3) -## CURLOPT_NOBODY +## CURLOPT_REDIR_PROTOCOLS_STR -Do not get the body contents. See CURLOPT_NOBODY(3) +Protocols to allow redirects to. See CURLOPT_REDIR_PROTOCOLS_STR(3) -## CURLOPT_INFILESIZE +## CURLOPT_REFERER -Size of file to send. CURLOPT_INFILESIZE(3) +Referer: header. See CURLOPT_REFERER(3) -## CURLOPT_INFILESIZE_LARGE +## CURLOPT_REQUEST_TARGET -Size of file to send. CURLOPT_INFILESIZE_LARGE(3) +Set the request target. CURLOPT_REQUEST_TARGET(3) -## CURLOPT_UPLOAD +## CURLOPT_RESOLVE -Upload data. See CURLOPT_UPLOAD(3) +Provide fixed/fake name resolves. See CURLOPT_RESOLVE(3) -## CURLOPT_UPLOAD_BUFFERSIZE +## CURLOPT_RESOLVER_START_DATA -Set upload buffer size. See CURLOPT_UPLOAD_BUFFERSIZE(3) +Data pointer to pass to resolver start callback. See +CURLOPT_RESOLVER_START_DATA(3) -## CURLOPT_MIMEPOST +## CURLOPT_RESOLVER_START_FUNCTION -Post/send MIME data. See CURLOPT_MIMEPOST(3) +Callback to be called before a new resolve request is started. See +CURLOPT_RESOLVER_START_FUNCTION(3) -## CURLOPT_MIME_OPTIONS +## CURLOPT_RESUME_FROM -Set MIME option flags. See CURLOPT_MIME_OPTIONS(3) +Resume a transfer. See CURLOPT_RESUME_FROM(3) -## CURLOPT_MAXFILESIZE +## CURLOPT_RESUME_FROM_LARGE -Maximum file size to get. See CURLOPT_MAXFILESIZE(3) +Resume a transfer. See CURLOPT_RESUME_FROM_LARGE(3) -## CURLOPT_MAXFILESIZE_LARGE +## CURLOPT_RTSP_CLIENT_CSEQ -Maximum file size to get. See CURLOPT_MAXFILESIZE_LARGE(3) +Client CSEQ number. See CURLOPT_RTSP_CLIENT_CSEQ(3) -## CURLOPT_TIMECONDITION +## CURLOPT_RTSP_REQUEST -Make a time conditional request. See CURLOPT_TIMECONDITION(3) +RTSP request. See CURLOPT_RTSP_REQUEST(3) -## CURLOPT_TIMEVALUE +## CURLOPT_RTSP_SERVER_CSEQ -Time value for the time conditional request. See CURLOPT_TIMEVALUE(3) +CSEQ number for RTSP Server-\>Client request. See CURLOPT_RTSP_SERVER_CSEQ(3) -## CURLOPT_TIMEVALUE_LARGE +## CURLOPT_RTSP_SESSION_ID -Time value for the time conditional request. See CURLOPT_TIMEVALUE_LARGE(3) +RTSP session-id. See CURLOPT_RTSP_SESSION_ID(3) -# CONNECTION OPTIONS +## CURLOPT_RTSP_STREAM_URI -## CURLOPT_TIMEOUT +RTSP stream URI. See CURLOPT_RTSP_STREAM_URI(3) -Timeout for the entire request. See CURLOPT_TIMEOUT(3) +## CURLOPT_RTSP_TRANSPORT -## CURLOPT_TIMEOUT_MS +RTSP Transport: header. See CURLOPT_RTSP_TRANSPORT(3) -Millisecond timeout for the entire request. See CURLOPT_TIMEOUT_MS(3) +## CURLOPT_SASL_AUTHZID -## CURLOPT_LOW_SPEED_LIMIT +SASL authorization identity (identity to act as). See CURLOPT_SASL_AUTHZID(3) -Low speed limit to abort transfer. See CURLOPT_LOW_SPEED_LIMIT(3) +## CURLOPT_SASL_IR -## CURLOPT_LOW_SPEED_TIME +Enable SASL initial response. See CURLOPT_SASL_IR(3) -Time to be below the speed to trigger low speed abort. See CURLOPT_LOW_SPEED_TIME(3) +## CURLOPT_SEEKDATA -## CURLOPT_MAX_SEND_SPEED_LARGE +Data pointer to pass to the seek callback. See CURLOPT_SEEKDATA(3) -Cap the upload speed to this. See CURLOPT_MAX_SEND_SPEED_LARGE(3) +## CURLOPT_SEEKFUNCTION -## CURLOPT_MAX_RECV_SPEED_LARGE +Callback for seek operations. See CURLOPT_SEEKFUNCTION(3) -Cap the download speed to this. See CURLOPT_MAX_RECV_SPEED_LARGE(3) +## CURLOPT_SERVER_RESPONSE_TIMEOUT -## CURLOPT_MAXCONNECTS +Timeout for server responses. See CURLOPT_SERVER_RESPONSE_TIMEOUT(3) -Maximum number of connections in the connection pool. See CURLOPT_MAXCONNECTS(3) +## CURLOPT_SERVER_RESPONSE_TIMEOUT_MS -## CURLOPT_FRESH_CONNECT +Timeout for server responses. See CURLOPT_SERVER_RESPONSE_TIMEOUT_MS(3) -Use a new connection. CURLOPT_FRESH_CONNECT(3) +## CURLOPT_SERVICE_NAME -## CURLOPT_FORBID_REUSE +Authentication service name. CURLOPT_SERVICE_NAME(3) -Prevent subsequent connections from reusing this. See CURLOPT_FORBID_REUSE(3) +## CURLOPT_SHARE -## CURLOPT_MAXAGE_CONN +Share object to use. See CURLOPT_SHARE(3) -Limit the age (idle time) of connections for reuse. See CURLOPT_MAXAGE_CONN(3) +## CURLOPT_SOCKOPTDATA -## CURLOPT_MAXLIFETIME_CONN +Data pointer to pass to the sockopt callback. See CURLOPT_SOCKOPTDATA(3) -Limit the age (since creation) of connections for reuse. See -CURLOPT_MAXLIFETIME_CONN(3) +## CURLOPT_SOCKOPTFUNCTION -## CURLOPT_CONNECTTIMEOUT +Callback for sockopt operations. See CURLOPT_SOCKOPTFUNCTION(3) -Timeout for the connection phase. See CURLOPT_CONNECTTIMEOUT(3) +## CURLOPT_SOCKS5_AUTH -## CURLOPT_CONNECTTIMEOUT_MS +Socks5 authentication methods. See CURLOPT_SOCKS5_AUTH(3) -Millisecond timeout for the connection phase. See CURLOPT_CONNECTTIMEOUT_MS(3) +## CURLOPT_SOCKS5_GSSAPI_NEC -## CURLOPT_IPRESOLVE +Socks5 GSSAPI NEC mode. See CURLOPT_SOCKS5_GSSAPI_NEC(3) -IP version to use. See CURLOPT_IPRESOLVE(3) +## CURLOPT_SOCKS5_GSSAPI_SERVICE -## CURLOPT_CONNECT_ONLY +**Deprecated option** Socks5 GSSAPI service name. +See CURLOPT_SOCKS5_GSSAPI_SERVICE(3) -Only connect, nothing else. See CURLOPT_CONNECT_ONLY(3) +## CURLOPT_SSH_AUTH_TYPES -## CURLOPT_USE_SSL +SSH authentication types. See CURLOPT_SSH_AUTH_TYPES(3) -Use TLS/SSL. See CURLOPT_USE_SSL(3) +## CURLOPT_SSH_COMPRESSION -## CURLOPT_RESOLVE +Enable SSH compression. See CURLOPT_SSH_COMPRESSION(3) -Provide fixed/fake name resolves. See CURLOPT_RESOLVE(3) +## CURLOPT_SSH_HOSTKEYDATA -## CURLOPT_DNS_INTERFACE +Custom pointer to pass to ssh host key callback. See CURLOPT_SSH_HOSTKEYDATA(3) -Bind name resolves to this interface. See CURLOPT_DNS_INTERFACE(3) +## CURLOPT_SSH_HOSTKEYFUNCTION -## CURLOPT_DNS_LOCAL_IP4 +Callback for checking host key handling. See CURLOPT_SSH_HOSTKEYFUNCTION(3) -Bind name resolves to this IP4 address. See CURLOPT_DNS_LOCAL_IP4(3) +## CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 -## CURLOPT_DNS_LOCAL_IP6 +MD5 of host's public key. See CURLOPT_SSH_HOST_PUBLIC_KEY_MD5(3) -Bind name resolves to this IP6 address. See CURLOPT_DNS_LOCAL_IP6(3) +## CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256 -## CURLOPT_DNS_SERVERS +SHA256 of host's public key. See CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256(3) -Preferred DNS servers. See CURLOPT_DNS_SERVERS(3) +## CURLOPT_SSH_KEYDATA -## CURLOPT_DNS_SHUFFLE_ADDRESSES +Custom pointer to pass to ssh key callback. See CURLOPT_SSH_KEYDATA(3) -Shuffle addresses before use. See CURLOPT_DNS_SHUFFLE_ADDRESSES(3) +## CURLOPT_SSH_KEYFUNCTION -## CURLOPT_ACCEPTTIMEOUT_MS +Callback for known hosts handling. See CURLOPT_SSH_KEYFUNCTION(3) -Timeout for waiting for the server's connect back to be accepted. See -CURLOPT_ACCEPTTIMEOUT_MS(3) +## CURLOPT_SSH_KNOWNHOSTS -## CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS +Filename with known hosts. See CURLOPT_SSH_KNOWNHOSTS(3) -Timeout for happy eyeballs. See CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS(3) +## CURLOPT_SSH_PRIVATE_KEYFILE -## CURLOPT_UPKEEP_INTERVAL_MS +Filename of the private key. See CURLOPT_SSH_PRIVATE_KEYFILE(3) -Sets the interval at which connection upkeep are performed. See -CURLOPT_UPKEEP_INTERVAL_MS(3) +## CURLOPT_SSH_PUBLIC_KEYFILE -# SSL and SECURITY OPTIONS +Filename of the public key. See CURLOPT_SSH_PUBLIC_KEYFILE(3) ## CURLOPT_SSLCERT Client cert. See CURLOPT_SSLCERT(3) -## CURLOPT_SSLCERT_BLOB - -Client cert memory buffer. See CURLOPT_SSLCERT_BLOB(3) - -## CURLOPT_PROXY_SSLCERT - -Proxy client cert. See CURLOPT_PROXY_SSLCERT(3) - -## CURLOPT_PROXY_SSLCERT_BLOB - -Proxy client cert memory buffer. See CURLOPT_PROXY_SSLCERT_BLOB(3) - ## CURLOPT_SSLCERTTYPE Client cert type. See CURLOPT_SSLCERTTYPE(3) -## CURLOPT_PROXY_SSLCERTTYPE - -Proxy client cert type. See CURLOPT_PROXY_SSLCERTTYPE(3) - -## CURLOPT_SSLKEY +## CURLOPT_SSLCERT_BLOB -Client key. See CURLOPT_SSLKEY(3) +Client cert memory buffer. See CURLOPT_SSLCERT_BLOB(3) -## CURLOPT_SSLKEY_BLOB +## CURLOPT_SSLENGINE -Client key memory buffer. See CURLOPT_SSLKEY_BLOB(3) +Use identifier with SSL engine. See CURLOPT_SSLENGINE(3) -## CURLOPT_PROXY_SSLKEY +## CURLOPT_SSLENGINE_DEFAULT -Proxy client key. See CURLOPT_PROXY_SSLKEY(3) +Default SSL engine. See CURLOPT_SSLENGINE_DEFAULT(3) -## CURLOPT_PROXY_SSLKEY_BLOB +## CURLOPT_SSLKEY -Proxy client key. See CURLOPT_PROXY_SSLKEY_BLOB(3) +Client key. See CURLOPT_SSLKEY(3) ## CURLOPT_SSLKEYTYPE Client key type. See CURLOPT_SSLKEYTYPE(3) -## CURLOPT_PROXY_SSLKEYTYPE +## CURLOPT_SSLKEY_BLOB -Proxy client key type. See CURLOPT_PROXY_SSLKEYTYPE(3) +Client key memory buffer. See CURLOPT_SSLKEY_BLOB(3) -## CURLOPT_KEYPASSWD +## CURLOPT_SSLVERSION -Client key password. See CURLOPT_KEYPASSWD(3) +SSL version to use. See CURLOPT_SSLVERSION(3) -## CURLOPT_PROXY_KEYPASSWD +## CURLOPT_SSL_CIPHER_LIST -Proxy client key password. See CURLOPT_PROXY_KEYPASSWD(3) +Ciphers to use. See CURLOPT_SSL_CIPHER_LIST(3) + +## CURLOPT_SSL_CTX_DATA + +Data pointer to pass to the SSL context callback. See CURLOPT_SSL_CTX_DATA(3) + +## CURLOPT_SSL_CTX_FUNCTION + +Callback for SSL context logic. See CURLOPT_SSL_CTX_FUNCTION(3) ## CURLOPT_SSL_EC_CURVES @@ -1103,252 +1115,216 @@ Enable use of ALPN. See CURLOPT_SSL_ENABLE_ALPN(3) **OBSOLETE** Enable use of NPN. See CURLOPT_SSL_ENABLE_NPN(3) -## CURLOPT_SSLENGINE - -Use identifier with SSL engine. See CURLOPT_SSLENGINE(3) - -## CURLOPT_SSLENGINE_DEFAULT - -Default SSL engine. See CURLOPT_SSLENGINE_DEFAULT(3) - ## CURLOPT_SSL_FALSESTART Enable TLS False Start. See CURLOPT_SSL_FALSESTART(3) -## CURLOPT_SSLVERSION +## CURLOPT_SSL_OPTIONS -SSL version to use. See CURLOPT_SSLVERSION(3) +Control SSL behavior. See CURLOPT_SSL_OPTIONS(3) -## CURLOPT_PROXY_SSLVERSION +## CURLOPT_SSL_SESSIONID_CACHE -Proxy SSL version to use. See CURLOPT_PROXY_SSLVERSION(3) +Disable SSL session-id cache. See CURLOPT_SSL_SESSIONID_CACHE(3) ## CURLOPT_SSL_VERIFYHOST Verify the hostname in the SSL certificate. See CURLOPT_SSL_VERIFYHOST(3) -## CURLOPT_DOH_SSL_VERIFYHOST - -Verify the hostname in the DoH (DNS-over-HTTPS) SSL certificate. See -CURLOPT_DOH_SSL_VERIFYHOST(3) - -## CURLOPT_PROXY_SSL_VERIFYHOST - -Verify the hostname in the proxy SSL certificate. See -CURLOPT_PROXY_SSL_VERIFYHOST(3) - ## CURLOPT_SSL_VERIFYPEER Verify the SSL certificate. See CURLOPT_SSL_VERIFYPEER(3) -## CURLOPT_DOH_SSL_VERIFYPEER - -Verify the DoH (DNS-over-HTTPS) SSL certificate. See -CURLOPT_DOH_SSL_VERIFYPEER(3) - -## CURLOPT_PROXY_SSL_VERIFYPEER - -Verify the proxy SSL certificate. See CURLOPT_PROXY_SSL_VERIFYPEER(3) - ## CURLOPT_SSL_VERIFYSTATUS Verify the SSL certificate's status. See CURLOPT_SSL_VERIFYSTATUS(3) -## CURLOPT_DOH_SSL_VERIFYSTATUS - -Verify the DoH (DNS-over-HTTPS) SSL certificate's status. See -CURLOPT_DOH_SSL_VERIFYSTATUS(3) - -## CURLOPT_CAINFO - -CA cert bundle. See CURLOPT_CAINFO(3) - -## CURLOPT_CAINFO_BLOB +## CURLOPT_STDERR -CA cert bundle memory buffer. See CURLOPT_CAINFO_BLOB(3) +Redirect stderr to another stream. See CURLOPT_STDERR(3) -## CURLOPT_PROXY_CAINFO +## CURLOPT_STREAM_DEPENDS -Proxy CA cert bundle. See CURLOPT_PROXY_CAINFO(3) +This HTTP/2 stream depends on another. See CURLOPT_STREAM_DEPENDS(3) -## CURLOPT_PROXY_CAINFO_BLOB +## CURLOPT_STREAM_DEPENDS_E -Proxy CA cert bundle memory buffer. See CURLOPT_PROXY_CAINFO_BLOB(3) +This HTTP/2 stream depends on another exclusively. See +CURLOPT_STREAM_DEPENDS_E(3) -## CURLOPT_ISSUERCERT +## CURLOPT_STREAM_WEIGHT -Issuer certificate. See CURLOPT_ISSUERCERT(3) +Set this HTTP/2 stream's weight. See CURLOPT_STREAM_WEIGHT(3) -## CURLOPT_ISSUERCERT_BLOB +## CURLOPT_SUPPRESS_CONNECT_HEADERS -Issuer certificate memory buffer. See CURLOPT_ISSUERCERT_BLOB(3) +Suppress proxy CONNECT response headers from user callbacks. See +CURLOPT_SUPPRESS_CONNECT_HEADERS(3) -## CURLOPT_PROXY_ISSUERCERT +## CURLOPT_TCP_FASTOPEN -Proxy issuer certificate. See CURLOPT_PROXY_ISSUERCERT(3) +Enable TCP Fast Open. See CURLOPT_TCP_FASTOPEN(3) -## CURLOPT_PROXY_ISSUERCERT_BLOB +## CURLOPT_TCP_KEEPALIVE -Proxy issuer certificate memory buffer. See CURLOPT_PROXY_ISSUERCERT_BLOB(3) +Enable TCP keep-alive. See CURLOPT_TCP_KEEPALIVE(3) -## CURLOPT_CAPATH +## CURLOPT_TCP_KEEPCNT -Path to CA cert bundle. See CURLOPT_CAPATH(3) +Maximum number of keep-alive probes. See CURLOPT_TCP_KEEPCNT(3) -## CURLOPT_PROXY_CAPATH +## CURLOPT_TCP_KEEPIDLE -Path to proxy CA cert bundle. See CURLOPT_PROXY_CAPATH(3) +Idle time before sending keep-alive. See CURLOPT_TCP_KEEPIDLE(3) -## CURLOPT_CRLFILE +## CURLOPT_TCP_KEEPINTVL -Certificate Revocation List. See CURLOPT_CRLFILE(3) +Interval between keep-alive probes. See CURLOPT_TCP_KEEPINTVL(3) -## CURLOPT_PROXY_CRLFILE +## CURLOPT_TCP_NODELAY -Proxy Certificate Revocation List. See CURLOPT_PROXY_CRLFILE(3) +Disable the Nagle algorithm. See CURLOPT_TCP_NODELAY(3) -## CURLOPT_CA_CACHE_TIMEOUT +## CURLOPT_TELNETOPTIONS -Timeout for CA cache. See CURLOPT_CA_CACHE_TIMEOUT(3) +TELNET options. See CURLOPT_TELNETOPTIONS(3) -## CURLOPT_CERTINFO +## CURLOPT_TFTP_BLKSIZE -Extract certificate info. See CURLOPT_CERTINFO(3) +TFTP block size. See CURLOPT_TFTP_BLKSIZE(3) -## CURLOPT_PINNEDPUBLICKEY +## CURLOPT_TFTP_NO_OPTIONS -Set pinned SSL public key . See CURLOPT_PINNEDPUBLICKEY(3) +Do not send TFTP options requests. See CURLOPT_TFTP_NO_OPTIONS(3) -## CURLOPT_PROXY_PINNEDPUBLICKEY +## CURLOPT_TIMECONDITION -Set the proxy's pinned SSL public key. See -CURLOPT_PROXY_PINNEDPUBLICKEY(3) +Make a time conditional request. See CURLOPT_TIMECONDITION(3) -## CURLOPT_RANDOM_FILE +## CURLOPT_TIMEOUT -**OBSOLETE** Provide source for entropy random data. -See CURLOPT_RANDOM_FILE(3) +Timeout for the entire request. See CURLOPT_TIMEOUT(3) -## CURLOPT_EGDSOCKET +## CURLOPT_TIMEOUT_MS -**OBSOLETE** Identify EGD socket for entropy. See CURLOPT_EGDSOCKET(3) +Millisecond timeout for the entire request. See CURLOPT_TIMEOUT_MS(3) -## CURLOPT_SSL_CIPHER_LIST +## CURLOPT_TIMEVALUE -Ciphers to use. See CURLOPT_SSL_CIPHER_LIST(3) +Time value for the time conditional request. See CURLOPT_TIMEVALUE(3) -## CURLOPT_PROXY_SSL_CIPHER_LIST +## CURLOPT_TIMEVALUE_LARGE -Proxy ciphers to use. See CURLOPT_PROXY_SSL_CIPHER_LIST(3) +Time value for the time conditional request. See CURLOPT_TIMEVALUE_LARGE(3) ## CURLOPT_TLS13_CIPHERS TLS 1.3 cipher suites to use. See CURLOPT_TLS13_CIPHERS(3) -## CURLOPT_PROXY_TLS13_CIPHERS - -Proxy TLS 1.3 cipher suites to use. See CURLOPT_PROXY_TLS13_CIPHERS(3) - -## CURLOPT_SSL_SESSIONID_CACHE +## CURLOPT_TLSAUTH_PASSWORD -Disable SSL session-id cache. See CURLOPT_SSL_SESSIONID_CACHE(3) +TLS authentication password. See CURLOPT_TLSAUTH_PASSWORD(3) -## CURLOPT_SSL_OPTIONS +## CURLOPT_TLSAUTH_TYPE -Control SSL behavior. See CURLOPT_SSL_OPTIONS(3) +TLS authentication methods. See CURLOPT_TLSAUTH_TYPE(3) -## CURLOPT_PROXY_SSL_OPTIONS +## CURLOPT_TLSAUTH_USERNAME -Control proxy SSL behavior. See CURLOPT_PROXY_SSL_OPTIONS(3) +TLS authentication username. See CURLOPT_TLSAUTH_USERNAME(3) -## CURLOPT_KRBLEVEL +## CURLOPT_TRAILERDATA -Kerberos security level. See CURLOPT_KRBLEVEL(3) +Custom pointer passed to the trailing headers callback. See +CURLOPT_TRAILERDATA(3) -## CURLOPT_GSSAPI_DELEGATION +## CURLOPT_TRAILERFUNCTION -Disable GSS-API delegation. See CURLOPT_GSSAPI_DELEGATION(3) +Set callback for sending trailing headers. See +CURLOPT_TRAILERFUNCTION(3) -# SSH OPTIONS +## CURLOPT_TRANSFERTEXT -## CURLOPT_SSH_AUTH_TYPES +Use text transfer. See CURLOPT_TRANSFERTEXT(3) -SSH authentication types. See CURLOPT_SSH_AUTH_TYPES(3) +## CURLOPT_TRANSFER_ENCODING -## CURLOPT_SSH_COMPRESSION +Request Transfer-Encoding. See CURLOPT_TRANSFER_ENCODING(3) -Enable SSH compression. See CURLOPT_SSH_COMPRESSION(3) +## CURLOPT_UNIX_SOCKET_PATH -## CURLOPT_SSH_HOST_PUBLIC_KEY_MD5 +Path to a Unix domain socket. See CURLOPT_UNIX_SOCKET_PATH(3) -MD5 of host's public key. See CURLOPT_SSH_HOST_PUBLIC_KEY_MD5(3) +## CURLOPT_UNRESTRICTED_AUTH -## CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256 +Do not restrict authentication to original host. CURLOPT_UNRESTRICTED_AUTH(3) -SHA256 of host's public key. See CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256(3) +## CURLOPT_UPKEEP_INTERVAL_MS -## CURLOPT_SSH_PUBLIC_KEYFILE +Sets the interval at which connection upkeep are performed. See +CURLOPT_UPKEEP_INTERVAL_MS(3) -Filename of the public key. See CURLOPT_SSH_PUBLIC_KEYFILE(3) +## CURLOPT_UPLOAD -## CURLOPT_SSH_PRIVATE_KEYFILE +Upload data. See CURLOPT_UPLOAD(3) -Filename of the private key. See CURLOPT_SSH_PRIVATE_KEYFILE(3) +## CURLOPT_UPLOAD_BUFFERSIZE -## CURLOPT_SSH_KNOWNHOSTS +Set upload buffer size. See CURLOPT_UPLOAD_BUFFERSIZE(3) -Filename with known hosts. See CURLOPT_SSH_KNOWNHOSTS(3) +## CURLOPT_URL -## CURLOPT_SSH_KEYFUNCTION +URL to work on. See CURLOPT_URL(3) -Callback for known hosts handling. See CURLOPT_SSH_KEYFUNCTION(3) +## CURLOPT_USERAGENT -## CURLOPT_SSH_KEYDATA +User-Agent: header. See CURLOPT_USERAGENT(3) -Custom pointer to pass to ssh key callback. See CURLOPT_SSH_KEYDATA(3) +## CURLOPT_USERNAME -## CURLOPT_SSH_HOSTKEYFUNCTION +Username. See CURLOPT_USERNAME(3) -Callback for checking host key handling. See CURLOPT_SSH_HOSTKEYFUNCTION(3) +## CURLOPT_USERPWD -## CURLOPT_SSH_HOSTKEYDATA +Username and password. See CURLOPT_USERPWD(3) -Custom pointer to pass to ssh host key callback. See CURLOPT_SSH_HOSTKEYDATA(3) +## CURLOPT_USE_SSL -# WEBSOCKET +Use TLS/SSL. See CURLOPT_USE_SSL(3) -## CURLOPT_WS_OPTIONS +## CURLOPT_VERBOSE -Set WebSocket options. See CURLOPT_WS_OPTIONS(3) +Display verbose information. See CURLOPT_VERBOSE(3) -# OTHER OPTIONS +## CURLOPT_WILDCARDMATCH -## CURLOPT_PRIVATE +Transfer multiple files according to a filename pattern. See +CURLOPT_WILDCARDMATCH(3) -Private pointer to store. See CURLOPT_PRIVATE(3) +## CURLOPT_WRITEDATA -## CURLOPT_SHARE +Data pointer to pass to the write callback. See CURLOPT_WRITEDATA(3) -Share object to use. See CURLOPT_SHARE(3) +## CURLOPT_WRITEFUNCTION -## CURLOPT_NEW_FILE_PERMS +Callback for writing data. See CURLOPT_WRITEFUNCTION(3) -Mode for creating new remote files. See CURLOPT_NEW_FILE_PERMS(3) +## CURLOPT_WS_OPTIONS -## CURLOPT_NEW_DIRECTORY_PERMS +Set WebSocket options. See CURLOPT_WS_OPTIONS(3) -Mode for creating new remote directories. See CURLOPT_NEW_DIRECTORY_PERMS(3) +## CURLOPT_XFERINFODATA -## CURLOPT_QUICK_EXIT +Data pointer to pass to the progress meter callback. See +CURLOPT_XFERINFODATA(3) -To be set by toplevel tools like "curl" to skip lengthy cleanups when they are -about to call exit() anyway. See CURLOPT_QUICK_EXIT(3) +## CURLOPT_XFERINFOFUNCTION -# TELNET OPTIONS +Callback for progress meter. See CURLOPT_XFERINFOFUNCTION(3) -## CURLOPT_TELNETOPTIONS +## CURLOPT_XOAUTH2_BEARER -TELNET options. See CURLOPT_TELNETOPTIONS(3) +OAuth2 bearer token. See CURLOPT_XOAUTH2_BEARER(3) # EXAMPLE @@ -1367,10 +1343,6 @@ int main(void) # ENCRYPTED CLIENT HELLO OPTIONS -## CURLOPT_ECH - -Set the configuration for ECH. See CURLOPT_ECH(3) - # AVAILABILITY Always diff --git a/docs/libcurl/curl_multi_setopt.md b/docs/libcurl/curl_multi_setopt.md index 399060fc27..5bc8d5d829 100644 --- a/docs/libcurl/curl_multi_setopt.md +++ b/docs/libcurl/curl_multi_setopt.md @@ -22,85 +22,86 @@ curl_multi_setopt - set options for a curl multi handle ~~~c #include -CURLMcode curl_multi_setopt(CURLM *multi_handle, CURLMoption option, parameter); +CURLMcode curl_multi_setopt(CURLM *multi, CURLMoption option, parameter); ~~~ # DESCRIPTION -curl_multi_setopt(3) is used to tell a libcurl multi handle how to -behave. By using the appropriate options to curl_multi_setopt(3), you -can change libcurl's behavior when using that multi handle. All options are -set with the *option* followed by the *parameter*. That parameter can -be a **long**, a **function pointer**, an **object pointer** or a -**curl_off_t** type, depending on what the specific option expects. Read -this manual carefully as bad input values may cause libcurl to behave -badly. You can only set one option in each function call. +curl_multi_setopt(3) is used to tell a libcurl multi handle how to behave. By +using the appropriate options to curl_multi_setopt(3), you can change +libcurl's behavior when using that multi handle. All options are set with the +*option* followed by the *parameter*. That parameter can be a **long**, a +**function pointer**, an **object pointer** or a **curl_off_t** type, +depending on what the specific option expects. Read this manual carefully as +bad input values may cause libcurl to behave badly. You can only set one +option in each function call. # OPTIONS ## CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE -See CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE(3) +**deprecated** See CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE(3) ## CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE -See CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE(3) +**deprecated** See CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE(3) -## CURLMOPT_MAX_HOST_CONNECTIONS +## CURLMOPT_MAXCONNECTS -See CURLMOPT_MAX_HOST_CONNECTIONS(3) +Size of connection cache. See CURLMOPT_MAXCONNECTS(3) -## CURLMOPT_MAX_PIPELINE_LENGTH +## CURLMOPT_MAX_CONCURRENT_STREAMS -See CURLMOPT_MAX_PIPELINE_LENGTH(3) +Max concurrent streams for http2. See CURLMOPT_MAX_CONCURRENT_STREAMS(3) -## CURLMOPT_MAX_TOTAL_CONNECTIONS +## CURLMOPT_MAX_HOST_CONNECTIONS -See CURLMOPT_MAX_TOTAL_CONNECTIONS(3) +Max number of connections to a single host. See +CURLMOPT_MAX_HOST_CONNECTIONS(3) -## CURLMOPT_MAXCONNECTS +## CURLMOPT_MAX_PIPELINE_LENGTH -See CURLMOPT_MAXCONNECTS(3) +**deprecated**. See CURLMOPT_MAX_PIPELINE_LENGTH(3) -## CURLMOPT_PIPELINING +## CURLMOPT_MAX_TOTAL_CONNECTIONS -See CURLMOPT_PIPELINING(3) +Max simultaneously open connections. See CURLMOPT_MAX_TOTAL_CONNECTIONS(3) -## CURLMOPT_PIPELINING_SITE_BL +## CURLMOPT_PIPELINING -See CURLMOPT_PIPELINING_SITE_BL(3) +Enable HTTP multiplexing. See CURLMOPT_PIPELINING(3) ## CURLMOPT_PIPELINING_SERVER_BL -See CURLMOPT_PIPELINING_SERVER_BL(3) +**deprecated**. See CURLMOPT_PIPELINING_SERVER_BL(3) -## CURLMOPT_PUSHFUNCTION +## CURLMOPT_PIPELINING_SITE_BL -See CURLMOPT_PUSHFUNCTION(3) +**deprecated**. See CURLMOPT_PIPELINING_SITE_BL(3) ## CURLMOPT_PUSHDATA -See CURLMOPT_PUSHDATA(3) +Pointer to pass to push callback. See CURLMOPT_PUSHDATA(3) -## CURLMOPT_SOCKETFUNCTION +## CURLMOPT_PUSHFUNCTION -See CURLMOPT_SOCKETFUNCTION(3) +Callback that approves or denies server pushes. See CURLMOPT_PUSHFUNCTION(3) ## CURLMOPT_SOCKETDATA -See CURLMOPT_SOCKETDATA(3) +Custom pointer passed to the socket callback. See CURLMOPT_SOCKETDATA(3) -## CURLMOPT_TIMERFUNCTION +## CURLMOPT_SOCKETFUNCTION -See CURLMOPT_TIMERFUNCTION(3) +Callback informed about what to wait for. See CURLMOPT_SOCKETFUNCTION(3) ## CURLMOPT_TIMERDATA -See CURLMOPT_TIMERDATA(3) +Custom pointer to pass to timer callback. See CURLMOPT_TIMERDATA(3) -## CURLMOPT_MAX_CONCURRENT_STREAMS +## CURLMOPT_TIMERFUNCTION -See CURLMOPT_MAX_CONCURRENT_STREAMS(3) +Callback to receive timeout values. See CURLMOPT_TIMERFUNCTION(3) # EXAMPLE diff --git a/tests/test1139.pl b/tests/test1139.pl index 42c286e916..a54cdf16dc 100755 --- a/tests/test1139.pl +++ b/tests/test1139.pl @@ -80,6 +80,15 @@ sub scanmdpage { } close($mh); + my @ms = sort @m; + for my $i (0 .. $#m) { + if($ms[$i] ne $m[$i]) { + print STDERR "$file:1:ERROR: $m[$i] is not alphabetical (expected $ms[$i])\n"; + $errors++; + # no point in reporting many + last; + } + } foreach my $m (@words) { my @g = grep(/$m/, @m); if(!$g[0]) {