diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2021-09-01 10:26:36 +0200 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2021-09-04 11:27:46 +0200 |
| commit | 12a2ed970fbc027b3e6c8bec5a98e134f163fdd8 (patch) | |
| tree | 72cae0da452382a11db2886f1cbb336d47a56dd8 /docs/libcurl/opts/CURLOPT_ABSTRACT_UNIX_SOCKET.3 | |
| parent | 1731a77989230c117bc687937eec9d0bb488d0cc (diff) | |
| download | curl-12a2ed970fbc027b3e6c8bec5a98e134f163fdd8.tar.gz | |
opt-docs: verify man page sections + order
In every libcurl option man page there are now 8 mandatory sections that
must use the right name in the correct order and test 1173 verifies
this. Only 14 man pages needed adjustments.
The sections and the order is as follows:
- NAME
- SYNOPSIS
- DESCRIPTION
- PROTOCOLS
- EXAMPLE
- AVAILABILITY
- RETURN VALUE
- SEE ALSO
Reviewed-by: Daniel Gustafsson
Closes #7656
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_ABSTRACT_UNIX_SOCKET.3')
| -rw-r--r-- | docs/libcurl/opts/CURLOPT_ABSTRACT_UNIX_SOCKET.3 | 31 |
1 files changed, 16 insertions, 15 deletions
diff --git a/docs/libcurl/opts/CURLOPT_ABSTRACT_UNIX_SOCKET.3 b/docs/libcurl/opts/CURLOPT_ABSTRACT_UNIX_SOCKET.3 index 137308955..40c1dd235 100644 --- a/docs/libcurl/opts/CURLOPT_ABSTRACT_UNIX_SOCKET.3 +++ b/docs/libcurl/opts/CURLOPT_ABSTRACT_UNIX_SOCKET.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -28,26 +28,27 @@ CURLOPT_ABSTRACT_UNIX_SOCKET \- set an abstract Unix domain socket CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ABSTRACT_UNIX_SOCKET, char *path); .SH 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 will be set to \fIpath\fP 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). +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 will be set to +\fIpath\fP 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). -On non-supporting platforms, the abstract address will be interpreted as an empty -string and fail gracefully, generating a run-time error. - -This option shares the same semantics as -.BR 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. +On non-supporting platforms, the abstract address will be interpreted as an +empty string and fail gracefully, generating a run-time error. +This option shares the same semantics as \fICURLOPT_UNIX_SOCKET_PATH(3)\fP 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. .SH DEFAULT Default is NULL. +.SH PROTOCOLS +All .SH EXAMPLE .nf - curl_easy_setopt(curl_handle, CURLOPT_ABSTRACT_UNIX_SOCKET, "/tmp/foo.sock"); - curl_easy_setopt(curl_handle, CURLOPT_URL, "http://localhost/"); + curl_easy_setopt(curl_handle, CURLOPT_ABSTRACT_UNIX_SOCKET, "/tmp/foo.sock"); + curl_easy_setopt(curl_handle, CURLOPT_URL, "http://localhost/"); .fi .SH AVAILABILITY |