view etc/emacsclient.1 @ 89954:97905c4f1a42

Revision: [e-mail]--gnu-2004/emacs--unicode--0--patch-24 Merge from [e-mail]--2004/emacs--hacks--0, emacs--cvs-trunk--0 Patches applied: * [e-mail]--2004/emacs--hacks--0--patch-2 Prevent special events from appending dashes to the echo string. * [e-mail]--2004/emacs--hacks--0--patch-4 Added ChangeLog entry. * [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-451 Update from CVS: lisp/subr.el (get-buffer-window-list): Doc fix. * [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-452 - [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-454 Update from CVS * [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-455 Bash the dashes * [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-456 - [e-mail]--gnu-2004/emacs--cvs-trunk--0--patch-458 Update from CVS

.TH EMACSCLIENT 1
.\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
.\" other parms are allowed: see man(7), man(1)
.SH NAME
emacsclient \- tells a running Emacs to visit a file
.SH SYNOPSIS
.B emacsclient
.I "[options] files ..."
.SH "DESCRIPTION"
This manual page documents briefly the
.BR emacsclient
command.
This manual page was written for the Debian GNU/Linux distribution
because the original program does not have a manual page.
Instead, it has documentation in the GNU Info format; see below.
.PP
.B emacsclient 
works in conjunction with the built-in server of Emacs.
.PP
You typically do not call 
.B emacsclient
directly.  Instead, you set the environment variable EDITOR
to 
.B emacsclient
and let programs like 'vipw' or 'bug' or anything run
it for you, which will use an existing Emacs to visit the file.

For
.B emacsclient 
to work, you need an already running Emacs with a server.  Within Emacs, call 
the function
`server-start'.  (Your `.emacs' file can do this automatically if you
add the expression `(server-start)' to it.)  

When you've finished editing the buffer, type `C-x #'
(`server-edit').  This saves the file and sends a message back to the
`emacsclient' program telling it to exit.  The programs that use
`EDITOR' wait for the "editor" (actually, `emacsclient') to exit.  `C-x
#' also checks for other pending external requests to edit various
files, and selects the next such file.

If you set the variable `server-window' to a window or a frame, `C-x
#' displays the server buffer in that window or in that frame.

.SH OPTIONS
The programs follow the usual GNU command line syntax, with long
options starting with two dashes (`-').
.TP
.B \-n, \-\-no-wait
returns
immediately without waiting for you to "finish" the buffer in Emacs.
.TP
.B \-e, \-\-eval
do not visit files but instead evaluate the arguments as Emacs
Lisp expressions.
.TP
.B \-a, \-\-alternate-editor=EDITOR
if the Emacs server is not running, run the specified editor instead.
This can also be specified via the `ALTERNATE_EDITOR' environment variable.
.TP
.B \-d, \-\-display=DISPLAY
tell the server to display the files on the given display.
.SH "SEE ALSO"
The program is documented fully in
.IR "Using Emacs as a Server"
available via the Info system.
.SH BUGS
If there is no running Emacs server, 
.B emacsclient 
cannot launch one. I use a small Perl script instead of raw 
.B emacsclient
to do it (it works only with systems which have BSD sockets, which is fine
for Debian GNU/Linux).
.SH AUTHOR
This manual page was written by Stephane Bortzmeyer <[e-mail]>,
for the Debian GNU/Linux system (but may be used by others).
.SH COPYING
This manual page is in the public domain.

.\" arch-tag: 2b35e723-b197-4073-8752-231bc8b3d3f3