Mac Developer Library Developer
Search

 

This manual page is for Mac OS X version 10.9

If you are running a different version of Mac OS X, view the documentation locally:

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • To learn how the manual is organized or to learn about command syntax, read the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Developer Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.



EMACSCLIENT(1)                                                                                EMACSCLIENT(1)



NAME
       emacsclient - tells a running Emacs to visit a file

SYNOPSIS
       emacsclient [options] files ...

DESCRIPTION
       This  manual  page documents briefly the emacsclient command.  Full documentation is available in the
       GNU Info format; see below.  This manual page was originally written for the Debian GNU/Linux distri-bution, distribution,
       bution, but is not specific to that system.

       emacsclient works in conjunction with the built-in Emacs server.

       You can either call emacsclient directly or let other programs run it for you when necessary.  On GNU
       and Unix systems many programs consult the environment variable EDITOR  (sometimes  also  VISUAL)  to
       obtain  the  command used for editing.  Thus, setting this environment variable to 'emacsclient' will
       allow these programs to use an already running Emacs for editing.  Other operating systems might have
       their own methods for defining the default editor.

       For  emacsclient  to  work,  you need an already running Emacs with a server.  Within Emacs, call the
       functions `server-start' or `server-mode'.  (Your `.emacs' file can do this automatically if you  add
       either `(server-start)' or `(server-mode 1)' 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.


OPTIONS
       The  programs  follow  the  usual GNU command line syntax, with long options starting with two dashes
       (`-').

       -n, --no-wait
              returns immediately without waiting for you to "finish" the buffer in Emacs.

       -e, --eval
              do not visit files but instead evaluate the arguments as Emacs Lisp expressions.

       -s, --socket-name=FILENAME
              use socket named FILENAME for communication.

       -f, --server-file=FILENAME
              use TCP configuration file FILENAME for communication.  This can also  be  specified  via  the
              `EMACS_SERVER_FILE' environment variable.

       -a, --alternate-editor=EDITOR
              if the Emacs server is not running, run the specified editor instead.  This can also be speci-fied specified
              fied via the `ALTERNATE_EDITOR' environment variable.

       -d, --display=DISPLAY
              tell the server to display the files on the given display.

       -V, --version
              print version information and exit

       -h, --help
              print this usage information message and exit

SEE ALSO
       The program is documented fully in Using Emacs as a Server available via the Info system.

AUTHOR
       This manual page was written by Stephane Bortzmeyer <bortzmeyer@debian.org>, for the Debian GNU/Linux
       system (but may be used by others).

COPYING
       This manual page is in the public domain.




                                                                                              EMACSCLIENT(1)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.

Feedback