mirror of
https://github.com/jimeh/emacs-builds.git
synced 2026-02-19 06:06:41 +00:00
docs(readme): update CLI usage section
This commit is contained in:
31
README.md
31
README.md
@@ -90,29 +90,26 @@ Builds will soon be signed and notarized, progress is tracked in [Issue #1][1].
|
||||
|
||||
## Use Emacs.app as `emacs` CLI Tool
|
||||
|
||||
As the application bundle is self-contained, the main executable needs to be run
|
||||
from within the application bundle. This means a simple symlink to
|
||||
`Emacs.app/Contents/MacOS/Emacs` will not work. Instead the best approach is to
|
||||
create a shell alias called `emacs` pointing to the right place.
|
||||
Builds come with a custom `emacs` shell script launcher for use from the command
|
||||
line, located next to `emacsclient` in `Emacs.app/Contents/MacOS/bin`.
|
||||
|
||||
For example, this will expose both `emacs` and `emacsclient`:
|
||||
The custom `emacs` script makes sure to use the main
|
||||
`Emacs.app/Contents/MacOS/Emacs` executable from the correct path, ensuring it
|
||||
finds all the relevant dependencies within the Emacs.app bundle, regardless of
|
||||
it it's exposed via `PATH` or symlinked to from elsewhere.
|
||||
|
||||
To use it, simply add `Emacs.app/Contents/MacOS/bin` to your `PATH`. For
|
||||
example, if you place Emacs.app in `/Applications`:
|
||||
|
||||
```bash
|
||||
if [ -f "/Applications/Emacs.app/Contents/MacOS/Emacs" ]; then
|
||||
export EMACS="/Applications/Emacs.app/Contents/MacOS/Emacs"
|
||||
alias emacs="$EMACS -nw"
|
||||
fi
|
||||
|
||||
if [ -f "/Applications/Emacs.app/Contents/MacOS/bin/emacsclient" ]; then
|
||||
alias emacsclient="/Applications/Emacs.app/Contents/MacOS/bin/emacsclient"
|
||||
if [ -d "/Applications/Emacs.app/Contents/MacOS/bin" ]; then
|
||||
export PATH="/Applications/Emacs.app/Contents/MacOS/bin:$PATH"
|
||||
alias emacs="emacs -nw" # Always launch "emacs" in terminal mode.
|
||||
fi
|
||||
```
|
||||
|
||||
Setting the `EMACS` variable to the binary path seems to be a good idea, as some
|
||||
tools seem to use it to figure out the path to Emacs' executable, including
|
||||
[doom-emacs][]' `doom` CLI tool.
|
||||
|
||||
[doom-emacs]: https://github.com/hlissner/doom-emacs
|
||||
If you want `emacs` in your terminal to launch a GUI instance of Emacs, don't
|
||||
use the alias from the above example.
|
||||
|
||||
## Build Process
|
||||
|
||||
|
||||
Reference in New Issue
Block a user