Hack #45: help を引く

Vim には膨大な量のヘルプが付属しており、大抵のことはヘルプを見れば解決します。Vim を使っていて何か分からないことがあったとき、まず最初にすべきことは、help を引くことです。

:help コマンド

:help コマンドを使うことでヘルプを引くことができます。引数を指定せずにコマンドを実行すると、目次にあたるページが表示されます。キーワードを指定して実行すると、キーワードに関連したヘルプページを開くことができます。

キーワードのルール

キーワードにはある程度ルールがあるので、これらを把握しておくと格段にヘルプが引きやすくなります。

種類	接頭子	例
Normal mode	(無し)	:help j
Insert mode	i_	:help i_<Esc>
Visual mode	v_	:help v_x
Command-line mode	c_	:help c_<Tab>
ex コマンド	:	:help :write
オプション	'	:help 'tabstop'

また、キーシーケンスを調べる際、修飾キーが必要なキーや特殊なキーのキーワードには以下のようなルールがあります。

種類	ルール	例
Ctrl キー	接頭子 CTRL- を付ける	:help CTRL-U
Shift キー	大文字を使用する	:help J
特殊なキー	<キー名>	:help <Space>
キーシーケンス	そのまま	:help gg
特殊キーなどを含むキーシーケンス	アンダースコアで区切る	:help g_CTRL-G

ちなみに、Meta キー(Alt キー) に対しては Vim はデフォルトの機能を一切割り当てていないので、ヘルプにキーシーケンスは登場しません。

Insert mode などの接頭子が必要な場合はそのまま :help i_CTRL-X などとします。

その他、よく見そうなリファレンス的な項目についてはキーワードを覚えておくと良いでしょう。キーワードはアスタリスクで囲まれた部分です。

キーワードを打ち込んでいる途中で <C-d> を押すと、打ち込んでいるキーワードにマッチするヘルプ項目の一覧が表示されます。これを使えば知りたい項目に辿り着きやすくなります。

:helpgrep コマンド

どうしても目的の内容が見付からない場合は、:helpgrep コマンドを使います。これはヘルプの全文検索を行うコマンドです。結果は :grep コマンドと同じように扱えます。

ヘルプの項目間をジャンプする

ヘルプページには tags ファイルが用意してあり、これによって通常の tags を用いたようにヘルプの項目間をジャンプできます。すなわち、キーワード上で <C-]> をタイプすることによりキーワードにジャンプし、<C-t> によって前の位置へ戻ります。パイプ文字(|)で囲まれた部分がキーワードですが、それ以外の箇所でもキーワードにマッチした場合はジャンプします。

ヘルプファイルを更新した場合

前述の通り、ヘルプ内のジャンプは tags ファイルによって実現しています。よって、プラグインを追加、削除したり、runtime を更新したりしてヘルプファイルが更新された場合は、tags ファイルを更新する必要があります。

そのためのコマンドが :helptags コマンドです。ヘルプファイルのあるディレクトリを指定して、以下のように使います。

:helptags ~/.vim/doc

:help のススメ

ヘルプは Vim 使いの友です。どれだけ長くの時間ヘルプを読んでいたかが Vim の熟練度に比例すると言っても過言ではありません。暇を見つけたらヘルプを読むと良いでしょう。

それに伴い、:help は素早く引けるようにしておくと便利です。

:nnoremap <C-h> :<C-u>h<Space>

thinca