[English / Japanese]

mode-info --- 関数・変数の説明文を参照するコマンド

Last Updated at $Date: 2007-11-03 03:53:24 $.

mode-info は，メジャーモードに対応して適切な関数・変数の説明を表示するように describe-function / describe-variable を拡張するプログラムです．

概要
ダウンロード
対応している Info
インストール
使い方
動作環境

概要

Emacs には，プログラムの作成を支援するためのコマンドが多数実装されています．中でも，関数の説明文を参照するための describe-function と，変数の説明文を参照するための describe-variable は最も便利で，頻繁に利用します．例えば，Emacs-Lisp のプログラムを編集中に C-h f goto-char RET とすると，以下のように関数の説明文を閲覧することができます．

ただし，Emacs に実装されている describe-function / describe-variable は，Emacs-Lisp のみを対象としていて， C や Perl などの他の言語にそのまま利用することはできません．

mode-info は，各種のプログラミング言語について Info 形式で記述された reference manual を参照することによって， Emacs-Lisp 以外のプログラミング言語に対しても同等の環境を提供します．例えば，Emacs-Lisp のプログラムを編集中に変数の説明文を検索した場合は Emacs Lisp Reference Manual の該当部分を表示し， C のプログラムを編集中にライブラリ関数の説明文を検索した場合は GNU C Library Reference Manual の該当部分を表示します．

ダウンロード

mode-info-0.8.5.tar.gz (ChangeLog)

また，CVS で最新の開発版を入手することができます．

% cvs -d :pserver:anonymous@cvs.namazu.org:/storage/cvsroot login
CVS password: # パスワードは設定されていません．単に Enter/Return キーを押してください．
% cvs -d :pserver:anonymous@cvs.namazu.org:/storage/cvsroot co mode-info

ViewCVS でソースを閲覧することもできます．

対応している Info

現時点の mode-info は，以下の reference manual に対応しています．

Emacs-Lisp Reference Manual
- 日本語版: ftp://ftp.ascii.co.jp/pub/GNU/elisp-manual-20/elisp-manual-20-2.5-jp.tgz
Emacs Manual
- 日本語版: ftp://ftp.ascii.co.jp/pub/GNU/emacs-20.x/emacs-20.6-man-jp.tgz
GNU C Library Reference Manual
- glibc に付属．
Ruby Reference Manual
- 日本語版: ftp://ftp.ruby-lang.org/pub/ruby/doc/ruby-texi-1.4.tar.gz
Perl Reference Manual
- 日本語版: http://namazu.org/~tsuchiya/doc/perl5.000texi-j.tar.gz
Octave Reference Manual

新たな Info に対応するには，その Info から関数・変数の説明文を取り出すための簡単なモジュールを記述する必要があります．不明な点があれば，tsuchiya@namazu.org までご連絡下さい．

インストール

事前に，変数や関数の説明が記述されている Info を Emacs から閲覧できるようにインストールしてください．

最初に configure を実行してください．
```
./configure
```
このコマンドは，本パッケージを構築するために必要な準備を行います．閲覧したい Info が非標準的な場所にインストールされている場合は，その場所を以下のように指定する必要があるかも知れません．
```
./configure --with-info-addpath=~/info
```
以下のコマンドを実行して，プログラムをインストールしてください．
```
make
make install
```
以下のコマンドを実行して，閲覧対象となる Info の索引を作成し，索引をインストールしてください．
```
make index
make install-index
```
以前に作成した索引を再利用したい場合は，この操作は省略できます．

最後に，~/.emacs に以下の設定を追加してください．

(require 'mi-config)
(define-key global-map "\C-hf" 'mode-info-describe-function)
(define-key global-map "\C-hv" 'mode-info-describe-variable)
(define-key global-map "\M-." 'mode-info-find-tag)

カラフルな Info が好みの人は，以下の設定も追加してください．

(require 'mi-fontify)

configure が実行できない環境にインストールする場合は，全てのプログラムを byte-compile し，適当なディレクトリにプログラム類をコピーしてください．その後，上述の設定を行ってから，M-x mode-info-make-all-indices RET とすると，索引が作成されます．

使い方

通常の describe-function / describe-variable と同じです． C-h f 関数名 RET または C-h v 変数名 RET と入力すれば，指定された関数・変数に関する説明が表示されます．

動作環境

以下の Emacsen で動作確認済みです．

Emacs-21
Emacs-20
XEmacs
Mule-2.3 based Emacs-19.34 (ただし，APEL が必要，機能制限あり)

マクロ構文の制限から，Emacs-19.30 以前では動作しないでしょう．

[Top] / [Emacs Lisp Tips] / [mode-info]