CURLOPT_PROXYHEADER.3 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  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 http://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_PROXYHEADER 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_PROXYHEADER \- custom HTTP headers to pass to proxy
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYHEADER,
  30. struct curl_slist *headers);
  31. .SH DESCRIPTION
  32. Pass a pointer to a linked list of HTTP headers to pass in your HTTP request
  33. sent to a proxy. The rules for this list is identical to the
  34. \fICURLOPT_HTTPHEADER(3)\fP option's.
  35. The headers set with this option is only ever used in requests sent to a proxy
  36. - when there's also a request sent to a host.
  37. The first line in a request (containing the method, usually a GET or POST) is
  38. NOT a header and cannot be replaced using this option. Only the lines
  39. following the request-line are headers. Adding this method line in this list
  40. of headers will only cause your request to send an invalid header.
  41. Pass a NULL to this to reset back to no custom headers.
  42. .SH DEFAULT
  43. NULL
  44. .SH PROTOCOLS
  45. HTTP
  46. .SH EXAMPLE
  47. TODO
  48. .SH AVAILABILITY
  49. Added in 7.37.0
  50. .SH RETURN VALUE
  51. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  52. .SH "SEE ALSO"
  53. .BR CURLOPT_HEADEROPT "(3), " CURLOPT_HTTPHEADER "(3), "