docs/libcurl/opts/CURLOPT_HTTP200ALIASES.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 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_HTTP200ALIASES 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_HTTP200ALIASES \- specify alternative matches for HTTP 200 OK
  26 .SH SYNOPSIS
  27 .nf
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTP200ALIASES,
  31                           struct curl_slist *aliases);
  32 .SH DESCRIPTION
  33 Pass a pointer to a linked list of \fIaliases\fP to be treated as valid HTTP
  34 200 responses.  Some servers respond with a custom header response line.  For
  35 example, SHOUTcast servers respond with "ICY 200 OK". Also some very old
  36 Icecast 1.3.x servers will respond like that for certain user agent headers or
  37 in absence of such. By including this string in your list of aliases,
  38 the response will be treated as a valid HTTP header line such as
  39 "HTTP/1.0 200 OK".
  40
  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
  45 The alias itself is not parsed for any version strings. The protocol is
  46 assumed to match HTTP 1.0 when an alias match.
  47 .SH DEFAULT
  48 NULL
  49 .SH PROTOCOLS
  50 HTTP
  51 .SH EXAMPLE
  52 TODO
  53 .SH AVAILABILITY
  54 Added in 7.10.3
  55 .SH RETURN VALUE
  56 Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
  57 .SH "SEE ALSO"
  58 .BR CURLOPT_HTTP_VERSION "(3), "