CURLOPT_SSL_ENABLE_NPN.3 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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_SSL_ENABLE_NPN 3 "19 Jun 2014" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_SSL_ENABLE_NPN \- use NPN
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_ENABLE_NPN, long npn);
  32. .fi
  33. .SH DESCRIPTION
  34. Deprecated in 7.86.0. Setting this option has no function.
  35. Pass a long as parameter, 0 or 1 where 1 is for enable and 0 for disable. This
  36. option enables/disables NPN in the SSL handshake (if the SSL backend libcurl
  37. is built to use supports it), which can be used to negotiate http2.
  38. .SH DEFAULT
  39. 1, enabled
  40. .SH PROTOCOLS
  41. HTTP
  42. .SH EXAMPLE
  43. .nf
  44. CURL *curl = curl_easy_init();
  45. if(curl) {
  46. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  47. curl_easy_setopt(curl, CURLOPT_SSL_ENABLE_NPN, 1L);
  48. ret = curl_easy_perform(curl);
  49. curl_easy_cleanup(curl);
  50. }
  51. .fi
  52. .SH AVAILABILITY
  53. Added in 7.36.0. Deprecated in 7.86.0.
  54. .SH RETURN VALUE
  55. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  56. .SH "SEE ALSO"
  57. .BR CURLOPT_SSL_ENABLE_ALPN "(3), " CURLOPT_SSL_OPTIONS "(3), "