aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2014-08-27 23:59:54 +0200
committerDaniel Stenberg <daniel@haxx.se>2014-08-28 00:11:09 +0200
commit1d30f4095064fafbba2852ca98627968dc5b7f46 (patch)
tree68416220606cb5d19f29916759c5fa19e6afade7 /docs
parent1cd5008bba4e511aad2cec05d8319f5f03fee590 (diff)
CURLOPT_NOBODY.3: clarify this option is for downloads
When enabling CURLOPT_NOBODY, libcurl effectively switches off upload mode and will do a download (without a body). This is now better explained in this man page. Bug: http://curl.haxx.se/mail/lib-2014-08/0236.html Reported-by: John Coffey
Diffstat (limited to 'docs')
-rw-r--r--docs/libcurl/opts/CURLOPT_NOBODY.39
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/libcurl/opts/CURLOPT_NOBODY.3 b/docs/libcurl/opts/CURLOPT_NOBODY.3
index 043f31e0a..0d7b7adcd 100644
--- a/docs/libcurl/opts/CURLOPT_NOBODY.3
+++ b/docs/libcurl/opts/CURLOPT_NOBODY.3
@@ -22,15 +22,18 @@
.\"
.TH CURLOPT_NOBODY 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
.SH NAME
-CURLOPT_NOBODY \- do the request without getting the body
+CURLOPT_NOBODY \- do the download request without getting the body
.SH SYNOPSIS
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOBODY, long opt);
.SH DESCRIPTION
A long parameter set to 1 tells libcurl to not include the body-part in the
-output. For HTTP(S), this makes libcurl do a HEAD request. For most other
-protocols it means just not asking to transfer the body data.
+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.
.SH DEFAULT
0, the body is transferred
.SH PROTOCOLS