]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
docs: tag curl options better in man pages
authorDaniel Stenberg <daniel@haxx.se>
Thu, 22 Sep 2022 15:07:09 +0000 (17:07 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Thu, 22 Sep 2022 15:36:28 +0000 (17:36 +0200)
As it makes them links in the HTML versions.

Verified by the extended test 1176

docs/libcurl/opts/CURLINFO_REDIRECT_TIME.3
docs/libcurl/opts/CURLINFO_TLS_SESSION.3
docs/libcurl/opts/CURLINFO_TLS_SSL_PTR.3
docs/libcurl/opts/CURLOPT_CAINFO.3
docs/libcurl/opts/CURLOPT_PRIVATE.3
docs/libcurl/opts/CURLOPT_PROXY_TLS13_CIPHERS.3
docs/libcurl/opts/CURLOPT_TLS13_CIPHERS.3

index a39d43eeccb8cadcd7db628401ec2c6223782820..f8a56bacb3c178182f49458210bd75859a48bcef 100644 (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
index c7e63507045308f528638cc9f7a088062d79a12d..4b0097b3f221f916329551fdc9b35a3d2bf41464 100644 (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
index f260cd69000109429d91878c5b376c14d941f9ff..52938534639701b472ef5d26cacc1f1bc291eef8 100644 (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:
index ff4f3647db7c13c79c51cc4f382ce751d377421c..afcb062c041d1af9a5ff970f0417b12bbb41524d 100644 (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.
index a32971acda6f63d72cb7e3456ca1865a8265f55d..dd05a4f580832f51f54e4ab079af0c00dbe4af17 100644 (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
index 5835d3413e5ed1edcb3472f756e4af00a9e18043..9700f106e7cf7fda59d40640a3d53a72e95a3967 100644 (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.
index 7d9c933261d84794775e161102e64ea1b6c3c65f..4371902bfc724eb3638ce6a43c18074b55833fbd 100644 (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.