generic-library/curl
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

opts: fix CURLOPT_UNIX_SOCKET_PATH formatting

Browse Source 
Add .nf and .fi such that the code gets wrapped in a pre on the web.
Fixed grammar, fixed formatting of the "See also" items.

Signed-off-by: Peter Wu <peter@lekensteyn.nl>
This commit is contained in:
Peter Wu
2014-12-04 14:46:51 -08:00
committed by Daniel Stenberg
parent 4ce87e33ee
commit 4fd0add1cd
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/libcurl/opts/CURLOPT_UNIX_SOCKET_PATH.3
View File

@@ -28,16 +28,17 @@ CURLOPT_UNIX_SOCKET_PATH \- set UNIX domain socket
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_UNIX_SOCKET_PATH, char *path); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_UNIX_SOCKET_PATH, char *path);
.SH DESCRIPTION .SH DESCRIPTION
Enables the use of UNIX domain sockets as connection end point and sets the path Enables the use of UNIX domain sockets as connection endpoint and sets the path
to \fIpath\fP. If \fIpath\fP is NULL, then UNIX domain sockets are disabled. An to \fIpath\fP. If \fIpath\fP is NULL, then UNIX domain sockets are disabled. An
empty string will result in an error at some point. empty string will result in an error at some point, it will not disable use of
UNIX domain sockets.
When enabled, cURL will connect to the UNIX domain socket instead of When enabled, cURL will connect to the UNIX domain socket instead of
establishing a TCP connection to a host. Since no TCP connection is established, establishing a TCP connection to a host. Since no TCP connection is created,
cURL does not need to resolve the DNS hostname in the URL. cURL does not need to resolve the DNS hostname in the URL.
The maximum path length on Cygwin, Linux and Solaris is 107. On other platforms The maximum path length on Cygwin, Linux and Solaris is 107. On other platforms
might be even less. it might be even less.
Proxy and TCP options such as Proxy and TCP options such as
.BR CURLOPT_TCP_NODELAY "(3) .BR CURLOPT_TCP_NODELAY "(3)
@@ -54,23 +55,24 @@ POP3 and SMTP should in particular work (including their SSL/TLS variants).
Given that you have an nginx server running, listening on /tmp/nginx.sock, you Given that you have an nginx server running, listening on /tmp/nginx.sock, you
can request a HTTP resource with: can request a HTTP resource with:
.nf
curl_easy_setopt(curl_handle, CURLOPT_UNIX_SOCKET_PATH, "/tmp/nginx.sock"); curl_easy_setopt(curl_handle, CURLOPT_UNIX_SOCKET_PATH, "/tmp/nginx.sock");
curl_easy_setopt(curl_handle, CURLOPT_URL, "http://localhost/"); curl_easy_setopt(curl_handle, CURLOPT_URL, "http://localhost/");
.fi
If you are on Linux and somehow have a need for paths larger than 107 bytes, you If you are on Linux and somehow have a need for paths larger than 107 bytes, you
could use the proc filesystem to bypass the limitation: could use the proc filesystem to bypass the limitation:
.nf
int dirfd = open(long_directory_path_to_socket, O_DIRECTORY | O_RDONLY); int dirfd = open(long_directory_path_to_socket, O_DIRECTORY | O_RDONLY);
char path[108]; char path[108];
snprintf(path, sizeof(path), "/proc/self/fd/%d/nginx.sock", dirfd); snprintf(path, sizeof(path), "/proc/self/fd/%d/nginx.sock", dirfd);
curl_easy_setopt(curl_handle, CURLOPT_UNIX_SOCKET_PATH, path); curl_easy_setopt(curl_handle, CURLOPT_UNIX_SOCKET_PATH, path);
/* Be sure to keep dirfd valid until you discard the handle */ /* Be sure to keep dirfd valid until you discard the handle */
.fi
.SH AVAILABILITY .SH AVAILABILITY
Since 7.40.0. Since 7.40.0.
.SH RETURN VALUE .SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR CURLOPT_OPENSOCKETFUNCTION "(3) .BR CURLOPT_OPENSOCKETFUNCTION "(3), " unix "(7), "
,
.BR unix "(7)