docs/libcurl/opts/CURLOPT_REFERER.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, 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_REFERER 3 "December 21, 2016" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_REFERER \- set the HTTP referer header
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REFERER, char *where);
  31 .SH DESCRIPTION
  32 Pass a pointer to a zero terminated string as parameter. It will be used to
  33 set the Referer: header in the http request sent to the remote server. This
  34 can be used to fool servers or scripts. You can also set any custom header
  35 with \fICURLOPT_HTTPHEADER(3)\fP.
  36
  37 The application does not have to keep the string around after setting this
  38 option.
  39 .SH DEFAULT
  40 NULL
  41 .SH PROTOCOLS
  42 HTTP
  43 .SH EXAMPLE
  44 .nf
  45 CURL *curl = curl_easy_init();
  46 if(curl) {
  47   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  48
  49   /* tell it where we found the link to this place */
  50   curl_easy_setopt(curl, CURLOPT_REFERER, "http://example.com/aboutme.html");
  51
  52   curl_easy_perform(curl);
  53 }
  54 .fi
  55 .SH AVAILABILITY
  56 If built with HTTP support
  57 .SH RETURN VALUE
  58 Returns CURLE_OK if HTTP support is enabled, CURLE_UNKNOWN_OPTION if not, or
  59 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  60 .SH "SEE ALSO"
  61 .BR CURLOPT_USERAGENT "(3), " CURLOPT_HTTPHEADER "(3), "