CURLOPT_HTTP200ALIASES.3 2.8 KB

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