summaryrefslogtreecommitdiff
path: root/lisp/server.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2019-01-04 15:55:59 +0200
committerEli Zaretskii <eliz@gnu.org>2019-01-04 15:55:59 +0200
commitf6eacc468b8539be482260fa569e7b5ece07f4a2 (patch)
treeb15f8099a23bacfcf562c23d1fef5011ef0bea35 /lisp/server.el
parentfe4922cbf01fa9161ffa142fc70972098d48186f (diff)
downloademacs-f6eacc468b8539be482260fa569e7b5ece07f4a2.tar.gz
emacs-f6eacc468b8539be482260fa569e7b5ece07f4a2.tar.bz2
emacs-f6eacc468b8539be482260fa569e7b5ece07f4a2.zip
Improve documentation of 'server-name'
* doc/emacs/misc.texi (Emacs Server, TCP Emacs server) (emacsclient Options): * lisp/server.el (server-name): Document the usage of 'server-name' to specify the server file as an absolute file name. (Bug#33934)
Diffstat (limited to 'lisp/server.el')
-rw-r--r--lisp/server.el9
1 files changed, 8 insertions, 1 deletions
diff --git a/lisp/server.el b/lisp/server.el
index 9020b09c5de..a5d5e561db5 100644
--- a/lisp/server.el
+++ b/lisp/server.el
@@ -270,7 +270,14 @@ been consumed.")
"server")
"The name of the Emacs server, if this Emacs process creates one.
The command `server-start' makes use of this. It should not be
-changed while a server is running."
+changed while a server is running.
+If this is a file name with no leading directories, Emacs will
+create a socket file by that name under `server-socket-dir'
+if `server-use-tcp' is nil, else under `server-auth-dir'.
+If this is an absolute file name, it specifies where the socket
+file will be created. To have emacsclient connect to the same
+socket, use the \"-s\" switch for local non-TCP sockets, and
+the \"-f\" switch otherwise."
:group 'server
:type 'string
:version "23.1")