man pages section 3: Library Interfaces and Headers

CURLOPT_AUTOREFERER (3)

Name

CURLOPT_AUTOREFERER - automatically update the referer header

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_AUTOREFERER, long autorefer);

Description

CURLOPT_AUTOREFERER(3)     curl_easy_setopt options     CURLOPT_AUTOREFERER(3)



NAME
       CURLOPT_AUTOREFERER - automatically update the referer header

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_AUTOREFERER, long autorefer);

DESCRIPTION
       Pass  a  parameter  set to 1 to enable this. When enabled, libcurl will
       automatically set the Referer: header field in  HTTP  requests  to  the
       full URL where it follows a Location: redirect.

DEFAULT
       0, disabled

PROTOCOLS
       HTTP

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");

         /* follow redirects */
         curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);

         /* set Referer: automatically when following redirects */
         curl_easy_setopt(curl, CURLOPT_AUTOREFERER, 1L);

         ret = curl_easy_perform(curl);

         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Along with HTTP

RETURN VALUE
       Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_REFERER(3), CURLOPT_FOLLOWLOCATION(3),



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021        CURLOPT_AUTOREFERER(3)