diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2020-07-27 11:54:29 +0200 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2020-07-27 11:54:29 +0200 |
| commit | 371997b375cca5874e2559da12ca1752bd0a10f3 (patch) | |
| tree | 92a1af38e71848c51152f26fbde40c730a321140 | |
| parent | 0c6112a139c1133f7bdfc440903c0e5602c84d90 (diff) | |
| download | curl-bagder/nobody-clarify.tar.gz | |
CURLOPT_NOBODY.3: clarify what setting to 0 meansbagder/nobody-clarify
... and mention that HTTP with other methods than HEAD might get a body and
there's no option available to stop that.
| -rw-r--r-- | docs/libcurl/opts/CURLOPT_NOBODY.3 | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/docs/libcurl/opts/CURLOPT_NOBODY.3 b/docs/libcurl/opts/CURLOPT_NOBODY.3 index 02590b212..34a0f2e38 100644 --- a/docs/libcurl/opts/CURLOPT_NOBODY.3 +++ b/docs/libcurl/opts/CURLOPT_NOBODY.3 @@ -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 .\" * 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 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 nother 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 0, the body is transferred .SH PROTOCOLS @@ -42,9 +52,9 @@ Most .nf curl = curl_easy_init(); 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); /* Perform the request */ @@ -56,5 +66,5 @@ Always .SH RETURN VALUE Returns CURLE_OK .SH "SEE ALSO" -.BR CURLOPT_HTTPGET "(3), " CURLOPT_POST "(3), " -.BR CURLOPT_REQUEST_TARGET "(3), " +.BR CURLOPT_HTTPGET "(3), " CURLOPT_POSTFIELDS "(3), " CURLOPT_UPLOAD "(3), " +.BR CURLOPT_REQUEST_TARGET "(3), " CURLOPT_MIMEPOST "(3), " |