summaryrefslogtreecommitdiff
path: root/lisp/server.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2021-11-11 13:12:50 +0200
committerEli Zaretskii <eliz@gnu.org>2021-11-11 13:12:50 +0200
commit997ca88ef44f5833f1a9a55fc3be863e7cc07a4b (patch)
treefd8d5cf02bf8d69a12d0313243a81a2bea3eddd6 /lisp/server.el
parent51e3625deceacb21186e8caa7c664d584f60f723 (diff)
downloademacs-997ca88ef44f5833f1a9a55fc3be863e7cc07a4b.tar.gz
; * lisp/server.el (server-stop-automatically): Doc fix.
Diffstat (limited to 'lisp/server.el')
-rw-r--r--lisp/server.el28
1 files changed, 15 insertions, 13 deletions
diff --git a/lisp/server.el b/lisp/server.el
index deaaf07da84..2f003a380a1 100644
--- a/lisp/server.el
+++ b/lisp/server.el
@@ -1791,24 +1791,26 @@ only these files will be asked to be saved."
;;;###autoload
(defun server-stop-automatically (arg)
- "Automatically stop server when possible.
+ "Automatically stop server as specified by ARG.
-When ARG is 'empty, the server is stopped when it has no remaining
-clients, no remaining unsaved file-visiting buffers, and no
-running processes with a query-on-exit flag.
+If ARG is the symbol `empty', stop the server when it has no
+remaining clients, no remaining unsaved file-visiting buffers,
+and no running processes with a `query-on-exit' flag.
-When ARG is 'delete-frame, the user is asked when the last frame is
-being closed whether each unsaved file-visiting buffer must be
-saved and each running process with a query-on-exit flag can be
-stopped, and if so, the server itself is stopped.
+If ARG is the symbol `delete-frame', ask the user when the last
+frame is deleted whether each unsaved file-visiting buffer must
+be saved and each running process with a `query-on-exit' flag
+can be stopped, and if so, stop the server itself.
-When ARG is 'kill-terminal, the user is asked when the last frame
-is being close with \\[save-buffers-kill-terminal] \
+If ARG is the symbol `kill-terminal', ask the user when the
+terminal is killed with \\[save-buffers-kill-terminal] \
whether each unsaved file-visiting
-buffer must be saved and each running process with a query-on-exit
-flag can be stopped, and if so, the server itself is stopped.
+buffer must be saved and each running process with a `query-on-exit'
+flag can be stopped, and if so, stop the server itself.
-This function is meant to be put in init files."
+Any other value of ARG will cause this function to signal an error.
+
+This function is meant to be called from the user init file."
(when (daemonp)
(setq server-stop-automatically arg)
(cond