mirror of
https://github.com/curl/curl.git
synced 2026-07-07 06:47:15 +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
71 lines
1.6 KiB
Markdown
71 lines
1.6 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_ABSTRACT_UNIX_SOCKET
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_UNIX_SOCKET_PATH (3)
|
|
- unix (7)
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_ABSTRACT_UNIX_SOCKET - abstract Unix domain socket
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ABSTRACT_UNIX_SOCKET,
|
|
char *path);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Enables the use of an abstract Unix domain socket instead of establishing a
|
|
TCP connection to a host. The parameter should be a char * to a
|
|
null-terminated string holding the path of the socket. The path is set to
|
|
*path* prefixed by a NULL byte. This is the convention for abstract
|
|
sockets, however it should be stressed that the path passed to this function
|
|
should not contain a leading NULL byte.
|
|
|
|
On non-supporting platforms, the abstract address is interpreted as an empty
|
|
string and fails gracefully, generating a runtime error.
|
|
|
|
This option shares the same semantics as CURLOPT_UNIX_SOCKET_PATH(3) in
|
|
which documentation more details can be found. Internally, these two options
|
|
share the same storage and therefore only one of them can be set per handle.
|
|
|
|
# DEFAULT
|
|
|
|
Default is NULL.
|
|
|
|
# PROTOCOLS
|
|
|
|
All
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_ABSTRACT_UNIX_SOCKET, "/tmp/foo.sock");
|
|
curl_easy_setopt(curl, CURLOPT_URL, "http://localhost/");
|
|
|
|
/* Perform the request */
|
|
curl_easy_perform(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 7.53.0.
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|