summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2021-05-05 09:17:24 +0200
committerDaniel Stenberg <daniel@haxx.se>2021-05-06 16:54:05 +0200
commita42b8f08d81198865c699ead0e728da66c1041ef (patch)
tree168e0c52e96bdf678c5dc7a8f67f71bba095680e /docs
parent577f19397c3545da7b0162677e2783d188e74ae1 (diff)
downloadcurl-a42b8f08d81198865c699ead0e728da66c1041ef.tar.gz
libcurl.3: mention the URL API
To make it easier to find. Also a minor polish of libcurl-url.3 Closes #7009
Diffstat (limited to 'docs')
-rw-r--r--docs/libcurl/libcurl-url.39
-rw-r--r--docs/libcurl/libcurl.312
2 files changed, 12 insertions, 9 deletions
diff --git a/docs/libcurl/libcurl-url.3 b/docs/libcurl/libcurl-url.3
index 8bbc0b0f4..f08ebd826 100644
--- a/docs/libcurl/libcurl-url.3
+++ b/docs/libcurl/libcurl-url.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@@ -23,10 +23,9 @@
.SH NAME
libcurl-url \- URL interface overview
.SH DESCRIPTION
-The URL interface provides a set of functions for parsing and generating URLs.
+The URL interface provides functions for parsing and generating URLs.
.SH INCLUDE
-You still only include <curl/curl.h> in your code. Note that the URL API was
-introduced in 7.62.0.
+You still only include <curl/curl.h> in your code.
.SH CREATE
Create a handle that holds URL info and resources with \fIcurl_url(3)\fP:
@@ -132,6 +131,8 @@ Now the URL looks like
.nf
https://example.com/?shoes=2&hat=1&candy=N%26N`
.fi
+.SH AVALABILITY
+The URL API was introduced in libcurl 7.62.0.
.SH "SEE ALSO"
.BR curl_url "(3), " curl_url_cleanup "(3), " curl_url_get "(3), "
.BR curl_url_dup "(3), " curl_url_set "(3), " CURLOPT_URL "(3), "
diff --git a/docs/libcurl/libcurl.3 b/docs/libcurl/libcurl.3
index 22bb82305..ee4e864b7 100644
--- a/docs/libcurl/libcurl.3
+++ b/docs/libcurl/libcurl.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@@ -24,10 +24,10 @@
libcurl \- client-side URL transfers
.SH DESCRIPTION
This is a short overview on how to use libcurl in your C programs. There are
-specific man pages for each function mentioned in here. There are also the
-\fIlibcurl-easy(3)\fP man page, the \fIlibcurl-multi(3)\fP man page, the
-\fIlibcurl-share(3)\fP man page and the \fIlibcurl-tutorial(3)\fP man page for
-in-depth understanding on how to program with libcurl.
+specific man pages for each function mentioned in here. See
+\fIlibcurl-easy(3)\fP, \fIlibcurl-multi(3)\fP, \fIlibcurl-share(3)\fP,
+\fIlibcurl-url(3)\fP and \fIlibcurl-tutorial(3)\fP for in-depth understanding
+on how to program with libcurl.
There are many bindings available that bring libcurl access to your favourite
language. Look elsewhere for documentation on those.
@@ -84,6 +84,8 @@ free a list built with \fIcurl_formadd(3)\fP
builds a linked list
.IP curl_slist_free_all()
frees a whole curl_slist
+.IP curl_url_set()
+parses a URL
.RE
.SH "LINKING WITH LIBCURL"