mirror of
https://github.com/curl/curl.git
synced 2026-08-06 08:26:13 +03:00
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
72 lines
1.3 KiB
Markdown
72 lines
1.3 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_HSTSWRITEDATA
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_HSTS (3)
|
|
- CURLOPT_HSTSREADDATA (3)
|
|
- CURLOPT_HSTSREADFUNCTION (3)
|
|
- CURLOPT_HSTSWRITEFUNCTION (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_HSTSWRITEDATA - pointer passed to the HSTS write callback
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HSTSWRITEDATA, void *pointer);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Data *pointer* to pass to the HSTS write function. If you use the
|
|
CURLOPT_HSTSWRITEFUNCTION(3) option, this is the pointer you get as
|
|
input in the fourth argument to the callback.
|
|
|
|
This option does not enable HSTS, you need to use CURLOPT_HSTS_CTRL(3) to
|
|
do that.
|
|
|
|
# DEFAULT
|
|
|
|
NULL
|
|
|
|
# PROTOCOLS
|
|
|
|
This feature is only used for HTTP(S) transfer.
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
struct MyData {
|
|
void *custom;
|
|
};
|
|
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
struct MyData this;
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
|
|
|
|
/* pass pointer that gets passed in to the
|
|
CURLOPT_HSTSWRITEFUNCTION callback */
|
|
curl_easy_setopt(curl, CURLOPT_HSTSWRITEDATA, &this);
|
|
|
|
curl_easy_perform(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 7.74.0
|
|
|
|
# RETURN VALUE
|
|
|
|
This returns CURLE_OK.
|