]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
curl_url_set.3: clarify by default using known schemes only
authorDaniel Stenberg <daniel@haxx.se>
Sun, 12 Jun 2022 10:53:54 +0000 (12:53 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Sun, 12 Jun 2022 21:10:51 +0000 (23:10 +0200)
Closes #8994

docs/libcurl/curl_url_set.3

index 68b145654838e52763ab2e614e701a47ce530cf4..bbea5de4b1ff7403b8aedcb15eedec63e872d4b0 100644 (file)
@@ -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