mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2025-01-12 13:55:11 +08:00
Code Issues Packages Projects Releases Wiki Activity
7eb31c852d
curl/docs/libcurl/curl_url_cleanup.3

54 lines
1.7 KiB
Groff
Raw Normal View History

URL-API See header file and man pages for API. All documented API details work and are tested in the 1560 test case. Closes #2842
2018-08-05 17:51:07 +08:00
.\" **************************************************************************
.\" * _ _ ____ _
.\" * Project ___| | | | _ \| |
.\" * / __| | | | |_) | |
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
copyright: update all copyright lines and remove year ranges - they are mostly pointless in all major jurisdictions - many big corporations and projects already don't use them - saves us from pointless churn - git keeps history for us - the year range is kept in COPYING checksrc is updated to allow non-year using copyright statements Closes #10205
2023-01-02 20:51:48 +08:00
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
URL-API See header file and man pages for API. All documented API details work and are tested in the 1560 test case. Closes #2842
2018-08-05 17:51:07 +08:00
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
curl.se: new home Closes #6172
2020-11-04 21:02:01 +08:00
.\" * are also available at https://curl.se/docs/copyright.html.
URL-API See header file and man pages for API. All documented API details work and are tested in the 1560 test case. Closes #2842
2018-08-05 17:51:07 +08:00
.\" *
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
.\" * copies of the Software, and permit persons to whom the Software is
.\" * furnished to do so, under the terms of the COPYING file.
.\" *
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
.\" * KIND, either express or implied.
.\" *
copyright: make repository REUSE compliant Add licensing and copyright information for all files in this repository. This either happens in the file itself as a comment header or in the file `.reuse/dep5`. This commit also adds a Github workflow to check pull requests and adapts copyright.pl to the changes. Closes #8869
2022-05-17 17:16:50 +08:00
.\" * SPDX-License-Identifier: curl
.\" *
URL-API See header file and man pages for API. All documented API details work and are tested in the 1560 test case. Closes #2842
2018-08-05 17:51:07 +08:00
.\" **************************************************************************
man pages: simplify the .TH sections - remove the version numbers - simplify the texts The date and version number will be put there for releases when maketgz runs the updatemanpages.pl script. Closes #11029
2023-04-26 14:58:35 +08:00
.TH curl_url_cleanup 3 "6 Aug 2018" "libcurl" "libcurl"
URL-API See header file and man pages for API. All documented API details work and are tested in the 1560 test case. Closes #2842
2018-08-05 17:51:07 +08:00
.SH NAME
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
curl_url_cleanup - free the URL handle
URL-API See header file and man pages for API. All documented API details work and are tested in the 1560 test case. Closes #2842
2018-08-05 17:51:07 +08:00
.SH SYNOPSIS
docs: consistent manpage SYNOPSIS Make all libcurl related options use .nf (no fill) for the SYNOPSIS section - for consistent look. roffit then renders that section using <pre> (monospace font) in html for the website. Extended manpage-syntax (test 1173) with a basic check for it. Closes #8062
2021-11-26 21:20:18 +08:00
.nf
#include <curl/curl.h>
URL-API See header file and man pages for API. All documented API details work and are tested in the 1560 test case. Closes #2842
2018-08-05 17:51:07 +08:00
void curl_url_cleanup(CURLU *handle);
.fi
.SH DESCRIPTION
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
Frees all the resources associated with the given \fICURLU\fP handle!
docs: document that curl_url_cleanup(NULL) is a safe no-op This has always been the case, but it was not documented. The paragraph was copied verbatim from curl_easy_cleanup.3 Closes #11150
2023-05-19 09:34:07 +08:00
curl_url*.3: update function descriptions - expand and clarify several descriptions - avoid using future tense all over Closes #11708
2023-08-22 17:26:05 +08:00
Passing in a NULL pointer in \fIhandle\fP makes this function return
docs: document that curl_url_cleanup(NULL) is a safe no-op This has always been the case, but it was not documented. The paragraph was copied verbatim from curl_easy_cleanup.3 Closes #11150
2023-05-19 09:34:07 +08:00
immediately with no action.
URL-API See header file and man pages for API. All documented API details work and are tested in the 1560 test case. Closes #2842
2018-08-05 17:51:07 +08:00
.SH EXAMPLE
.nf
CURLU *url = curl_url();
curl_url_set(url, CURLUPART_URL, "https://example.com", 0);
curl_url_cleanup(url);
.fi
.SH AVAILABILITY
docs: consistent use of "Added in" Make them all say "Added in [version]" without using 'curl' or 'libcurl' in that phrase.
2021-10-25 17:45:09 +08:00
Added in 7.62.0
man pages: require all to use the same section header order This is the same order we already enforce among the options' man pages: consistency is good. Add lots of previously missing examples. Adjust the manpage-syntax script for this purpose, used in test 1173. Closes #7904
2021-10-25 14:54:08 +08:00
.SH RETURN VALUE
none
URL-API See header file and man pages for API. All documented API details work and are tested in the 1560 test case. Closes #2842
2018-08-05 17:51:07 +08:00
.SH "SEE ALSO"
docs: adapt SEE ALSO sections to new requirements To please manpage-syntax.pl used by test 1173 Closes #11957
2023-09-27 05:25:11 +08:00
.BR curl_url_dup (3),
.BR curl_url (3),
.BR curl_url_set (3),
.BR curl_url_get (3),
.BR CURLOPT_CURLU (3)
Reference in New Issue Copy Permalink