romenskiy2012/curl

mirror of https://github.com/curl/curl.git synced 2026-08-11 03:41:22 +03:00

Daniel Stenberg e3fe020089

docs/libcurl: generate PROTOCOLS from meta-data

Remove the PROTOCOLS section from the source files completely and
instead generate them based on the header data in the curldown files.

It also generates TLS backend information for options marked for TLS as
protocol.

Closes #13175

2024-03-23 18:13:03 +01:00

1.2 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

TLS-backend

curl

CURLOPT_EGDSOCKET

libcurl

CURLOPT_RANDOM_FILE (3)

TLS

OpenSSL

NAME

CURLOPT_EGDSOCKET - EGD socket path

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_EGDSOCKET, char *path);

DESCRIPTION

Deprecated option. It serves no purpose anymore.

Pass a char pointer to the null-terminated path name to the Entropy Gathering Daemon socket. It is used to seed the random engine for TLS.

The application does not have to keep the string around after setting this option.

DEFAULT

NULL

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
    curl_easy_setopt(curl, CURLOPT_EGDSOCKET, "/var/egd.socket");
    res = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

AVAILABILITY

Only with OpenSSL versions before 1.1.0.

This option was deprecated in 7.84.0.

RETURN VALUE

Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.

1.2 KiB Raw Blame History