CURLOPT_AUTOREFERER.3 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2017, 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_AUTOREFERER 3 "May 05, 2017" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_AUTOREFERER \- automatically update the referer header
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_AUTOREFERER, long autorefer);
  29. .SH DESCRIPTION
  30. Pass a parameter set to 1 to enable this. When enabled, libcurl will
  31. automatically set the Referer: header field in HTTP requests where it follows
  32. a Location: redirect.
  33. .SH DEFAULT
  34. 0, disabled
  35. .SH PROTOCOLS
  36. HTTP
  37. .SH EXAMPLE
  38. .nf
  39. CURL *curl = curl_easy_init();
  40. if(curl) {
  41. curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
  42. /* follow redirects */
  43. curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
  44. /* set Referer: automatically when following redirects */
  45. curl_easy_setopt(curl, CURLOPT_AUTOREFERER, 1L);
  46. ret = curl_easy_perform(curl);
  47. curl_easy_cleanup(curl);
  48. }
  49. .fi
  50. .SH AVAILABILITY
  51. Along with HTTP
  52. .SH RETURN VALUE
  53. Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
  54. .SH "SEE ALSO"
  55. .BR CURLOPT_REFERER "(3), " CURLOPT_FOLLOWLOCATION "(3), "