diff options
Diffstat (limited to 'docs/libcurl/opts/GNURLOPT_USERAGENT.3')
| -rw-r--r-- | docs/libcurl/opts/GNURLOPT_USERAGENT.3 | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/libcurl/opts/GNURLOPT_USERAGENT.3 b/docs/libcurl/opts/GNURLOPT_USERAGENT.3 new file mode 100644 index 000000000..d05588890 --- /dev/null +++ b/docs/libcurl/opts/GNURLOPT_USERAGENT.3 @@ -0,0 +1,59 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2015, 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.haxx.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. +.\" * +.\" ************************************************************************** +.\" +.TH GNURLOPT_USERAGENT 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_USERAGENT \- set HTTP user-agent header +.SH SYNOPSIS +#include <gnurl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USERAGENT, char *ua); +.SH DESCRIPTION +Pass a pointer to a zero terminated string as parameter. It will be used to +set the User-Agent: header in the HTTP request sent to the remote server. This +can be used to fool servers or scripts. You can also 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, no User-Agent: header is used by default. +.SH PROTOCOLS +HTTP, HTTPS +.SH EXAMPLE +.nf +CURL *curl = curl_easy_init(); +if(curl) { + curl_easy_setopt(curl, CURLOPT_URL, "http://example.com"); + + curl_easy_setopt(curl, CURLOPT_USERAGENT, "Dark Secret Ninja/1.0"); + + curl_easy_perform(curl); +} +.fi +.SH AVAILABILITY +As long as HTTP is supported +.SH RETURN VALUE +Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or +CURLE_OUT_OF_MEMORY if there was insufficient heap space. +.SH "SEE ALSO" +.BR CURLOPT_REFERER "(3), " CURLOPT_HTTPHEADER "(3), " |