luo980/curl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libcurl-docs: make option lists alpha-sorted

Browse Source 
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
This commit is contained in:
Daniel Stenberg 2024-07-11 15:54:25 +02:00
parent fd0250869f
commit 8dab7465a5
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
4 changed files with 1365 additions and 1450 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

577
docs/libcurl/curl_easy_getinfo.md
View File

@ -33,202 +33,60 @@ performed transfer if you want to get transfer related data.
You should not free the memory returned by this function unless it is You should not free the memory returned by this function unless it is
explicitly mentioned below. explicitly mentioned below.
# AVAILABLE INFORMATION # OPTIONS
The following information can be extracted: 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
Last used URL. See CURLINFO_EFFECTIVE_URL(3)
## CURLINFO_RESPONSE_CODE
Last received response code. See CURLINFO_RESPONSE_CODE(3)
## CURLINFO_REFERER
Referrer header. See CURLINFO_REFERER(3)
## CURLINFO_HTTP_CONNECTCODE
Last proxy CONNECT response code. See CURLINFO_HTTP_CONNECTCODE(3)
## CURLINFO_HTTP_VERSION
The http version used in the connection. See CURLINFO_HTTP_VERSION(3)
## CURLINFO_FILETIME
Remote time of the retrieved document. See CURLINFO_FILETIME(3)
## CURLINFO_FILETIME_T
Remote time of the retrieved document. See CURLINFO_FILETIME_T(3)
## CURLINFO_TOTAL_TIME
Total time of previous transfer. See CURLINFO_TOTAL_TIME(3)
## CURLINFO_TOTAL_TIME_T
Total time of previous transfer. See CURLINFO_TOTAL_TIME_T(3)
## CURLINFO_NAMELOOKUP_TIME
Time from start until name resolving completed. See
CURLINFO_NAMELOOKUP_TIME(3)
## CURLINFO_NAMELOOKUP_TIME_T
Time from start until name resolving completed. See
CURLINFO_NAMELOOKUP_TIME_T(3)
## CURLINFO_CONNECT_TIME
Time from start until remote host or proxy completed.
See CURLINFO_CONNECT_TIME(3)
## CURLINFO_CONNECT_TIME_T
Time from start until remote host or proxy completed.
See CURLINFO_CONNECT_TIME_T(3)
## CURLINFO_APPCONNECT_TIME ## CURLINFO_APPCONNECT_TIME
Time from start until SSL/SSH handshake completed. The time it took from the start until the SSL connect/handshake with the
See CURLINFO_APPCONNECT_TIME(3) remote host was completed as a double in number of seconds. (Added in 7.19.0)
## CURLINFO_APPCONNECT_TIME_T ## CURLINFO_APPCONNECT_TIME_T
Time from start until SSL/SSH handshake completed. The time it took from the start until the SSL connect/handshake with the
See CURLINFO_APPCONNECT_TIME_T(3) remote host was completed in number of microseconds. (Added in 7.60.0) See
CURLINFO_APPCONNECT_TIME_T(3)
## CURLINFO_PRETRANSFER_TIME ## CURLINFO_CAINFO
Time from start until just before the transfer begins. Get the default value for CURLOPT_CAINFO(3). See CURLINFO_CAINFO(3)
See CURLINFO_PRETRANSFER_TIME(3)
## CURLINFO_PRETRANSFER_TIME_T ## CURLINFO_CAPATH
Time from start until just before the transfer begins. Get the default value for CURLOPT_CAPATH(3). See CURLINFO_CAPATH(3)
See CURLINFO_PRETRANSFER_TIME_T(3)
## CURLINFO_QUEUE_TIME_T ## CURLINFO_CERTINFO
Time during which this transfer was held in a waiting queue. Certificate chain. See CURLINFO_CERTINFO(3)
See CURLINFO_QUEUE_TIME_T(3)
## CURLINFO_USED_PROXY ## CURLINFO_CONDITION_UNMET
Whether the proxy was used (Added in 8.7.0). See CURLINFO_USED_PROXY(3) Whether or not a time conditional was met or 304 HTTP response.
See CURLINFO_CONDITION_UNMET(3)
## CURLINFO_STARTTRANSFER_TIME ## CURLINFO_CONNECT_TIME
Time from start until just when the first byte is received. The time it took from the start until the connect to the remote host (or
See CURLINFO_STARTTRANSFER_TIME(3) proxy) was completed. As a double. See CURLINFO_CONNECT_TIME(3)
## CURLINFO_STARTTRANSFER_TIME_T ## CURLINFO_CONNECT_TIME_T
Time from start until just when the first byte is received. The time it took from the start until the connect to the remote host (or
See CURLINFO_STARTTRANSFER_TIME_T(3) proxy) was completed. In microseconds. See CURLINFO_CONNECT_TIME_T(3).
## CURLINFO_REDIRECT_TIME ## CURLINFO_CONN_ID
Time taken for all redirect steps before the final transfer. The ID of the last connection used by the transfer. (Added in 8.2.0)
See CURLINFO_REDIRECT_TIME(3) See CURLINFO_CONN_ID(3)
## CURLINFO_REDIRECT_TIME_T
Time taken for all redirect steps before the final transfer.
See CURLINFO_REDIRECT_TIME_T(3)
## CURLINFO_REDIRECT_COUNT
Total number of redirects that were followed.
See CURLINFO_REDIRECT_COUNT(3)
## CURLINFO_REDIRECT_URL
URL a redirect would take you to, had you enabled redirects.
See CURLINFO_REDIRECT_URL(3)
## CURLINFO_SIZE_UPLOAD
(Deprecated) Number of bytes uploaded.
See CURLINFO_SIZE_UPLOAD(3)
## CURLINFO_SIZE_UPLOAD_T
Number of bytes uploaded.
See CURLINFO_SIZE_UPLOAD_T(3)
## CURLINFO_SIZE_DOWNLOAD
(Deprecated) Number of bytes downloaded.
See CURLINFO_SIZE_DOWNLOAD(3)
## CURLINFO_SIZE_DOWNLOAD_T
Number of bytes downloaded.
See CURLINFO_SIZE_DOWNLOAD_T(3)
## CURLINFO_SPEED_DOWNLOAD
(Deprecated) Average download speed.
See CURLINFO_SPEED_DOWNLOAD(3)
## CURLINFO_SPEED_DOWNLOAD_T
Average download speed.
See CURLINFO_SPEED_DOWNLOAD_T(3)
## CURLINFO_SPEED_UPLOAD
(Deprecated) Average upload speed.
See CURLINFO_SPEED_UPLOAD(3)
## CURLINFO_SPEED_UPLOAD_T
Average upload speed.
See CURLINFO_SPEED_UPLOAD_T(3)
## CURLINFO_HEADER_SIZE
Number of bytes of all headers received.
See CURLINFO_HEADER_SIZE(3)
## CURLINFO_REQUEST_SIZE
Number of bytes sent in the issued HTTP requests.
See CURLINFO_REQUEST_SIZE(3)
## CURLINFO_SSL_VERIFYRESULT
Certificate verification result.
See CURLINFO_SSL_VERIFYRESULT(3)
## CURLINFO_PROXY_ERROR
Detailed proxy error.
See CURLINFO_PROXY_ERROR(3)
## CURLINFO_PROXY_SSL_VERIFYRESULT
Proxy certificate verification result.
See CURLINFO_PROXY_SSL_VERIFYRESULT(3)
## CURLINFO_SSL_ENGINES
A list of OpenSSL crypto engines.
See CURLINFO_SSL_ENGINES(3)
## CURLINFO_CONTENT_LENGTH_DOWNLOAD ## CURLINFO_CONTENT_LENGTH_DOWNLOAD
(Deprecated) Content length from the Content-Length header. (**Deprecated**) Content length from the Content-Length header.
See CURLINFO_CONTENT_LENGTH_DOWNLOAD(3) See CURLINFO_CONTENT_LENGTH_DOWNLOAD(3)
## CURLINFO_CONTENT_LENGTH_DOWNLOAD_T ## CURLINFO_CONTENT_LENGTH_DOWNLOAD_T
@ -238,7 +96,7 @@ See CURLINFO_CONTENT_LENGTH_DOWNLOAD_T(3)
## CURLINFO_CONTENT_LENGTH_UPLOAD ## CURLINFO_CONTENT_LENGTH_UPLOAD
(Deprecated) Upload size. See CURLINFO_CONTENT_LENGTH_UPLOAD(3) (**Deprecated**) Upload size. See CURLINFO_CONTENT_LENGTH_UPLOAD(3)
## CURLINFO_CONTENT_LENGTH_UPLOAD_T ## CURLINFO_CONTENT_LENGTH_UPLOAD_T
@ -246,149 +104,264 @@ Upload size. See CURLINFO_CONTENT_LENGTH_UPLOAD_T(3)
## CURLINFO_CONTENT_TYPE ## CURLINFO_CONTENT_TYPE
Content type from the Content-Type header. Content type from the `Content-Type:` header. We recommend using
See CURLINFO_CONTENT_TYPE(3) curl_easy_header(3) instead. See CURLINFO_CONTENT_TYPE(3)
## CURLINFO_RETRY_AFTER ## CURLINFO_COOKIELIST
The value from the Retry-After header. List of all known cookies. See CURLINFO_COOKIELIST(3)
See CURLINFO_RETRY_AFTER(3)
## CURLINFO_PRIVATE ## CURLINFO_EFFECTIVE_METHOD
User's private data pointer. Last used HTTP method. See CURLINFO_EFFECTIVE_METHOD(3)
See CURLINFO_PRIVATE(3)
## CURLINFO_EFFECTIVE_URL
Last used URL. See CURLINFO_EFFECTIVE_URL(3)
## CURLINFO_FILETIME
Remote time of the retrieved document. See CURLINFO_FILETIME(3)
## CURLINFO_FILETIME_T
Remote time of the retrieved document. See CURLINFO_FILETIME_T(3)
## CURLINFO_FTP_ENTRY_PATH
The entry path after logging in to an FTP server. See
CURLINFO_FTP_ENTRY_PATH(3)
## CURLINFO_HEADER_SIZE
Number of bytes of all headers received. See CURLINFO_HEADER_SIZE(3)
## CURLINFO_HTTPAUTH_AVAIL ## CURLINFO_HTTPAUTH_AVAIL
Available HTTP authentication methods. Available HTTP authentication methods. See CURLINFO_HTTPAUTH_AVAIL(3)
See CURLINFO_HTTPAUTH_AVAIL(3)
## CURLINFO_PROXYAUTH_AVAIL ## CURLINFO_HTTP_CONNECTCODE
Available HTTP proxy authentication methods. Last proxy CONNECT response code. See CURLINFO_HTTP_CONNECTCODE(3)
See CURLINFO_PROXYAUTH_AVAIL(3)
## CURLINFO_OS_ERRNO ## CURLINFO_HTTP_VERSION
The errno from the last failure to connect. The http version used in the connection. See CURLINFO_HTTP_VERSION(3)
See CURLINFO_OS_ERRNO(3)
## CURLINFO_LASTSOCKET
(**Deprecated**) Last socket used. See CURLINFO_LASTSOCKET(3)
## CURLINFO_LOCAL_IP
Source IP address of the last connection. See CURLINFO_LOCAL_IP(3)
## CURLINFO_LOCAL_PORT
Source port number of the last connection. See CURLINFO_LOCAL_PORT(3)
## CURLINFO_NAMELOOKUP_TIME
Time from start until name resolving completed as a double. See
CURLINFO_NAMELOOKUP_TIME(3)
## CURLINFO_NAMELOOKUP_TIME_T
Time from start until name resolving completed in number of microseconds. See
CURLINFO_NAMELOOKUP_TIME_T(3)
## CURLINFO_NUM_CONNECTS ## CURLINFO_NUM_CONNECTS
Number of new successful connections used for previous transfer. Number of new successful connections used for previous transfer.
See CURLINFO_NUM_CONNECTS(3) See CURLINFO_NUM_CONNECTS(3)
## CURLINFO_OS_ERRNO
The errno from the last failure to connect. See CURLINFO_OS_ERRNO(3)
## CURLINFO_PRETRANSFER_TIME
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_PRETRANSFER_TIME_T
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_PRIMARY_IP ## CURLINFO_PRIMARY_IP
Destination IP address of the last connection. Destination IP address of the last connection. See CURLINFO_PRIMARY_IP(3)
See CURLINFO_PRIMARY_IP(3)
## CURLINFO_PRIMARY_PORT ## CURLINFO_PRIMARY_PORT
Destination port of the last connection. Destination port of the last connection. See CURLINFO_PRIMARY_PORT(3)
See CURLINFO_PRIMARY_PORT(3)
## CURLINFO_LOCAL_IP ## CURLINFO_PRIVATE
Source IP address of the last connection. User's private data pointer. See CURLINFO_PRIVATE(3)
See CURLINFO_LOCAL_IP(3)
## CURLINFO_LOCAL_PORT
Source port number of the last connection.
See CURLINFO_LOCAL_PORT(3)
## CURLINFO_COOKIELIST
List of all known cookies.
See CURLINFO_COOKIELIST(3)
## CURLINFO_LASTSOCKET
(Deprecated) Last socket used.
See CURLINFO_LASTSOCKET(3)
## CURLINFO_ACTIVESOCKET
The session's active socket.
See CURLINFO_ACTIVESOCKET(3)
## CURLINFO_FTP_ENTRY_PATH
The entry path after logging in to an FTP server.
See CURLINFO_FTP_ENTRY_PATH(3)
## CURLINFO_CAPATH
Get the default value for CURLOPT_CAPATH(3).
See CURLINFO_CAPATH(3)
## CURLINFO_CAINFO
Get the default value for CURLOPT_CAINFO(3).
See CURLINFO_CAINFO(3)
## CURLINFO_CERTINFO
Certificate chain.
See CURLINFO_CERTINFO(3)
## CURLINFO_TLS_SSL_PTR
TLS session info that can be used for further processing.
See CURLINFO_TLS_SSL_PTR(3)
## CURLINFO_TLS_SESSION
TLS session info that can be used for further processing. See
CURLINFO_TLS_SESSION(3). Deprecated option, use
CURLINFO_TLS_SSL_PTR(3) instead!
## CURLINFO_CONDITION_UNMET
Whether or not a time conditional was met or 304 HTTP response.
See CURLINFO_CONDITION_UNMET(3)
## CURLINFO_RTSP_SESSION_ID
RTSP session ID.
See CURLINFO_RTSP_SESSION_ID(3)
## CURLINFO_RTSP_CLIENT_CSEQ
The RTSP client CSeq that is expected next.
See CURLINFO_RTSP_CLIENT_CSEQ(3)
## CURLINFO_RTSP_SERVER_CSEQ
The RTSP server CSeq that is expected next.
See CURLINFO_RTSP_SERVER_CSEQ(3)
## CURLINFO_RTSP_CSEQ_RECV
RTSP CSeq last received.
See CURLINFO_RTSP_CSEQ_RECV(3)
## CURLINFO_PROTOCOL ## CURLINFO_PROTOCOL
(Deprecated) The protocol used for the connection. (Added in 7.52.0) (**Deprecated**) The protocol used for the connection. (Added in 7.52.0) See
See CURLINFO_PROTOCOL(3) CURLINFO_PROTOCOL(3)
## CURLINFO_PROXYAUTH_AVAIL
Available HTTP proxy authentication methods. See CURLINFO_PROXYAUTH_AVAIL(3)
## CURLINFO_PROXY_ERROR
Detailed proxy error. See CURLINFO_PROXY_ERROR(3)
## CURLINFO_PROXY_SSL_VERIFYRESULT
Proxy certificate verification result. See CURLINFO_PROXY_SSL_VERIFYRESULT(3)
## CURLINFO_QUEUE_TIME_T
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_REDIRECT_COUNT
Total number of redirects that were followed. See CURLINFO_REDIRECT_COUNT(3)
## CURLINFO_REDIRECT_TIME
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_REDIRECT_TIME_T
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_REDIRECT_URL
URL a redirect would take you to, had you enabled redirects. See
CURLINFO_REDIRECT_URL(3)
## CURLINFO_REFERER
Referrer header. See CURLINFO_REFERER(3)
## CURLINFO_REQUEST_SIZE
Number of bytes sent in the issued HTTP requests. See CURLINFO_REQUEST_SIZE(3)
## CURLINFO_RESPONSE_CODE
Last received response code. See CURLINFO_RESPONSE_CODE(3)
## CURLINFO_RETRY_AFTER
The value from the Retry-After header. See CURLINFO_RETRY_AFTER(3)
## CURLINFO_RTSP_CLIENT_CSEQ
The RTSP client CSeq that is expected next. See CURLINFO_RTSP_CLIENT_CSEQ(3)
## CURLINFO_RTSP_CSEQ_RECV
RTSP CSeq last received. See CURLINFO_RTSP_CSEQ_RECV(3)
## CURLINFO_RTSP_SERVER_CSEQ
The RTSP server CSeq that is expected next. See CURLINFO_RTSP_SERVER_CSEQ(3)
## CURLINFO_RTSP_SESSION_ID
RTSP session ID. See CURLINFO_RTSP_SESSION_ID(3)
## CURLINFO_SCHEME ## CURLINFO_SCHEME
The scheme used for the connection. (Added in 7.52.0) The scheme used for the connection. (Added in 7.52.0) See CURLINFO_SCHEME(3)
See CURLINFO_SCHEME(3)
## CURLINFO_CONN_ID ## CURLINFO_SIZE_DOWNLOAD
The ID of the last connection used by the transfer. (Added in 8.2.0) (**Deprecated**) Number of bytes downloaded. See CURLINFO_SIZE_DOWNLOAD(3)
See CURLINFO_CONN_ID(3)
## CURLINFO_SIZE_DOWNLOAD_T
Number of bytes downloaded. See CURLINFO_SIZE_DOWNLOAD_T(3)
## CURLINFO_SIZE_UPLOAD
(**Deprecated**) Number of bytes uploaded. See CURLINFO_SIZE_UPLOAD(3)
## CURLINFO_SIZE_UPLOAD_T
Number of bytes uploaded. See CURLINFO_SIZE_UPLOAD_T(3)
## CURLINFO_SPEED_DOWNLOAD
(**Deprecated**) Average download speed. See CURLINFO_SPEED_DOWNLOAD(3)
## CURLINFO_SPEED_DOWNLOAD_T
Average download speed. See CURLINFO_SPEED_DOWNLOAD_T(3)
## CURLINFO_SPEED_UPLOAD
(**Deprecated**) Average upload speed. See CURLINFO_SPEED_UPLOAD(3)
## CURLINFO_SPEED_UPLOAD_T
Average upload speed in number of bytes per second. See
CURLINFO_SPEED_UPLOAD_T(3)
## CURLINFO_SSL_ENGINES
A list of OpenSSL crypto engines. See CURLINFO_SSL_ENGINES(3)
## CURLINFO_SSL_VERIFYRESULT
Certificate verification result. See CURLINFO_SSL_VERIFYRESULT(3)
## CURLINFO_STARTTRANSFER_TIME
The time it took from the start until the first byte is received by libcurl.
As a double. See CURLINFO_STARTTRANSFER_TIME(3)
## CURLINFO_STARTTRANSFER_TIME_T
The time it took from the start until the first byte is received by libcurl.
In microseconds. See CURLINFO_STARTTRANSFER_TIME_T(3)
## CURLINFO_TLS_SESSION
(**Deprecated**) TLS session info that can be used for further processing. See
CURLINFO_TLS_SESSION(3). Use CURLINFO_TLS_SSL_PTR(3) instead!
## CURLINFO_TLS_SSL_PTR
TLS session info that can be used for further processing. See
CURLINFO_TLS_SSL_PTR(3)
## CURLINFO_TOTAL_TIME
Total time of previous transfer. See CURLINFO_TOTAL_TIME(3)
## CURLINFO_TOTAL_TIME_T
Total time of previous transfer. See CURLINFO_TOTAL_TIME_T(3)
## CURLINFO_USED_PROXY
Whether the proxy was used (Added in 8.7.0). See CURLINFO_USED_PROXY(3)
## CURLINFO_XFER_ID ## CURLINFO_XFER_ID
The ID of the transfer. (Added in 8.2.0) The ID of the transfer. (Added in 8.2.0) See CURLINFO_XFER_ID(3)
See CURLINFO_XFER_ID(3)
# TIMES # TIMES
@ -405,51 +378,11 @@ An overview of the time values available from curl_easy_getinfo(3)
|--|--|--|--|--|--|--TOTAL |--|--|--|--|--|--|--TOTAL
|--|--|--|--|--|--|--REDIRECT |--|--|--|--|--|--|--REDIRECT
## CURLINFO_QUEUE_TIME
CURLINFO_QUEUE_TIME_T(3). The time during which the transfer was held in a CURLINFO_QUEUE_TIME_T(3), CURLINFO_NAMELOOKUP_TIME_T(3),
waiting queue before it could start for real. (Added in 8.6.0) CURLINFO_CONNECT_TIME_T(3), CURLINFO_APPCONNECT_TIME_T(3),
CURLINFO_PRETRANSFER_TIME_T(3), CURLINFO_STARTTRANSFER_TIME_T(3),
## CURLINFO_NAMELOOKUP_TIME CURLINFO_TOTAL_TIME_T(3), CURLINFO_REDIRECT_TIME_T(3)
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.
# EXAMPLE # EXAMPLE

