東風破 /plum/ 基本用法

By Toby Tso on 07 Apr, 2020

本文使用 ibus-rime。本文理應適用於各平臺之前端實現，惟欲於 Windows 平臺使用「東風破」者，需參閱 GitHub 頁面之介紹。

「東風破」(下稱 plum) 乃 RIME 之配置管理工具。

安裝

plum與 RIME 之本體相分離，故安裝時亦不必位於同一目錄。本人於 ~/Downloads 下運行 plum 之安裝命令 (見 GitHub)。

首次運行此命令，將在當前目錄下建立 plum 目錄 (內容爲 plum 本體)，並智能識別系統正使用的RIME前端實現，對「用戶資料夾」進行配置。

方才的首次配置更新了 RIME 所有官方輸入方案，具體實現是抓取 GitHub 上各官方輸入方案 (通常比軟件源裏的版本新)，放置於「用戶資料夾」下。

此操作將令 RIME 在「部署」時，以「用戶資料夾」下的檔案爲準，而非「用戶資料夾」下 build 目錄內的檔案 (這些預設的「輸入方案」檔案隨 RIME 本體一同安裝，一般不是最新版)。

RIME 這一「部署」的主次邏輯也將用於後文及《安裝及啓用輸入方案 (RIME)》的「啓用輸入方案」章。

plum 實爲一 bash 腳本。使用時請在 plum 目錄下執行命令，用法如下：

bash rime-install [--select] <套裝或配方> [套裝或配方...]

因其不是 CLI (命令列) 程式，故 bash 字樣不可省略，亦不存在 --help 選項。

而 --select 選項則提供了一個緩衝，讓人在安裝「套裝」前可以檢視將要安裝的「配方」們，或者僅選擇其中某一些「配方」來安裝。

「套裝」裏的「配方」、或獨立的「配方」，將被安裝於「用戶資料夾」內，「部署」時將自動識別。

若要更新 plum 本體，請運行命令：

bash rime-install plum

若讀者使用第三方前端實現，則 plum 之用法前應加上 rime_frontend 或 rime_dir 參數。示例 fcitx-rime 的情形：

rime_frontend=fcitx-rime bash rime-install [--select] <套裝或配方> [套裝或配方...]

或

rime_dir="$HOME/.config/fcitx/rime" bash rime-install [--select] <套裝或配方> [套裝或配方...]

plum 內建三個「套裝」(:preset、:extra、:all)。「套裝」由 conf 檔案管理，內建的三個「套裝」爲 plum 目錄下三個 conf 檔：

all-packages.conf
extra-packages.conf
preset-packages.conf

若要納入 GitHub 上第三方的「套裝」conf 檔，參數爲 <user>/<repo>/<filepath>，或指定分支的 <user>/<repo>@<branch>/<filepath>，指向一個 conf 檔：

bash rime-install lotem/rime-forge@master/lotem-packages.conf

此命令亦可加入 --select 選項 (該選項之作用在上文有介紹)：

bash rime-install --select lotem/rime-forge@master/lotem-packages.conf

執行上面任意一條指令後，該第三方 conf 檔會儲存於 plum 目錄下。下一次執行命令時，可以用 :lotem 來指代 (lotem 乃上文示例「套餐」之名稱，若使用其他「套餐」，請輸入相應的「套餐」名稱)。

一個「套裝」裏面包含一系列「配方」，而 plum 內建的 3 個「套裝」共包含了 21 個配方。

若要安裝 GitHub 上第三方的「配方」，參數爲 <user>/<repo>，或指定分支的 <user>/<repo>@<branch-name>：

bash rime-install jyutping@master lotem/rime-zhung@master

(示例安裝了官方 jyutping 倉庫的 master 分支、lotem‌ 氏 rime-zhung 倉庫的 master 分支)

「配方」可包含一個或多個「輸入方案」或「RIME 配置」。如「℞ cantonese」包含了 jyut6ping3 與 jyut6ping3_ipa 兩個輸入方案；而「℞ prelude」包含了 default.yaml 等 RIME 常用組件的預設配置。