summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2021-12-07 11:53:05 +0100
committerDaniel Stenberg <daniel@haxx.se>2021-12-07 11:55:48 +0100
commit4e8d73ed1a94266c4ce7b939b4c5c6f56da1a5ed (patch)
tree9cf132fbe9b721f9434542efd51ed62e14178045
parent8f2fb3cdbd5c6513f66107bba5ef812f13059e9b (diff)
downloadcurl-bagder/resolve3-polish.tar.gz
CURLOPT_RESOLVE.3: minor polishbagder/resolve3-polish
Minor rephrasing for some explanations. Put the format strings in stand-alone lines with .nf/.fi to be easier to spot. Move "added in" to AVAILABILITY
-rw-r--r--docs/libcurl/opts/CURLOPT_RESOLVE.360
1 files changed, 34 insertions, 26 deletions
diff --git a/docs/libcurl/opts/CURLOPT_RESOLVE.3 b/docs/libcurl/opts/CURLOPT_RESOLVE.3
index 57a5401e4..33ef90385 100644
--- a/docs/libcurl/opts/CURLOPT_RESOLVE.3
+++ b/docs/libcurl/opts/CURLOPT_RESOLVE.3
@@ -36,41 +36,41 @@ list of \fBstruct curl_slist\fP structs properly filled in. Use
\fIcurl_slist_append(3)\fP to create the list and \fIcurl_slist_free_all(3)\fP
to clean up an entire list.
-Each single name resolve string should be written using the format
-[+]HOST:PORT:ADDRESS[,ADDRESS]... where HOST is the name libcurl will try
-to resolve, PORT is the port number of the service where libcurl wants
-to connect to the HOST and ADDRESS is one or more numerical IP
-addresses. If you specify multiple ip addresses they need to be
-separated by comma. If libcurl is built to support IPv6, each of the
-ADDRESS entries can of course be either IPv4 or IPv6 style addressing.
+Each resolve rule to add should be written using the format
+
+.nf
+ [+]HOST:PORT:ADDRESS[,ADDRESS]
+.fi
+
+\&... where HOST is the name libcurl will try to resolve, PORT is the port
+number of the service where libcurl wants to connect to the HOST and ADDRESS
+is one or more numerical IP addresses. If you specify multiple ip addresses
+they need to be separated by comma. If libcurl is built to support IPv6, each
+of the ADDRESS entries can of course be either IPv4 or IPv6 style addressing.
This option effectively pre-populates the DNS cache with entries for the
host+port pair so redirects and everything that operations against the
HOST+PORT will instead use your provided ADDRESS.
-The optional leading "+" signifies whether the new entry should time-out or
-not. Entries added with "HOST:..." will never time-out whereas entries added
-with "+HOST:..." will time-out just like ordinary DNS cache entries.
+The optional leading "+" specifies that the new entry should time-out. Entries
+added without the leading plus character will never time-out whereas entries
+added with "+HOST:..." will time-out just like ordinary DNS cache entries.
-If the DNS cache already has an entry for the given host+port pair, then
-this entry will be removed and a new entry will be created. This is because
-the old entry may have have different addresses or a different time-out
-setting.
+If the DNS cache already has an entry for the given host+port pair, the new
+entry will override the former one.
-An ADDRESS provided by this option will only be use if not restricted by
-the setting of \fICURLOPT_IPRESOLVE(3)\fP to a different IP version.
+An ADDRESS provided by this option will only be used if not restricted by the
+setting of \fICURLOPT_IPRESOLVE(3)\fP to a different IP version.
-Remove names from the DNS cache again, to stop providing these fake resolves,
-by including a string in the linked list that uses the format
-\&"-HOST:PORT". The host name must be prefixed with a dash, and the host name
-and port number must exactly match what was already added previously.
+To remove names from the DNS cache again, to stop providing these fake
+resolves, include a string in the linked list that uses the format
-Support for providing the ADDRESS within [brackets] was added in 7.57.0.
-
-Support for providing multiple IP addresses per entry was added in 7.59.0.
+.nf
+ -HOST:PORT
+.fi
-Support for adding non-permanent entries by using the "+" prefix was added in
-7.75.0.
+The entry to remove must be prefixed with a dash, and the host name and port
+number must exactly match what was added previously.
.SH DEFAULT
NULL
.SH PROTOCOLS
@@ -96,7 +96,15 @@ curl_slist_free_all(host);
.fi
.SH AVAILABILITY
Added in 7.21.3. Removal support added in 7.42.0.
+
+Support for providing the ADDRESS within [brackets] was added in 7.57.0.
+
+Support for providing multiple IP addresses per entry was added in 7.59.0.
+
+Support for adding non-permanent entries by using the "+" prefix was added in
+7.75.0.
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH "SEE ALSO"
-.BR CURLOPT_IPRESOLVE "(3), " CURLOPT_DNS_CACHE_TIMEOUT "(3), " CURLOPT_CONNECT_TO "(3), "
+.BR CURLOPT_IPRESOLVE "(3), " CURLOPT_DNS_CACHE_TIMEOUT "(3), "
+.BR CURLOPT_CONNECT_TO "(3), "