diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2019-01-04 15:40:43 +0200 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2019-01-04 15:40:43 +0200 |
| commit | 775517307d9d5bb32cf6d58ae652e1e819aa95c3 (patch) | |
| tree | 7c9b44f91c66cb6b005a439849ec138620c9bb5b /lisp/server.el | |
| parent | 5f2aa328d158816aa4c40b1a6e603c6da9aff7b0 (diff) | |
| download | emacs-775517307d9d5bb32cf6d58ae652e1e819aa95c3.tar.gz | |
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. Do not merge to master. (Bug#33934)
Diffstat (limited to 'lisp/server.el')
| -rw-r--r-- | lisp/server.el | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/lisp/server.el b/lisp/server.el index 599f2728b99..a39b1cb46d4 100644 --- a/lisp/server.el +++ b/lisp/server.el @@ -255,7 +255,14 @@ are done with it in the server.") (defcustom server-name "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") |