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

docs: tag curl options better in man pages

Browse Source 
As it makes them links in the HTML versions.

Verified by the extended test 1176
This commit is contained in:
Daniel Stenberg 2022-09-22 17:07:09 +02:00
parent 70b6c701f8
commit bf1571eb6f
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
7 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/libcurl/opts/CURLINFO_REDIRECT_TIME.3
View File

@ -35,8 +35,8 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REDIRECT_TIME,
.SH DESCRIPTION
Pass a pointer to a double to receive the total time, in seconds, it took for
all redirection steps include name lookup, connect, pretransfer and transfer
before final transaction was started. CURLINFO_REDIRECT_TIME contains the
complete execution time for multiple redirections.
before final transaction was started. \fICURLINFO_REDIRECT_TIME(3)\fP contains
the complete execution time for multiple redirections.
See also the TIMES overview in the \fIcurl_easy_getinfo(3)\fP man page.
.SH PROTOCOLS

4
docs/libcurl/opts/CURLINFO_TLS_SESSION.3
View File

@ -40,9 +40,9 @@ This option is exactly the same as \fICURLINFO_TLS_SSL_PTR(3)\fP except in the
case of OpenSSL. If the session \fIbackend\fP is CURLSSLBACKEND_OPENSSL the
session \fIinternals\fP pointer varies depending on the option:
CURLINFO_TLS_SESSION OpenSSL session \fIinternals\fP is \fBSSL_CTX *\fP.
\fICURLINFO_TLS_SESSION(3)\fP OpenSSL session \fIinternals\fP is \fBSSL_CTX *\fP.
CURLINFO_TLS_SSL_PTR OpenSSL session \fIinternals\fP is \fBSSL *\fP.
\fICURLINFO_TLS_SSL_PTR(3)\fP OpenSSL session \fIinternals\fP is \fBSSL *\fP.
You can obtain an \fBSSL_CTX\fP pointer from an SSL pointer using OpenSSL
function \fISSL_get_SSL_CTX(3)\fP. Therefore unless you need compatibility

4
docs/libcurl/opts/CURLINFO_TLS_SSL_PTR.3
View File

@ -72,9 +72,9 @@ for the active ("in use") SSL connection, with the following underlying types:
.IP NSS
\fBPRFileDesc *\fP
.IP OpenSSL
CURLINFO_TLS_SESSION: \fBSSL_CTX *\fP
\fICURLINFO_TLS_SESSION(3)\fP: \fBSSL_CTX *\fP
CURLINFO_TLS_SSL_PTR: \fBSSL *\fP
\fICURLINFO_TLS_SSL_PTR(3)\fP: \fBSSL *\fP
.RE
Since 7.48.0 the \fIinternals\fP member can point to these other SSL backends
as well:

5
docs/libcurl/opts/CURLOPT_CAINFO.3
View File

@ -79,8 +79,9 @@ if(curl) {
}
.fi
.SH AVAILABILITY
For the SSL engines that do not support certificate files the CURLOPT_CAINFO
option is ignored. Schannel support added in libcurl 7.60.
For the SSL engines that do not support certificate files the
\fICURLOPT_CAINFO(3)\fP option is ignored. Schannel support added in libcurl
7.60.
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.

4
docs/libcurl/opts/CURLOPT_PRIVATE.3
View File

@ -34,8 +34,8 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PRIVATE, void *pointer);
.SH DESCRIPTION
Pass a void * as parameter, pointing to data that should be associated with
this curl handle. The pointer can subsequently be retrieved using
\fIcurl_easy_getinfo(3)\fP with the CURLINFO_PRIVATE option. libcurl itself
never does anything with this data.
\fIcurl_easy_getinfo(3)\fP with the \fICURLINFO_PRIVATE(3)\fP option. libcurl
itself never does anything with this data.
.SH DEFAULT
NULL
.SH PROTOCOLS

2
docs/libcurl/opts/CURLOPT_PROXY_TLS13_CIPHERS.3
View File

@ -44,7 +44,7 @@ you will find more details about cipher lists on this URL:
This option is currently used only when curl is built to use OpenSSL 1.1.1 or
later. If you are using a different SSL backend you can try setting TLS 1.3
cipher suites by using the CURLOPT_PROXY_SSL_CIPHER_LIST option.
cipher suites by using the \fICURLOPT_PROXY_SSL_CIPHER_LIST(3)\fP option.
The application does not have to keep the string around after setting this
option.

3
docs/libcurl/opts/CURLOPT_TLS13_CIPHERS.3
View File

@ -42,7 +42,8 @@ you will find more details about cipher lists on this URL:
This option is currently used only when curl is built to use OpenSSL 1.1.1 or
later or Schannel. If you are using a different SSL backend you can try
setting TLS 1.3 cipher suites by using the CURLOPT_SSL_CIPHER_LIST option.
setting TLS 1.3 cipher suites by using the \fICURLOPT_SSL_CIPHER_LIST(3)\fP
option.
The application does not have to keep the string around after setting this
option.