Skip to content

Latest commit

 

History

History
183 lines (136 loc) · 5.09 KB

INSTALLATION.org

File metadata and controls

183 lines (136 loc) · 5.09 KB
Raw

Emacs Rime 基本安装与使用方法

依赖

  • Emacs 26.1+ ，且需启用动态支持模块。
  • emacs-rime 会自动构建所需的动态模块，这需要 make 和 gcc 可用。

如何获得支持动态模块的 Emacs ？

切换折叠

Linux

Linux 各主要发行版自带 emacs 默认已启用动态模块支持。

MacOS

emacs-plus 默认启用 --with-modules 选项，使用 homebrew 安装命令如下：
brew tap d12frosted/emacs-plus
brew install emacs-plus
emacs-mac 安装时需要启用 --with-modules 选项，使用 homebrew 安装命令如下 :
brew tap railwaycat/emacsmacport
brew install emacs-mac --with-modules

手工编译

使用 --with-modules 选项.

安装 librime

Linux

ArchLinux/Manjaro

sudo pacman -S librime

Debian/Ubuntu

sudo apt install librime-dev

请注意 librime-dev 的版本，如果在1.5.3以下，则需要自行编译。

sudo apt install git build-essential cmake libboost-all-dev libgoogle-glog-dev libleveldb-dev libmarisa-dev libopencc-dev libyaml-cpp-dev libgtest-dev
git clone https://github.com/rime/librime.git ~/.emacs.d/librime
cd ~/.emacs.d/librime
make
sudo make install

Fedora

sudo dnf install librime-devel emacs-devel

openSUSE

sudo zypper install librime-devel emacs-el

MacOS

  1. 先安装鼠须管，里面有输入法方案。
  2. 然后直接下载编译好的librime的Release版本。
  3. 如果后续安装了鼠须管的升级版本，请查阅它的更新日志，将librime也升级到相匹配的版本。
curl -L -O https://github.com/rime/librime/releases/download/1.7.1/rime-1.7.1-osx.zip
unzip rime-1.7.1-osx.zip -d ~/.emacs.d/librime
rm -rf rime-1.7.1-osx.zip

如果MacOS Gatekeeper阻止第三方软件运行，可以暂时关闭它：

sudo spctl --master-disable
# later: sudo spctl --master-enable

Windows

使用 scoop

可以使用 scoop 来安装自动构建所需的依赖。

scoop install gcc
scoop bucket add wsw0108 https://github.com/wsw0108/scoop-bucket.git
scoop install librime

使用 msys2

使用 msys2 构建所需的依赖。

pacman -S pactoys base-devel
pacboy -S librime:x librime-data:x emacs:x toolchain:x
ln -s /mingw64/share/opencc/* /mingw64/share/rime-data/opencc # Fix the Simplified Chinese input

在 mingw64 环境中启动 emacs 来获取正确的 SHELL 环境变量，用来在 Emacs 内构建 librime-emacs 以及 MSYSTEM_PREFIX 环境变量来设置 rime-share-data-dir 变量。

编译时无法找到 rime_api.h ？

切换折叠

必须设置 rime-librime-root 参照安装方法中的说明。

编译时无法找到 emacs-module.h ？

切换折叠

如果自己编译 Emacs 且没有安装到标准目录（/usr/, /usr/local/）， 必须 指定 rime-emacs-module-header-root 。

在 :custom 中加入如下内容.

(假设将 Emacs 安装到了 ~/emacs)

(rime-emacs-module-header-root "~/emacs/include")

最小配置

Emacs Rime 已发布到 Melpa 。

(use-package rime
  :custom
  (default-input-method "rime"))

使用 Straight

切换折叠 
(use-package rime
  :straight (rime :type git
                  :host github
                  :repo "DogLooksGood/emacs-rime"
                  :files ("*.el" "Makefile" "lib.c"))
  :custom
  (default-input-method "rime"))

使用 Quelpa

切换折叠 
(use-package rime
  :quelpa (rime :fetcher github
                :repo "DogLooksGood/emacs-rime"
                :files ("*.el" "Makefile" "lib.c"))
  :custom
  (default-input-method "rime"))

注意（MacOS）

NOTE 如果你在 MacOS 上或是选择自己编译 librime （没有放在系统路径中）， 必须 指定 rime-librime-root 。

在 :custom 中加入如下内容.

(假设将 librime 解压到了 ~/.emacs.d/librime)

(rime-librime-root "~/.emacs.d/librime/dist")

激活 Rime 输入法

使用 toggle-input-method 来激活，默认快捷键为 C-\