docs/libcurl/opts/CURLOPT_REQUEST_TARGET.3

   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_REQUEST_TARGET 3 "June 21, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_REQUEST_TARGET \- specify an alternative target for this request
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REQUEST_TARGET, string);
  31 .SH DESCRIPTION
  32 Pass a char * to string which libcurl uses in the upcoming request instead of
  33 the path as extracted from the URL.
  34 .SH DEFAULT
  35 NULL
  36 .SH PROTOCOLS
  37 HTTP
  38 .SH EXAMPLE
  39 .nf
  40 curl = curl_easy_init();
  41 if(curl) {
  42   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/*");
  43   curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "OPTIONS");
  44
  45   /* issue an OPTIONS * request (no leading slash) */
  46   curl_easy_setopt(curl, CURLOPT_REQUEST_TARGET, "*");
  47
  48   /* Perform the request */
  49   curl_easy_perform(curl);
  50 }
  51 .fi
  52 .SH AVAILABILITY
  53 Added in 7.55.0
  54 .SH RETURN VALUE
  55 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  56 .SH "SEE ALSO"
  57 .BR CURLOPT_CUSTOMREQUEST "(3), " CURLOPT_HTTPGET "(3), "