| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) 1998 - 2014, 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 http://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 CURLOPT_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 <curl/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.
- .SH DEFAULT
- NULL, no User-Agent: header is used by default.
- .SH PROTOCOLS
- HTTP, HTTPS
- .SH EXAMPLE
- TODO
- .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), "
|
