moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2025-01-11 05:58:01 -05:00
Code Issues Releases Wiki Activity

CURLOPT_NOBODY.3: clarify what setting to 0 means

Browse Source 
... and mention that HTTP with other methods than HEAD might get a body and
there's no option available to stop that.

Closes #5729
This commit is contained in:
Daniel Stenberg 2020-07-27 11:54:29 +02:00
parent 91cb16b21f
commit e1bac81cc8
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/libcurl/opts/CURLOPT_NOBODY.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___ .\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____| .\" * \___|\___/|_| \_\_____|
.\" * .\" *
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * .\" *
.\" * This software is licensed as described in the file COPYING, which .\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms .\" * you should have received as part of this distribution. The terms
@ -33,7 +33,17 @@ output when doing what would otherwise be a download. For HTTP(S), this makes
libcurl do a HEAD request. For most other protocols it means just not asking libcurl do a HEAD request. For most other protocols it means just not asking
to transfer the body data. to transfer the body data.
Enabling this option means asking for a download but without a body. For HTTP operations when \fBCURLOPT_NOBODY(3)\fP has been set, unsetting the
option (with 0) will make it a GET again - only if the method is still set to
be HEAD. The proper way to get back to a GET request is to set
\fBCURLOPT_HTTPGET(3)\fP and for other methods, use the POST ur UPLOAD
options.
Enabling \fBCURLOPT_NOBODY(3)\fP means asking for a download without a body.
If you do a transfer with HTTP that involves a method other than HEAD, you
will get a body (unless the resource and server sends a zero byte body for the
specific URL you request).
.SH DEFAULT .SH DEFAULT
0, the body is transferred 0, the body is transferred
.SH PROTOCOLS .SH PROTOCOLS
@ -42,9 +52,9 @@ Most
.nf .nf
curl = curl_easy_init(); curl = curl_easy_init();
if(curl) { if(curl) {
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com"); curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
/* get us the resource without a body! */ /* get us the resource without a body - use HEAD! */
curl_easy_setopt(curl, CURLOPT_NOBODY, 1L); curl_easy_setopt(curl, CURLOPT_NOBODY, 1L);
/* Perform the request */ /* Perform the request */
@ -56,5 +66,5 @@ Always
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK Returns CURLE_OK
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_HTTPGET "(3), " CURLOPT_POST "(3), " .BR CURLOPT_HTTPGET "(3), " CURLOPT_POSTFIELDS "(3), " CURLOPT_UPLOAD "(3), "
.BR CURLOPT_REQUEST_TARGET "(3), " .BR CURLOPT_REQUEST_TARGET "(3), " CURLOPT_MIMEPOST "(3), "