diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2014-06-16 20:26:32 +0200 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2014-06-16 20:26:32 +0200 |
| commit | 7e109995fde06a59933c99d291ad9f46fd7a59f2 (patch) | |
| tree | 2bab1758d0ac0a5fac4ccd0d6d848987caad44b9 | |
| parent | 34d02aff71eb8a74bbb89ed1e5ccc5a69a9f3137 (diff) | |
CURLOPT_HEADER: initial man page
| -rw-r--r-- | docs/libcurl/opts/CURLOPT_HEADER.3 | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_HEADER.3 b/docs/libcurl/opts/CURLOPT_HEADER.3 new file mode 100644 index 000000000..aa1afc499 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_HEADER.3 @@ -0,0 +1,43 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2014, 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 http://curl.haxx.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_HEADER 3 "16 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_HEADER \- pass headers to the data stream +.SH SYNOPSIS +#include <curl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HEADER, long onoff); +.SH DESCRIPTION +Pass in \fIonoff\fP set to 1 to tell the library to include the header in the +body output for requests with this \fIhandle\fP. This option is relevant for +protocols that actually have headers or other meta-data (like HTTP and FTP). +The default value for this option is 0. + +When asking to get the header info passed to the same callback as the body, it +is not possible to accurately separate them again without detailed knowledge +about the protocol in use. + +It is often better to use \fICURLOPT_HEADERFUNCTION(3)\fP to get the header +data separately. +.SH "SEE ALSO" +.BR CURLOPT_HEADERFUNCTION "(3), " |