summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2022-06-12 12:53:54 +0200
committerDaniel Stenberg <daniel@haxx.se>2022-06-12 23:10:51 +0200
commit965119855d74c918372099bdcf81efa76b7a6988 (patch)
tree79537361f289978b53adb2c93c8998e179546f48
parent18a01e322981705aef23dd012a3fd2183abb1174 (diff)
downloadcurl-965119855d74c918372099bdcf81efa76b7a6988.tar.gz
curl_url_set.3: clarify by default using known schemes only
Closes #8994
-rw-r--r--docs/libcurl/curl_url_set.38
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/libcurl/curl_url_set.3 b/docs/libcurl/curl_url_set.3
index 68b145654..bbea5de4b 100644
--- a/docs/libcurl/curl_url_set.3
+++ b/docs/libcurl/curl_url_set.3
@@ -18,6 +18,8 @@
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
.\" * KIND, either express or implied.
.\" *
+.\" * SPDX-License-Identifier: curl
+.\" *
.\" **************************************************************************
.TH curl_url_set 3 "6 Aug 2018" "libcurl" "libcurl Manual"
.SH NAME
@@ -46,6 +48,12 @@ call.
Setting a part to a NULL pointer will effectively remove that part's contents
from the CURLU handle.
+By default, this API only accepts URLs using schemes for protocols that are
+supported built-in. To make libcurl parse URLs generically even for schemes it
+does not know about, the \fBCURLU_NON_SUPPORT_SCHEME\fP flags bit must be
+set. Otherwise, this function returns \fICURLUE_UNSUPPORTED_SCHEME\fP on URL
+schemes it does not recognize.
+
The \fIflags\fP argument is a bitmask with independent features.
.SH PARTS
.IP CURLUPART_URL