From 12e5b25e621cc77da2027b9c6f3d3cfb32695c34 Mon Sep 17 00:00:00 2001 From: Hackerpilot Date: Fri, 15 Jan 2016 00:49:39 -0800 Subject: [PATCH] Documentation for #217 --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 32af8ac..8eb59aa 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,23 @@ the issue.) 1. ```dub build --build=release --config=server``` +# Sockets +## TCP +On Windows DCD will use TCP sockets to communicate between the client and server. +Other operating systems can use TCP sockets if the client and server use the `--tcp` +command-line switch. + +## UNIX domain sockets +Operating systems that support UNIX domain sockets will use them by default. + +#### OSX +The socket will be created at `/var/tmp/dcd-${UID}.socket` + +#### Linux/BSD +The client and server will attempt to create the socket in the following locations: +* `${XDG_RUNTIME_DIR}/dcd.socket` +* `/tmp/dcd-${UID}.socket` + # Client Because DCD is designed to be used from a text editor, this section is written primarily for plugin authors.