2106
docs/libcurl/curl_easy_setopt.md
View File

File diff suppressed because it is too large Load Diff

123
docs/libcurl/curl_multi_setopt.md
View File

@ -22,85 +22,86 @@ curl_multi_setopt - set options for a curl multi handle
~~~c ~~~c
#include <curl/curl.h> #include <curl/curl.h>
CURLMcode curl_multi_setopt(CURLM *multi_handle, CURLMoption option, parameter); CURLMcode curl_multi_setopt(CURLM *multi, CURLMoption option, parameter);
~~~ ~~~
# DESCRIPTION # DESCRIPTION
curl_multi_setopt(3) is used to tell a libcurl multi handle how to curl_multi_setopt(3) is used to tell a libcurl multi handle how to behave. By
behave. By using the appropriate options to curl_multi_setopt(3), you using the appropriate options to curl_multi_setopt(3), you can change
can change libcurl's behavior when using that multi handle. All options are libcurl's behavior when using that multi handle. All options are set with the
set with the *option* followed by the *parameter*. That parameter can *option* followed by the *parameter*. That parameter can be a **long**, a
be a **long**, a **function pointer**, an **object pointer** or a **function pointer**, an **object pointer** or a **curl_off_t** type,
**curl_off_t** type, depending on what the specific option expects. Read depending on what the specific option expects. Read this manual carefully as
this manual carefully as bad input values may cause libcurl to behave bad input values may cause libcurl to behave badly. You can only set one
badly. You can only set one option in each function call. option in each function call.
# OPTIONS # OPTIONS
## CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE ## 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 ## CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE
See CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE(3) **deprecated** See CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE(3)
## CURLMOPT_MAX_HOST_CONNECTIONS
See CURLMOPT_MAX_HOST_CONNECTIONS(3)
## CURLMOPT_MAX_PIPELINE_LENGTH
See CURLMOPT_MAX_PIPELINE_LENGTH(3)
## CURLMOPT_MAX_TOTAL_CONNECTIONS
See CURLMOPT_MAX_TOTAL_CONNECTIONS(3)
## CURLMOPT_MAXCONNECTS ## CURLMOPT_MAXCONNECTS
See CURLMOPT_MAXCONNECTS(3) Size of connection cache. See CURLMOPT_MAXCONNECTS(3)
## CURLMOPT_PIPELINING
See CURLMOPT_PIPELINING(3)
## CURLMOPT_PIPELINING_SITE_BL
See CURLMOPT_PIPELINING_SITE_BL(3)
## CURLMOPT_PIPELINING_SERVER_BL
See CURLMOPT_PIPELINING_SERVER_BL(3)
## CURLMOPT_PUSHFUNCTION
See CURLMOPT_PUSHFUNCTION(3)
## CURLMOPT_PUSHDATA
See CURLMOPT_PUSHDATA(3)
## CURLMOPT_SOCKETFUNCTION
See CURLMOPT_SOCKETFUNCTION(3)
## CURLMOPT_SOCKETDATA
See CURLMOPT_SOCKETDATA(3)
## CURLMOPT_TIMERFUNCTION
See CURLMOPT_TIMERFUNCTION(3)
## CURLMOPT_TIMERDATA
See CURLMOPT_TIMERDATA(3)
## CURLMOPT_MAX_CONCURRENT_STREAMS ## CURLMOPT_MAX_CONCURRENT_STREAMS
See CURLMOPT_MAX_CONCURRENT_STREAMS(3) Max concurrent streams for http2. See CURLMOPT_MAX_CONCURRENT_STREAMS(3)
## CURLMOPT_MAX_HOST_CONNECTIONS
Max number of connections to a single host. See
CURLMOPT_MAX_HOST_CONNECTIONS(3)
## CURLMOPT_MAX_PIPELINE_LENGTH
**deprecated**. See CURLMOPT_MAX_PIPELINE_LENGTH(3)
## CURLMOPT_MAX_TOTAL_CONNECTIONS
Max simultaneously open connections. See CURLMOPT_MAX_TOTAL_CONNECTIONS(3)
## CURLMOPT_PIPELINING
Enable HTTP multiplexing. See CURLMOPT_PIPELINING(3)
## CURLMOPT_PIPELINING_SERVER_BL
**deprecated**. See CURLMOPT_PIPELINING_SERVER_BL(3)
## CURLMOPT_PIPELINING_SITE_BL
**deprecated**. See CURLMOPT_PIPELINING_SITE_BL(3)
## CURLMOPT_PUSHDATA
Pointer to pass to push callback. See CURLMOPT_PUSHDATA(3)
## CURLMOPT_PUSHFUNCTION
Callback that approves or denies server pushes. See CURLMOPT_PUSHFUNCTION(3)
## CURLMOPT_SOCKETDATA
Custom pointer passed to the socket callback. See CURLMOPT_SOCKETDATA(3)
## CURLMOPT_SOCKETFUNCTION
Callback informed about what to wait for. See CURLMOPT_SOCKETFUNCTION(3)
## CURLMOPT_TIMERDATA
Custom pointer to pass to timer callback. See CURLMOPT_TIMERDATA(3)
## CURLMOPT_TIMERFUNCTION
Callback to receive timeout values. See CURLMOPT_TIMERFUNCTION(3)
# EXAMPLE # EXAMPLE

9
tests/test1139.pl
View File

@ -80,6 +80,15 @@ sub scanmdpage {
} }
close($mh); 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) { foreach my $m (@words) {
my @g = grep(/$m/, @m); my @g = grep(/$m/, @m);
if(!$g[0]) { if(!$g[0]) {