在 GNU Emacs 的 Help 文件系統

GNU Emacs 有一個功能很好用, 他的 key binding 一般來說是 C-h S, 或是 M-x info-lookup-symbol, 使用的方法是把游標移到你要查詢的 symbol 上面, 然後按下 C-h S, 這時候 Emacs 會自動幫你找到相對應的 Info 文章, 並顯示在另一個視窗(這裡的視窗是 Emacs 的術語) 上。

如果你想要試用這個功能, 可以試著開啟任何一個 Emacs Lisp 檔案, 然後對著任何一個 function 鍵入 C-h S, 就會出現文件, 舉例來說, 如果對著 require 按下 C-h S, 在筆者的 Emacs 24.1.1 就會出現下列的文件:

-- Function: *require* feature &optional filename noerror
    This function checks whether FEATURE is present in the current
    Emacs session (using `(featurep FEATURE)'; see below).  The
    argument FEATURE must be a symbol.

    If the feature is not present, then `require' loads FILENAME with
    `load'.  If FILENAME is not supplied, then the name of the symbol
    FEATURE is used as the base file name to load.  However, in this
    case, `require' insists on finding FEATURE with an added `.el' or
    `.elc' suffix (possibly extended with a compression suffix); a
    file whose name is just FEATURE won't be used.  (The variable
    `load-suffixes' specifies the exact required Lisp suffixes.)

    If NOERROR is non-`nil', that suppresses errors from actual
    loading of the file.  In that case, `require' returns `nil' if
    loading the file fails.  Normally, `require' returns FEATURE.

    If loading the file succeeds but does not provide FEATURE,
    `require' signals an error, `Required feature FEATURE was not
    provided'.

上述作法是當你目前的 major mode 有相對應的 Info 檔案的時候, 可以直接使用 C-h S 來查詢, 如果沒有的話, Emacs 會先問你要使用哪一個 major mode 的 help 檔案, 然後再查詢該 symbol 的文件。那麼, 如果要為新的 major mode 增加 Info 文件呢? 這時候你可以在 .emacs 裡加上 info-lookup-maybe-add-help 來把某個 Info 檔案加入 major mode 裡面, 範例如下:

(require 'info-look)

(info-lookup-maybe-add-help
 :mode 'asm56k-mode :topic 'symbol
 :regexp "[a-zA-Z]+"
 :doc-spec '(("(dsp563xx)Index")
             ("(dsp563xx)Concept Index")))

上述的範例是指定 major mode asm56k-mode 的 Info 文件是 dsp563xx, 這個檔案必須在 Info 系統能找到的路徑上, 透過 Index 與 Concept Index 這兩個 Info node 來查詢關鍵字的 Info 文件, 而可以被查詢的關鍵字的 regular expression 則由 :regexp 來指定, 本範例的關鍵字是由純英文字母組成。上述的範例是筆者為了要在 GNU Emacs 裡面寫 Motorola DSP56300 的組合語言而增加的, 這樣筆者在 asm56k-mode 編輯組合語言的時候, 就可以隨時透過 C-h S 來查詢某個助憶碼(mnemonic) 的用法以及 instruction encoding, 而這些是存在另一個 Info 文件上。

Info 檔案在 GNU Emacs 中是一個重要的文件系統, 可以由 Texinfo 檔案編譯而成, 現在也有很多文件系統也可以產生 Texinfo 的格式, 比如 Sphinx, 對 Texinfo 有興趣的讀者可以參考一下 Arnold Robbins 在 Linux Journal 所寫的介紹文章 What's GNU: Texinfo. 不管是用什麼方法產生 Info 檔案之後, 透過設定, 結合 C-h S 的便利性, 你就可以在 GNU Emacs 裡面很便利的查詢文件。

--