tizen 2.3.1 release
[external/curl.git] / docs / libcurl / opts / CURLOPT_SSL_ENABLE_ALPN.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_SSL_ENABLE_ALPN 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_SSL_ENABLE_ALPN \- enable ALPN
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_ENABLE_ALPN, long npn);
30 .SH DESCRIPTION
31 Pass a long as parameter, 0 or 1 where 1 is for enable and 0 for disable. This
32 option enables/disables ALPN in the SSL handshake (if the SSL backend libcurl
33 is built to use supports it), which can be used to negotiate http2.
34 .SH DEFAULT
35 1, enabled
36 .SH PROTOCOLS
37 HTTP
38 .SH EXAMPLE
39 TODO
40 .SH AVAILABILITY
41 Added in 7.36.0
42 .SH RETURN VALUE
43 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
44 .SH "SEE ALSO"
45 .BR CURLOPT_SSL_ENABLE_NPN "(3), " CURLOPT_SSL_OPTIONS "(3), "