CURLOPT_ALTSVC.3 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  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_ALTSVC 3 "5 Feb 2019" "libcurl 7.64.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_ALTSVC \- alt-svc cache file name
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ALTSVC, char *filename);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass in a pointer to a \fIfilename\fP to instruct libcurl to use that file as
  33. the Alt-Svc cache to read existing cache contents from and possibly also write
  34. it back to a after a transfer, unless \fBCURLALTSVC_READONLYFILE\fP is set in
  35. \fICURLOPT_ALTSVC_CTRL(3)\fP.
  36. Specify a blank file name ("") to make libcurl not load from a file at all.
  37. .SH DEFAULT
  38. NULL. The alt-svc cache is not read nor written to file.
  39. .SH PROTOCOLS
  40. HTTPS
  41. .SH EXAMPLE
  42. .nf
  43. CURL *curl = curl_easy_init();
  44. if(curl) {
  45. curl_easy_setopt(curl, CURLOPT_ALTSVC_CTRL, CURLALTSVC_H1);
  46. curl_easy_setopt(curl, CURLOPT_ALTSVC, "altsvc-cache.txt");
  47. curl_easy_perform(curl);
  48. }
  49. .fi
  50. .SH AVAILABILITY
  51. Added in 7.64.1
  52. .SH RETURN VALUE
  53. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  54. .SH "SEE ALSO"
  55. .BR CURLOPT_ALTSVC_CTRL "(3), " CURLOPT_CONNECT_TO "(3), " CURLOPT_RESOLVE "(3), "
  56. .BR CURLOPT_COOKIEFILE "(3), "