CURLOPT_HTTP200ALIASES.3 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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.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_HTTP200ALIASES 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_HTTP200ALIASES \- alternative matches for HTTP 200 OK
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTP200ALIASES,
  30. struct curl_slist *aliases);
  31. .SH DESCRIPTION
  32. Pass a pointer to a linked list of \fIaliases\fP to be treated as valid HTTP
  33. 200 responses. Some servers respond with a custom header response line. For
  34. example, SHOUTcast servers respond with "ICY 200 OK". Also some old Icecast
  35. 1.3.x servers will respond like that for certain user agent headers or in
  36. absence of such. By including this string in your list of aliases, the
  37. response will be treated as a valid HTTP header line such as "HTTP/1.0 200
  38. OK".
  39. The linked list should be a fully valid list of struct curl_slist structs, and
  40. be properly filled in. Use \fIcurl_slist_append(3)\fP to create the list and
  41. \fIcurl_slist_free_all(3)\fP to clean up an entire list.
  42. The alias itself is not parsed for any version strings. The protocol is
  43. assumed to match HTTP 1.0 when an alias match.
  44. .SH DEFAULT
  45. NULL
  46. .SH PROTOCOLS
  47. HTTP
  48. .SH EXAMPLE
  49. .nf
  50. CURL *curl = curl_easy_init();
  51. if(curl) {
  52. struct curl_slist *list;
  53. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  54. list = curl_slist_append(NULL, "ICY 200 OK");
  55. list = curl_slist_append(list, "WEIRDO 99 FINE");
  56. curl_easy_setopt(curl, CURLOPT_HTTP200ALIASES, list);
  57. curl_easy_perform(curl);
  58. curl_slist_free_all(list); /* free the list again */
  59. }
  60. .fi
  61. .SH AVAILABILITY
  62. Added in 7.10.3
  63. .SH RETURN VALUE
  64. Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
  65. .SH "SEE ALSO"
  66. .BR CURLOPT_HTTP_VERSION "(3), "