emacsclient − tells a running Emacs to visit a file
emacsclient [options] files ...
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 distribution, 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.
The programs
follow the usual GNU command line syntax, with long options
starting with two dashes (‘-’).
−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. If the value of EDITOR is the empty string, run ‘emacs --daemon’ to start Emacs in daemon mode, and try to connect to it.
-c, −−create-frame
create a new frame instead of trying to use the current Emacs frame
−F, −−frame-parameters=ALIST
set the parameters of a newly-created frame.
−d, −−display=DISPLAY
tell the server to display the files on the given display.
−e, −−eval
do not visit files but instead evaluate the arguments as Emacs Lisp expressions.
−f, −−server-file=FILENAME
use TCP configuration file FILENAME for communication. This can also be specified via the ‘EMACS_SERVER_FILE’ environment variable.
−n, −−no-wait
returns immediately without waiting for you to "finish" the buffer in Emacs.
−nw, −t, −−tty
open a new Emacs frame on the current terminal
−s, −−socket-name=FILENAME
use socket named FILENAME for communication.
−V, −−version
print version information and exit
−H, −−help
print this usage information message and exit
Normally, the exit status is 0. If emacsclient shuts down due to Emacs signaling an error, the exit status is 1.
The program is documented fully in Using Emacs as a Server available via the Info system.
This manual page was written by Stephane Bortzmeyer <[email protected]>, for the Debian GNU/Linux system (but may be used by others).
This manual page is in the public domain.
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.