mirror of
https://github.com/moparisthebest/curl
synced 2024-11-14 13:35:03 -05:00
032e838b73
Updated terminology in docs, comments and phrases to refer to C strings as "null-terminated". Done to unify with how most other C oriented docs refer of them and what users in general seem to prefer (based on a single highly unscientific poll on twitter). Reported-by: coinhubs on github Fixes #5598 Closes #5608
59 lines
2.5 KiB
Groff
59 lines
2.5 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2017, 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
|
|
.\" * are also available at https://curl.haxx.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_ABSTRACT_UNIX_SOCKET 3 "08 Jan 2017" "libcurl 7.53.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_ABSTRACT_UNIX_SOCKET \- set an abstract Unix domain socket
|
|
.SH SYNOPSIS
|
|
#include <curl/curl.h>
|
|
|
|
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).
|
|
|
|
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.
|
|
|
|
.SH DEFAULT
|
|
Default is NULL.
|
|
.SH EXAMPLE
|
|
.nf
|
|
curl_easy_setopt(curl_handle, CURLOPT_ABSTRACT_UNIX_SOCKET, "/tmp/foo.sock");
|
|
curl_easy_setopt(curl_handle, CURLOPT_URL, "http://localhost/");
|
|
.fi
|
|
|
|
.SH AVAILABILITY
|
|
Since 7.53.0.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_UNIX_SOCKET_PATH "(3), " unix "(7), "
|