It’s been quite a while since we built Emacs from source on the Mac, but 25.1 has been official release, not to mention macOS (really?) Sierra to muddy the waters, so let’s take it for another spin. As usual, you need Xcode (free in the Mac App Store) to build. Here are some tips and tricks on setting up Emacs.app on Mac OS X. These are based on my personal experience of using Emacs.app for the past 10 years or so; there may be better ways, but these work for me. Running Emacs.app from the command line. Call this script 'emacs' and put it somewhere in your PATH (/bin or /usr/local/bin): Using emacsclient.
I wanted a nice experience using Emacs for Mac OS X. By 'nice' Imean:
OS X Control and Command keys. Mac keyboards conveniently have separate Control, Meta (a.k.a. Option or Alt) and Command (⌘) keys. You have the traditional Emacs bindings on Control and Meta, and the OS X bindings on Command. As recommended previously, you should strongly consider re-binding Caps Lock to Control, system-wide. Create an app via Automator to open files in Emacs clients by double-clicks. Automator is a built-in OS X app for creating custom automated user workflows for just about any installed app you might have or even OS functionality. Suppose we could like to open files by default in the Emacs client named as main.You may open files in the Emacs.app, however, with too much user-defined.
- Emacs runs in server mode. It's started like other OS X software by Launch Services.
- I can connect to it with graphical or terminal-based clients easily.
- Graphical clients use Cocoa and not X11.
- There's an icon on my dock to pop up a new graphical frame.
- There's a shell command I can type to open a new graphical frame.
- There's something I can type into Spotlight to open a new graphical frame.
- If the server is dead for some reason, there's a way to start it in a small number of clicks.
- If the server is dead for some reason, as many as the above features as possible still work.
- It's easy, but not the default, to start standalone (non-client) Emacs instances as well.
You too can bring several hours and three separate scripting tools tobear on this, or follow the simple (hah hah) instructions below.
First, install Emacs For Mac OS X. The Emacs that comes with OS X isold and crusty, and the one at that site is new and Cocoa-ready andRetina-enabled and so on. Put it in
/Applications
- if you put itsomewhere else, you'll need to correct all the other scripts I'mmentioning in this post.Emacs Server at Login
Open up the AppleScript Editor. If you're an Emacs user this probablylooks awful and confusing to you. Paste the following into it:
Press ⌘K to compile it, then ⌘S and save it in
/Applications/Development
. (This subfolder keeps your Applicationsmenu clean, and has an important effect on sort order later.) To giveit a nice icon, select the original Emacs.app
; press ⌘I; click theicon in the top-left; press ⌘C; select on your new Emacs Server.app
bundle; press ⌘I; click the icon in the top-left; press ⌘V.Open up System Preferences > Users & Groups > Login Items and nowyou can press the
+
button and choose Emacs Server.The server is invisible until you first connect a client to it. Thenit will appear in the dock, as the regular
Emacs.app
.New Frame Dock Icon
To make a dock icon that opens up a new Emacs frame - a client if theserver is available, a standalone instance otherwise - create thefollowing script in the AppleScript Editor and save it as anApplication named Emacs Client. in
/Applications/Development
.Then drag this from the Applications folder to your dock. This willalso make it so typing
emacs
into Spotlight selects this as thefirst item ('Development' sorts before 'Emacs', 'Client' sorts before'Server').If connected to the server, this opens up a new client frame eachclick, by design. To just raise existing frames, click the otherEmacs icon on the dock, representing the running application.
Server-aware Shell Scripts
I put these in
~/local/bin
. You'll need to add that to your $PATH
if you haven't already. First, two simple ones. These will start newinstances, not clients, but they're necessary to properly handle shellarguments for fallbacks for clients. They're also nice to have if youactually want to start a new instance.Start a new Cocoa instance -
emacsc
:Start a new terminal instance -
emacst
:Now for something ma little ore complicated -
ec
, start a Cocoaclient or fall back to a new instance (via the above emacsc
) if theserver is unavailable.Similarly,
et
, for a terminal client or new terminal instance.Why are
ec
and et
scripts instead of aliases? Many tools will failif $EDITOR
does not resolve to an actual executable somewhere in$PATH
because they invoke the tool directly instead of invoking ashell to run it.Finally: Some aliases for
~/.bash_profile
, to override the ancientversion of Emacs that Mac OS X comes with by default.Mac Terminal Emacs
Activate Emacs on New Frames
Emacs For Mac Os X
If you start
emacsc
or ec
from Terminal, Mac OS X doesn't realizeyou probably want to switch focus to the Emacs session automatically.There are also plenty of other ways you might start Emacs besidestyping a command into Terminal, and you probably want the new framesfocused then as well.To do this, we can take advantage of the
ns
features in Emacs Lispand the frame-creation hooks. Add the following to your ~/.emacs
orsome file it loads:Now anything that opens or selects a frame will also activate Emacsfor Finder. The
featurep
check means this is harmless to load onnon-OS X platforms, and ns-raise-emacs
is not (interactive)
forreasons that will be self-evident if you think about them.Emacs Os
Remaining Issues
Launch Services is happy to start the Emacs Server instance but losestrack of it afterwards. This is mostly harmless but annoying.
The second Emacs icon on the dock (the one for the main
Emacs.app
rather than your custom Emacs Client.app
) behaves oddly when noframes are visible. Its menu bar and context menu don't work, and youcan't start a new frame from it directly. This is likely an issuebecause both Emacs and Finder assume any graphical application has atleast one main window / frame, even if it might not be visible.Mac Os Emacs
Emacs Mac Port
(Thanks to Dan Gerrity for pointing out a typo in the original posted
emacst
script, and Sean B. Palmer for Emacs Lisp improvements thatled to much simpler shell scripts.)