67 lines
2.2 KiB
Groff
67 lines
2.2 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" * SPDX-License-Identifier: curl
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_REFERER 3 "17 Jun 2014" libcurl libcurl
|
|
.SH NAME
|
|
CURLOPT_REFERER \- the HTTP referer header
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REFERER, char *where);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a pointer to a null-terminated string as parameter. It is used to set the
|
|
Referer: header field in the HTTP request sent to the remote server. You can
|
|
set any custom header with \fICURLOPT_HTTPHEADER(3)\fP.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
.SH DEFAULT
|
|
NULL
|
|
.SH PROTOCOLS
|
|
HTTP
|
|
.SH EXAMPLE
|
|
.nf
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
|
|
/* tell it where we found the link to this place */
|
|
curl_easy_setopt(curl, CURLOPT_REFERER, "https://example.com/aboutme.html");
|
|
|
|
curl_easy_perform(curl);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
If built with HTTP support
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if HTTP support is enabled, CURLE_UNKNOWN_OPTION if not, or
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
.SH "SEE ALSO"
|
|
.BR CURLINFO_REDIRECT_URL (3),
|
|
.BR CURLINFO_REFERER (3),
|
|
.BR CURLOPT_HTTPHEADER (3),
|
|
.BR CURLOPT_USERAGENT (3)
|