Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_NOBODY.3, revision 1.1
1.1 ! misho 1: .\" **************************************************************************
! 2: .\" * _ _ ____ _
! 3: .\" * Project ___| | | | _ \| |
! 4: .\" * / __| | | | |_) | |
! 5: .\" * | (__| |_| | _ <| |___
! 6: .\" * \___|\___/|_| \_\_____|
! 7: .\" *
! 8: .\" * Copyright (C) 1998 - 2017, 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 https://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 "June 21, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
! 24:
! 25: .SH NAME
! 26: CURLOPT_NOBODY \- do the download request without getting the body
! 27: .SH SYNOPSIS
! 28: #include <curl/curl.h>
! 29:
! 30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOBODY, long opt);
! 31: .SH DESCRIPTION
! 32: A long parameter set to 1 tells libcurl to not include the body-part in the
! 33: output when doing what would otherwise be a download. For HTTP(S), this makes
! 34: libcurl do a HEAD request. For most other protocols it means just not asking
! 35: to transfer the body data.
! 36:
! 37: Enabling this option means asking for a download but without a body.
! 38: .SH DEFAULT
! 39: 0, the body is transferred
! 40: .SH PROTOCOLS
! 41: Most
! 42: .SH EXAMPLE
! 43: .nf
! 44: curl = curl_easy_init();
! 45: if(curl) {
! 46: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
! 47:
! 48: /* get us the resource without a body! */
! 49: curl_easy_setopt(curl, CURLOPT_NOBODY, 1L);
! 50:
! 51: /* Perform the request */
! 52: curl_easy_perform(curl);
! 53: }
! 54: .fi
! 55: .SH AVAILABILITY
! 56: Always
! 57: .SH RETURN VALUE
! 58: Returns CURLE_OK
! 59: .SH "SEE ALSO"
! 60: .BR CURLOPT_HTTPGET "(3), " CURLOPT_POST "(3), "
! 61: .BR CURLOPT_REQUEST_TARGET "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>