Как запустить emacs с пользовательским каталогом user-emacs

Я работаю над нестандартной и небольшой конфигурацией Emacs, которой я хочу поделиться с друзьями в качестве git-репозитория, чтобы они могли использовать его в качестве основы для своих будущих конфигураций.

Для этого мне нужен какой-то способ проверить мою конфигурацию, и самое простое решение, которое я могу найти, это что-то вроде:

$ emacs --eval "(setq user-emacs-directory \"~/Code/my_custom_emacs.d/\")"

Но я не могу заставить его работать.

Любая помощь высоко ценится.

Основной подход, который я использую для этого, состоит в том, чтобы изменить $HOME, запустив:

env HOME=/path/to/dir emacs

Затем вы используете /path/to/dir/.emacs.d

Вы также можете использовать символические ссылки любых важных файлов или каталогов в этом фальшивом домашнем каталоге на настоящие, чтобы Emacs мог их видеть.

Способ, которым я использую для поддержки нескольких .emacs.dкаталогов параллельно, заключается в следующем.

1. Emacs запускается так:

   alias emacs='emacs -q --load "/path/to/init.el"'
   

2. Каждый init.elфайл начинается так, чтобы правильно настроить user-init-fileи user-emacs-directoryпеременные:

   (setq user-init-file (or load-file-name (buffer-file-name)))
   (setq user-emacs-directory (file-name-directory user-init-file))
   

Я обнаружил, что это работает очень надежно в течение последних месяцев. Вот несколько замечаний:

• он ломается emacs-init-time, который сообщает только время, необходимое для загрузки конфигурации системы по умолчанию, но не ваш собственный файл инициализации. Если вы заинтересованы в тестировании времени инициализации, вам придется сделать это по-другому (см., Например, Как измерить производительность кода elisp? ).

• это не эквивалентно обычному запуску, и вам нужно позаботиться о нескольких конкретных моментах. В частности:

  • after-init-hookзапускается до загрузки файла инициализации.
  • *scratch*Буфер создается , прежде чем будет загружен файл инициализации. Вам придется явно изменить его режим (вместо использования initial-major-mode).
  • Вам нужно будет явно позвонить package-initialize; это не будет сделано автоматически

• путь к init.elможет быть выбран произвольно; в частности, каталог, в котором init.elнаходится, не должен быть назван .emacs.d. Я использую это , чтобы иметь, например , .emacs.d.23наряду .emacs.d.24с тем , чтобы иметь возможность переключаться между разными версиями Emacs (система , я использую на работе проходимо устарела, и я не могу установить Emacs 24 на все машины , которые я использую).

• этот рабочий процесс не требует изменения среды (и особенно HOMEenvvar), что может быть желательно, если вы запускаете программы из emacs, на которые может повлиять измененная среда).

Вы можете символическую ссылку ~/.emacs.d , это то, что я делаю

1. Старайтесь ~/.emacs.dориентировать мою конфигурацию emacs, т.е. все файлы конфигурации, связанные с emacs, должны находиться в этой папке

2. Затем у меня есть ~/.emacs_configsпапка, в которой находятся все папки конфигурации (в основном это папка с init.elи остальной конфигурацией), так что моя личная папка конфигурации будет ~/emacs_configs/iqbal, прелюдия будет в~/emacs_configs/prelude

3. Очень рано в моей личной конфигурации Emacs я установил user-emacs-directoryполный путь к моей конфигурации, используя следующую

   (setq user-emacs-directory (file-truename "~/.emacs.d/"))
   

4. Затем, наконец, я символическую ссылку ~/.emacs.dна конфигурацию, которую я действительно хочу использовать, например. использовать мою конфигурацию я сделаю ln -s ~/emacs_configs/iqbal .emacs.d. Если вы хотите попробовать какую-либо конфигурацию, просто скопируйте папку конфигурации ~/emacs_configs/whatever_nameи измените символическую ссылку

Преимущество третьего шага состоит в том, что emacs, запущенный с моей личной конфигурацией, может работать без изменений, даже если я изменю .emacs.dсимволическую ссылку, пока emacs работает.

Другое преимущество заключается в HOMEтом, что не изменяются внешние программы, с которыми может потребоваться взаимодействие emacs.

Конфигурация, которая не изменяется HOMEили работает с символическими ссылками, может быть найдена в моем ответе https://emacs.stackexchange.com/a/20508/934 . С помощью этой конфигурации вы можете изменить user-emacs-directory, установив переменную окружения:

