mirror of
https://github.com/curl/curl.git
synced 2024-12-09 06:30:06 +08:00
230bb3e278
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
59 lines
1.9 KiB
Groff
59 lines
1.9 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * 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
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * 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.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.TH curl_slist_free_all 3 "5 March 2001" "libcurl 7.0" "libcurl Manual"
|
|
.SH NAME
|
|
curl_slist_free_all - free an entire curl_slist list
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
void curl_slist_free_all(struct curl_slist *list);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
curl_slist_free_all() removes all traces of a previously built curl_slist
|
|
linked list.
|
|
|
|
Passing in a NULL pointer in \fIlist\fP will make this function return
|
|
immediately with no action.
|
|
.SH EXAMPLE
|
|
.nf
|
|
CURL *handle;
|
|
struct curl_slist *slist=NULL;
|
|
|
|
slist = curl_slist_append(slist, "X-libcurl: coolness");
|
|
|
|
if (slist == NULL)
|
|
return -1;
|
|
|
|
curl_easy_setopt(handle, CURLOPT_HTTPHEADER, slist);
|
|
|
|
curl_easy_perform(handle);
|
|
|
|
curl_slist_free_all(slist); /* free the list again */
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Always
|
|
.SH RETURN VALUE
|
|
Nothing.
|
|
.SH "SEE ALSO"
|
|
.BR curl_slist_append "(3), "
|