Difference between revisions of "Emacs server"
m (Add information about --daemon) |
(Add info about --daemon behavior. Organize into sections.) |
||
| Line 1: | Line 1: | ||
Emacs includes an optional client-server architecture. | Emacs includes an optional client-server architecture. | ||
| − | To start | + | == Starting the Server == |
| + | === With <code>server-start</code> === | ||
| + | To start a server in an existing Emacs session, run <code>server-start</code>. A server started in this manner will close when the last visible Emacs frame closes. If you want Emacs to automatically run a server on startup, it makes sense to add <code>server-start</code> to your configuration file somewhere. | ||
| + | === With <tt>--daemon</tt> === | ||
| + | Emacs 24 or higher provides the <tt>--daemon</tt> command-line argument, which will cause Emacs to immediately start a server and fork into the background. A server started in this manner is fully daemonized and will remain running even with no visible Emacs frames and after its parent terminal has closed (for example, after an SSH session has disconnected). | ||
| − | Once | + | Note that, if using <tt>--daemon</tt>, your configuration file will be run while Emacs is still in a terminal. This may affect your theming if you use usually graphical Emacs. |
| + | |||
| + | == Using Clients == | ||
| + | |||
| + | Once the server is started you may use the <code>emacsclient</code> command outside of Emacs to send a file to Emacs for editing, e.g. <code>emacsclient ~/.emacs.d/init.el</code> to modify your init file. On a GNU/Linux system it might be a good idea to set your <tt>EDITOR</tt> environment variable to <tt>emacsclient</tt> or <tt>emacsclient -t</tt>. Using <tt>emacsclient</tt> without any arguments will cause the calling process to simply pause and wait for the Emacs server to report that it's done editing. Using <tt>emacsclient -t</tt> will cause the calling process to put up a text-mode frame in the same terminal. | ||
| + | |||
| + | If the server was started using <tt>--daemon</tt>, you should run <tt>emacsclient -t</tt> or <tt>emacsclient -nc</tt> to create a visible frame to interact with. | ||
| + | |||
| + | == Finishing Up == | ||
Once you have finished with a buffer that was opened via <tt>emacsclient</tt> you should use the <code>C-x #</code> (<code>server-edit</code>) to properly close the loop. Killing the buffer normally will not send the signal to <tt>emacsclient</tt> that Emacs has finished with the file. | Once you have finished with a buffer that was opened via <tt>emacsclient</tt> you should use the <code>C-x #</code> (<code>server-edit</code>) to properly close the loop. Killing the buffer normally will not send the signal to <tt>emacsclient</tt> that Emacs has finished with the file. | ||
| + | |||
| + | If you're in an Emacs session that was started using <tt>--daemon</tt>, <code>C-x C-c</code> will only close the frame that it was invoked in. It will also signal to the client that owns the frame that its editing job is done, so <tt>emacsclient -c</tt> or <tt>emacsclient -t</tt> as <tt>EDITOR</tt> will behave much like a full <tt>emacs</tt> or <tt>emacs -nw</tt>. | ||
| + | |||
| + | To close a server started with <tt>--daemon</tt> entirely, run <code>save-buffers-kill-emacs</tt> in a frame. | ||
Revision as of 06:16, 27 March 2012
Emacs includes an optional client-server architecture.
Starting the Server
With server-start
To start a server in an existing Emacs session, run server-start. A server started in this manner will close when the last visible Emacs frame closes. If you want Emacs to automatically run a server on startup, it makes sense to add server-start to your configuration file somewhere.
With --daemon
Emacs 24 or higher provides the --daemon command-line argument, which will cause Emacs to immediately start a server and fork into the background. A server started in this manner is fully daemonized and will remain running even with no visible Emacs frames and after its parent terminal has closed (for example, after an SSH session has disconnected).
Note that, if using --daemon, your configuration file will be run while Emacs is still in a terminal. This may affect your theming if you use usually graphical Emacs.
Using Clients
Once the server is started you may use the emacsclient command outside of Emacs to send a file to Emacs for editing, e.g. emacsclient ~/.emacs.d/init.el to modify your init file. On a GNU/Linux system it might be a good idea to set your EDITOR environment variable to emacsclient or emacsclient -t. Using emacsclient without any arguments will cause the calling process to simply pause and wait for the Emacs server to report that it's done editing. Using emacsclient -t will cause the calling process to put up a text-mode frame in the same terminal.
If the server was started using --daemon, you should run emacsclient -t or emacsclient -nc to create a visible frame to interact with.
Finishing Up
Once you have finished with a buffer that was opened via emacsclient you should use the C-x # (server-edit) to properly close the loop. Killing the buffer normally will not send the signal to emacsclient that Emacs has finished with the file.
If you're in an Emacs session that was started using --daemon, C-x C-c will only close the frame that it was invoked in. It will also signal to the client that owns the frame that its editing job is done, so emacsclient -c or emacsclient -t as EDITOR will behave much like a full emacs or emacs -nw.
To close a server started with --daemon entirely, run save-buffers-kill-emacs in a frame.