]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
CURLOPT_NOBODY.3: clarify this option is for downloads
authorDaniel Stenberg <daniel@haxx.se>
Wed, 27 Aug 2014 21:59:54 +0000 (23:59 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Wed, 27 Aug 2014 22:11:09 +0000 (00:11 +0200)
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
docs/libcurl/opts/CURLOPT_NOBODY.3

index 043f31e0a2ca057bac760cda2303784d8a934e47..0d7b7adcd8fd5b563f09fac285a7a61c551f92f2 100644 (file)
 .\"
 .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