summaryrefslogtreecommitdiff
path: root/doc/man/emacsclient.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/emacsclient.1')
-rw-r--r--doc/man/emacsclient.147
1 files changed, 29 insertions, 18 deletions
diff --git a/doc/man/emacsclient.1 b/doc/man/emacsclient.1
index daaacab7f3e..83c8a366f8b 100644
--- a/doc/man/emacsclient.1
+++ b/doc/man/emacsclient.1
@@ -1,7 +1,7 @@
.\" See section COPYING for conditions for redistribution.
-.TH EMACSCLIENT 1
+.TH EMACSCLIENT 1 "2022-09-05" "GNU Emacs" "GNU"
.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
-.\" other parms are allowed: see man(7), man(1)
+.\" other params are allowed: see man(7), man(1)
.SH NAME
emacsclient \- tells a running Emacs to visit a file
.SH SYNOPSIS
@@ -12,8 +12,6 @@ This manual page documents briefly the
.BR emacsclient
command. Full documentation is available in the GNU Info format; see
below.
-This manual page was originally written for the Debian GNU/Linux
-distribution, but is not specific to that system.
.PP
.B emacsclient
works in conjunction with the built-in Emacs server.
@@ -63,43 +61,51 @@ is treated as column 1.
This option applies only to the next file specified.
.TP
.B \-a, \-\-alternate-editor=COMMAND
-if the Emacs server is not running, run the specified shell command instead.
+If the Emacs server is not running, run the specified shell command instead.
This can also be specified via the ALTERNATE_EDITOR environment variable.
If the value of ALTERNATE_EDITOR is the empty string, run "emacs \-\-daemon" to
start Emacs in daemon mode, and try to connect to it.
.TP
.B -c, \-\-create-frame
-create a new frame instead of trying to use the current Emacs frame
+Create a new frame instead of trying to use the current Emacs frame.
+.TP
+.B -r \-\-reuse-frame
+Reuse an existing frame if one exists, otherwise create a new frame.
.TP
.B \-F, \-\-frame-parameters=ALIST
-set the parameters of a newly-created frame.
+Set the parameters of a newly-created frame.
.TP
.B \-d, \-\-display=DISPLAY
-tell the server to display the files on the given display.
+Tell the server to display the files on the given display.
.TP
.B \-e, \-\-eval
-do not visit files but instead evaluate the arguments as Emacs
+Do not visit files but instead evaluate the arguments as Emacs
Lisp expressions.
.TP
.B \-f, \-\-server-file=FILENAME
-use TCP configuration file FILENAME for communication.
+Use TCP configuration file FILENAME for communication.
This can also be specified via the EMACS_SERVER_FILE environment variable.
.TP
.B \-n, \-\-no-wait
-returns
-immediately without waiting for you to "finish" the buffer in Emacs.
+Return immediately without waiting for you to "finish" the buffer in
+Emacs. If combined with --eval, this option is ignored.
+.TP
+.B \-w, \-\-timeout=N
+How long to wait, in seconds, for Emacs to respond before giving up.
+The default is 0, which means to wait forever.
.TP
.B \-nw, \-t, \-\-tty
-open a new Emacs frame on the current terminal
+Open a new Emacs frame on the current terminal.
.TP
.B \-s, \-\-socket-name=FILENAME
-use socket named FILENAME for communication.
+Use socket named FILENAME for communication.
+This can also be specified via the EMACS_SOCKET_NAME environment variable.
.TP
.B \-V, \-\-version
-print version information and exit
+Print version information and exit.
.TP
.B \-H, \-\-help
-print this usage information message and exit
+Print this usage information message and exit.
.SH "EXIT STATUS"
Normally, the exit status is 0. If emacsclient shuts down due to
Emacs signaling an error, the exit status is 1.
@@ -108,7 +114,12 @@ The program is documented fully in
.IR "Using Emacs as a Server"
available via the Info system.
.SH AUTHOR
-This manual page was written by Stephane Bortzmeyer <bortzmeyer@debian.org>,
-for the Debian GNU/Linux system (but may be used by others).
+This manual page was originally written by Stephane Bortzmeyer
+<bortzmeyer@debian.org>, for the Debian GNU/Linux system, but is not
+specific to that system.
.SH COPYING
This manual page is in the public domain.
+
+.\" Local Variables:
+.\" time-stamp-pattern: "3/.TH EMACSCLIENT 1 \"%Y-%02m-%02d\" \"GNU Emacs\" \"GNU\"$"
+.\" End: