docs/libcurl/opts/CURLOPT_USERAGENT.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_USERAGENT 3 "December 21, 2016" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_USERAGENT \- set HTTP user-agent header
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USERAGENT, char *ua);
  31 .SH DESCRIPTION
  32 Pass a pointer to a zero terminated string as parameter. It will be used to
  33 set the User-Agent: 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, no User-Agent: header is used by default.
  41 .SH PROTOCOLS
  42 HTTP, HTTPS
  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   curl_easy_setopt(curl, CURLOPT_USERAGENT, "Dark Secret Ninja/1.0");
  50
  51   curl_easy_perform(curl);
  52 }
  53 .fi
  54 .SH AVAILABILITY
  55 As long as HTTP is supported
  56 .SH RETURN VALUE
  57 Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or
  58 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  59 .SH "SEE ALSO"
  60 .BR CURLOPT_REFERER "(3), " CURLOPT_HTTPHEADER "(3), "