12a2ed970f
In every libcurl option man page there are now 8 mandatory sections that must use the right name in the correct order and test 1173 verifies this. Only 14 man pages needed adjustments. The sections and the order is as follows: - NAME - SYNOPSIS - DESCRIPTION - PROTOCOLS - EXAMPLE - AVAILABILITY - RETURN VALUE - SEE ALSO Reviewed-by: Daniel Gustafsson Closes #7656
52 lines
1.8 KiB
Groff
52 lines
1.8 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 CURLOPT_TRAILERDATA 3 "14 Aug 2018" "libcurl 7.64.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_TRAILERDATA \- Custom pointer passed to the trailing headers callback
|
|
.SH SYNOPSIS
|
|
#include <curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TRAILERDATA, void *userdata);
|
|
.SH DESCRIPTION
|
|
Data pointer to be passed to the HTTP trailer callback function.
|
|
.SH DEFAULT
|
|
NULL
|
|
.SH PROTOCOLS
|
|
HTTP
|
|
.SH EXAMPLE
|
|
.nf
|
|
/* Assuming we have a CURL handle in the hndl variable. */
|
|
|
|
struct MyData data;
|
|
|
|
curl_easy_setopt(hndl, CURLOPT_TRAILERDATA, &data);
|
|
.fi
|
|
|
|
A more complete example can be found in examples/http_trailers.html
|
|
.SH AVAILABILITY
|
|
This option was added in curl 7.64.0 and is present if HTTP support is enabled
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_TRAILERFUNCTION "(3), "
|