docs/libcurl/opts/CURLOPT_PROXYAUTH.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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_PROXYAUTH 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_PROXYAUTH \- set HTTP proxy authentication methods to try
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYAUTH, long bitmask);
  30 .SH DESCRIPTION
  31 Pass a long as parameter, which is set to a bitmask, to tell libcurl which
  32 HTTP authentication method(s) you want it to use for your proxy
  33 authentication.  If more than one bit is set, libcurl will first query the
  34 site to see what authentication methods it supports and then pick the best one
  35 you allow it to use. For some methods, this will induce an extra network
  36 round-trip. Set the actual name and password with the
  37 \fICURLOPT_PROXYUSERPWD(3)\fP option.
  38
  39 The bitmask can be constructed by or'ing together the bits fully listed and
  40 described in the \fICURLOPT_HTTPAUTH(3)\fP man page.
  41 .SH DEFAULT
  42 CURLAUTH_BASIC
  43 .SH PROTOCOLS
  44 HTTP
  45 .SH EXAMPLE
  46 TODO
  47 .SH AVAILABILITY
  48 Added in 7.10.7
  49 .SH RETURN VALUE
  50 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  51 CURLE_NOT_BUILT_IN if the bitmask specified no supported authentication
  52 methods.
  53 .SH "SEE ALSO"
  54 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "
  55 .BR CURLOPT_PROXYUSERPWD "(3), " CURLOPT_PROXYPORT "(3), "