EMACS_USER_DIRECTORY=~/.emacsenv.d/spacemacs emacs

и это даже работает с демоном.

Я нашел это аккуратное решение от EmacsWiki :

emacs -q -l ~/my-init-file.el

(не совсем с использованием пользовательского каталога, но работает хорошо, потому что, скорее всего, у вас все равно будет один входной файл)

Патч, который позволяет вам указать местоположение .emacs.d через переменную окружения `EMACS_USER_DIRECTORY ', доступен в https://debbugs.gnu.org/cgi/bugreport.cgi?bug=15539, но еще не объединен.

Установите вашу переменную перед загрузкой вашего файла инициализации:

emacs -q --eval '(setq alt-conf t)' --load ~/.emacs

Затем в вашем init-файле (в данном случае ~/.emacs):

(defvar alt-conf nil)

(if alt-conf
    (let ((default-directory "~/src/elisp-test/"))
      (normal-top-level-add-subdirs-to-load-path)
      (various-alt-config-stuff)
      (message "Alternate conf"))
  (message "Regular conf"))

Расширяя ответ от @phils, я сделал этот небольшой сценарий оболочки (называемый testrun.sh) для тестирования моей новой конфигурации emacs. Это может иметь смысл делать и в других случаях (например, при тестировании изменений в вашем init.el, которые могут нарушить работу emacs).

#!/bin/bash

cd $(dirname "${BASH_SOURCE[0]}")
[ -d .testrun ] || mkdir .testrun
cd .testrun
[ -h .emacs.d ] || ln -s .. .emacs.d

env HOME=`pwd` emacs

rm .emacs.d
cd ..
rm -rf .testrun

Вот небольшой скрипт, основанный на ответе и комментарии @ Phil'а об изменении HOMEпеременной окружения и его восстановлении в Emacs.

#!/bin/bash

# Use it like this:
#   /path/to/this/script  EMACS_USER_DIRECTORY  [OTHER EMACS ARGS]

# You can never be too careful
set -e

# First arg = emacs user directory
#   (get a canonical, absolute path)
EMACS_USER_DIRECTORY=$(readlink -f "$1")
shift
if [ ! -d "${EMACS_USER_DIRECTORY}" ]; then
    echo "Non-existent directory: '${EMACS_USER_DIRECTORY}'"
    exit 1
fi

# Bootstrap directory
BOOTSTRAP=$(mktemp --directory --tmpdir .emacs-bootstrap.XXXXXX)
mkdir "${BOOTSTRAP}/.emacs.d"

# Bootstrap init file
cat >"${BOOTSTRAP}/.emacs.d/init.el" <<EOF
  ;; # Correctly set-up emacs-user-directory
  (setq user-emacs-directory "${EMACS_USER_DIRECTORY}/")
  (setq user-init-file (concat user-emacs-directory "init.el"))

  ;; # Reset the HOME environment variable
  (setenv "HOME" "${HOME}")

  ;; # Load the real init file and clean-up afterwards
  (unwind-protect (load user-init-file)
    (delete-directory "${BOOTSTRAP}" :recursive))
EOF

# Forward remaining arguments to emacs
exec env HOME="${BOOTSTRAP}" emacs "$@"

Если в этом случае используется один каталог конфигурации emacs «.emacs.d» для всех пользователей компьютера с Linux, то это решение https://emacs.stackexchange.com/a/4258/5488 будет работать в большинстве случаев, но в некоторых случаи emacs пытается записать временные файлы в каталог user-emacs (например, файл .ido.last). В таких случаях, если общий каталог конфигурации имеет разрешение на запись для всех пользователей, он будет работать, но может оказаться нежелательным решением, поскольку каждый системный пользователь может не захотеть использовать один и тот же каталог для хранения временных файлов. В таком случае следующее решение будет лучшим вариантом.

Общий общий конфигурационный файл .emacs.d / init.el должен начинаться с

;; should come before calling package-initialize as it will populate
;; everything under common config "~/.emacs.d/elpa"
(setq user-init-file (or load-file-name (buffer-file-name)))
(setq package-user-dir (concat (file-name-directory user-init-file) "elpa"))

(package-initialize)

Сделайте, чтобы общий конфиг .emacs.d имел права на чтение для всех пользователей (не нужно иметь права на запись)

another_user $ emacs -q --load /path/to/shared/config/.emacs.d/init.el

У каждого пользователя будет свой собственный каталог «~ / .emacs.d /», но он используется только для сохранения временных файлов, но пакеты и другие конфигурации загружаются из общего каталога конфигурации.