| 1 |
.TH EMACSCLIENT 1 |
|---|
| 2 |
.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection |
|---|
| 3 |
.\" other parms are allowed: see man(7), man(1) |
|---|
| 4 |
.SH NAME |
|---|
| 5 |
emacsclient \- tells a running Emacs to visit a file |
|---|
| 6 |
.SH SYNOPSIS |
|---|
| 7 |
.B emacsclient |
|---|
| 8 |
.I "[options] files ..." |
|---|
| 9 |
.SH "DESCRIPTION" |
|---|
| 10 |
This manual page documents briefly the |
|---|
| 11 |
.BR emacsclient |
|---|
| 12 |
command. Full documentation is available in the GNU Info format; see |
|---|
| 13 |
below. |
|---|
| 14 |
This manual page was originally written for the Debian GNU/Linux |
|---|
| 15 |
distribution, but is not specific to that system. |
|---|
| 16 |
.PP |
|---|
| 17 |
.B emacsclient |
|---|
| 18 |
works in conjunction with the built-in Emacs server. |
|---|
| 19 |
.PP |
|---|
| 20 |
You can either call |
|---|
| 21 |
.B emacsclient |
|---|
| 22 |
directly or let other programs run it for you when necessary. On |
|---|
| 23 |
GNU and Unix systems many programs consult the environment |
|---|
| 24 |
variable EDITOR (sometimes also VISUAL) to obtain the command used for |
|---|
| 25 |
editing. Thus, setting this environment variable to 'emacsclient' |
|---|
| 26 |
will allow these programs to use an already running Emacs for editing. |
|---|
| 27 |
Other operating systems might have their own methods for defining the |
|---|
| 28 |
default editor. |
|---|
| 29 |
|
|---|
| 30 |
For |
|---|
| 31 |
.B emacsclient |
|---|
| 32 |
to work, you need an already running Emacs with a server. Within Emacs, call |
|---|
| 33 |
the function |
|---|
| 34 |
`server-start'. (Your `.emacs' file can do this automatically if you |
|---|
| 35 |
add the expression `(server-start)' to it.) |
|---|
| 36 |
|
|---|
| 37 |
When you've finished editing the buffer, type `C-x #' |
|---|
| 38 |
(`server-edit'). This saves the file and sends a message back to the |
|---|
| 39 |
`emacsclient' program telling it to exit. The programs that use |
|---|
| 40 |
`EDITOR' wait for the "editor" (actually, `emacsclient') to exit. `C-x |
|---|
| 41 |
#' also checks for other pending external requests to edit various |
|---|
| 42 |
files, and selects the next such file. |
|---|
| 43 |
|
|---|
| 44 |
If you set the variable `server-window' to a window or a frame, `C-x |
|---|
| 45 |
#' displays the server buffer in that window or in that frame. |
|---|
| 46 |
|
|---|
| 47 |
.SH OPTIONS |
|---|
| 48 |
The programs follow the usual GNU command line syntax, with long |
|---|
| 49 |
options starting with two dashes (`-'). |
|---|
| 50 |
.TP |
|---|
| 51 |
.B \-n, \-\-no-wait |
|---|
| 52 |
returns |
|---|
| 53 |
immediately without waiting for you to "finish" the buffer in Emacs. |
|---|
| 54 |
.TP |
|---|
| 55 |
.B \-e, \-\-eval |
|---|
| 56 |
do not visit files but instead evaluate the arguments as Emacs |
|---|
| 57 |
Lisp expressions. |
|---|
| 58 |
.TP |
|---|
| 59 |
.B \-s, \-\-socket-name=FILENAME |
|---|
| 60 |
Use socket named FILENAME for communication. |
|---|
| 61 |
.TP |
|---|
| 62 |
.B \-a, \-\-alternate-editor=EDITOR |
|---|
| 63 |
if the Emacs server is not running, run the specified editor instead. |
|---|
| 64 |
This can also be specified via the `ALTERNATE_EDITOR' environment variable. |
|---|
| 65 |
.TP |
|---|
| 66 |
.B \-d, \-\-display=DISPLAY |
|---|
| 67 |
tell the server to display the files on the given display. |
|---|
| 68 |
.TP |
|---|
| 69 |
.B \-V, \-\-version |
|---|
| 70 |
print version information and exit |
|---|
| 71 |
.TP |
|---|
| 72 |
.B \-h, \-\-help |
|---|
| 73 |
print this usage information message and exit |
|---|
| 74 |
.SH "SEE ALSO" |
|---|
| 75 |
The program is documented fully in |
|---|
| 76 |
.IR "Using Emacs as a Server" |
|---|
| 77 |
available via the Info system. |
|---|
| 78 |
.SH AUTHOR |
|---|
| 79 |
This manual page was written by Stephane Bortzmeyer <bortzmeyer@debian.org>, |
|---|
| 80 |
for the Debian GNU/Linux system (but may be used by others). |
|---|
| 81 |
.SH COPYING |
|---|
| 82 |
This manual page is in the public domain. |
|---|
| 83 |
|
|---|
| 84 |
.\" arch-tag: 2b35e723-b197-4073-8752-231bc8b3d3f3 |
|---|
