eefcc1bda4
curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
112 lines
2.0 KiB
Markdown
112 lines
2.0 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_ALTSVC
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_ALTSVC_CTRL (3)
|
|
- CURLOPT_CONNECT_TO (3)
|
|
- CURLOPT_COOKIEFILE (3)
|
|
- CURLOPT_RESOLVE (3)
|
|
---
|
|
<!-- markdown-link-check-disable -->
|
|
# NAME
|
|
|
|
CURLOPT_ALTSVC - alt-svc cache file name
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ALTSVC, char *filename);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass in a pointer to a *filename* to instruct libcurl to use that file as
|
|
the Alt-Svc cache to read existing cache contents from and possibly also write
|
|
it back to after a transfer, unless **CURLALTSVC_READONLYFILE** is set in
|
|
CURLOPT_ALTSVC_CTRL(3).
|
|
|
|
Specify a blank file name ("") to make libcurl not load from a file at all.
|
|
|
|
# DEFAULT
|
|
|
|
NULL. The alt-svc cache is not read nor written to file.
|
|
|
|
# PROTOCOLS
|
|
|
|
HTTPS
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_ALTSVC_CTRL, CURLALTSVC_H1);
|
|
curl_easy_setopt(curl, CURLOPT_ALTSVC, "altsvc-cache.txt");
|
|
curl_easy_perform(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# FILE FORMAT
|
|
|
|
A text based file with one line per alt-svc entry and each line consists of
|
|
nine space-separated fields.
|
|
|
|
An example line could look like
|
|
|
|
h2 www.example.com 8443 h3 second.example.com 443 "20190808 06:18:37" 1 0
|
|
|
|
The fields of that line are:
|
|
|
|
## h2
|
|
|
|
ALPN id for the source origin
|
|
|
|
## www.example.comp
|
|
|
|
Host name for the source origin
|
|
|
|
## 8443
|
|
|
|
Port number for the source origin
|
|
|
|
## h3
|
|
|
|
ALPN id for the destination host
|
|
|
|
## second.example.com
|
|
|
|
Host name for the destination host
|
|
|
|
## 443
|
|
|
|
Port number for the destination host
|
|
|
|
## 2019*
|
|
|
|
Expiration date and time of this entry within double quotes. The date format
|
|
is "YYYYMMDD HH:MM:SS" and the time zone is GMT.
|
|
|
|
## 1
|
|
|
|
Boolean (1 or 0) if "persist" was set for this entry
|
|
|
|
## 0
|
|
|
|
Integer priority value (not currently used)
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 7.64.1
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|