次: , 前: Which Function, 上: Programs


20.11 説明文書用コマンド

Emacsで実行するLispコードを編集するときには、 関数や変数の説明文字列を表示するコマンド、 C-h fdescribe-function)や C-h vdescribe-variable)を利用できます。 これらのコマンドは、説明文字列を表示したい関数や変数の名前を ミニバッファから読み取り、ウィンドウに説明文字列を表示します。

たいへん便利なことに、これらのコマンドはポイント近傍のコードから、 デフォルトの引数を選択します。 C-h fは、ポイントを含むもっとも内側のリストで呼ばれる関数をデフォルト とします。 C-h vは、ポイントの周辺にあるか隣接するシンボル名を デフォルトとします。

Emacs Lispコードに対しては、eldocモードも使えます。 このマイナモードは、ポイント位置で呼び出されている関数の引数リストを、 たえずエコー領域に表示します。 (いいかえれば、ポイントを含む関数呼び出しを探し、 その関数の引数リストを表示する。) eldocマイナモードは、Emacs Lispモードと Lisp対話(lisp-interaction)モードだけに適用できます。 この機能をオン/オフするには、コマンドM-x eldoc-modeを使います。

C、Lisp、その他言語のシンボルのinfo文書を見るには C-h C-iinfo-lookup-symbol)を使います。 ミニバッファでシンボルを指定します。 デフォルトは、バッファ中のポイント位置にあるシンボルです。 シンボルに対する説明文書を探す場所、つまり、 どのinfoファイルのどの索引を探せばよいかは、 メジャーモードが決定します。 また、ファイル名に対する説明文書を探すには M-x info-lookup-fileを使います。

M-x manual-entryコマンドを使って、 オペレーティングシステムのコマンド、ライブラリ関数、システムコールの 『マニュアルページ』を読むことができます。 このコマンドは、マニュアルページを清書するために manプログラムを実行します。 システムが許せば非同期に実行するので、 マニュアルページが清書されるまで、編集を継続できます (MS-DOSやMS-Windows 3.xでは、非同期的なサブプロセスを実行できない。 このため、これらのシステムではmanの終了をEmacsが待つあいだは 編集できない)。 結果は、`*Man topic*'という名前のバッファに入ります。 これらのバッファではマン(man)モードと呼ばれる特別な メジャーモードが使われ、 スクロールや他のマニュアルページの調査を容易に行えます。 より詳しくは、マニュアルページ用のバッファで、 C-h mと打ってください。

長いマニュアルページでは、適切なフェイスを設定するにはとても時間がかかります。 さまざまなフォントや表示色を表示できる環境であれば、 デフォルトでマニュアルページにフェイスを用いるようになっています。 変数Man-fontify-manpage-flagnilを設定すれば、 マニュアルページにおけるフェイスの使用をオフにできます。

他の方法でマニュアルページのテキストをEmacsバッファに挿入した場合、 M-x manual-entryと同じ変換を施すには、 そこでM-x Man-fontify-manpageコマンドを実行します。

GNUプロジェクトでは最終的に、ほとんどのマニュアルページを infoで閲覧可能なよりよく構成されたマニュアルに置き換えることを望んでいます。 See Misc Help。 この作業は、ほんの一部が完了しただけなので、 まだマニュアルページを読めることは有益です。