docs/libcurl/opts/CURLOPT_NOBODY.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at http://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .\"
  23 .TH CURLOPT_NOBODY 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_NOBODY \- do the request without getting the body
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOBODY, long opt);
  30 .SH DESCRIPTION
  31 A long parameter set to 1 tells libcurl to not include the body-part in the
  32 output. For HTTP(S), this makes libcurl do a HEAD request. For most other
  33 protocols ie means just not asking for transferring the body data.
  34 .SH DEFAULT
  35 0, the body is transferred
  36 .SH PROTOCOLS
  37 Most
  38 .SH EXAMPLE
  39 TODO
  40 .SH AVAILABILITY
  41 Always
  42 .SH RETURN VALUE
  43 Returns CURLE_OK
  44 .SH "SEE ALSO"
  45 .BR CURLOPT_HTTPGET "(3), " CURLOPT_POST "(3), "