おすすめの :help まとめ - 反省はしても後悔はしない

この記事は Vim Advent Calendar 2012 の 240 日目の記事です。昨日は id:thinca さんの空間を飛び越えろ！portal.vim を作りましたでした。

:help について

:help といえばおなじみ Vim のヘルプを引くためのコマンドです。

:help の引き方については過去の良質な記事を参照しましょう。

しかし、:help はあくまでもリファレンスであるため、調べたい対象がある程度わかっている場合でなければ望んだ情報にたどり着けません。そこで、今回は膨大な :help のページの中からおすすめを紹介します。

一番最初の :help

:help

引数なしで :help を起動します。:help から見れるページの目次が閲覧出来ます。気になる項目があれば <C-]> で閲覧してみましょう。

ユーザマニュアル

:help usr_toc

Vim の使い方や機能が体系的にまとまっています。とりあえず、Vim 初心者の人は初級編の :help usr_01 から順番に読んでいきましょう。Vim に慣れた人でも時間があるときに全部読んでみましょう。新しい発見があるかもしれません。

クイック・リファレンス

:help quickref

Vim のよく使うコマンドを網羅したクイックリファレンスです。機能ごとに分類されています。クイックリファレンスなのに約 1400 行あります。Vim にはそれだけ膨大なコマンドがあるってことですね。これも時間があるときに目を通してみるといいとおもいます。詳細な説明を読みたければ <C-]> です。

:help index

Vim の(ほとんど)すべてのコマンドがまとめてあります。こちらはアルファベット順になっています。

オプションまとめ

:help option-list

一番最初に vimrc を書くとすればまずはオプションの設定でしょう。このページでどんなオプションがあるかを調べて自分だけの Vim にカスタマイズしましょう。実はこのページは先ほど紹介した quickref の中にあります。

Tips

:help tips

Vim Advent Calendar の中でも Tips 系の記事は人気ですね。Vim のヘルプの中にも Tips のページがあります。一度覗いてみると良いでしょう。

Vim の起動引数

:help startup-options

Vim には起動するときにオプションとして引数を渡せます。たとえば vim --noplugin でプラグインを読み込まない、などです。このページでどんな起動引数があるか調べましょう。

Vim のウィンドウについて

:help windows

Vim のウィンドウは水平や垂直に分割できたりしてかなり高機能なのですが、それ以外にもいろいろ機能があります。このページに Vim のウィンドウについての情報があります。ちなみに、OS の Windows について知りたい場合は :help win32 です。

Vim のタブページについて

:help tabpage

あまり使いこなされていないという噂の Vim のタブページについての help です。<Tab> と混同しないようにしましょう。

Vim の正規表現

:help pattern-overview

Vim の正規表現は結構独特で記号なんかどれをエスケープすべきかいつも忘れます。そんな時はこのページを見に行きましょう。Vim で使えるパターンがまとめてあります。

Vim script

:help usr_41

Vim を本気でカスタマイズしようと思ったら Vim script を書かざるを得ません。このページでは Vim script について学ぶことができます。変数、条件文、ループ、関数と Vim script の基本的な部分かプラグインの書き方まで体系的に説明されています。量が多い (2400 行ほど) ので一気に読むのは大変です。最初は基礎的なところだけでいいでしょう。

Vim script の関数一覧

:help function-list

上の usr_41 の一部なのですが、Vim script で使える関数の一覧が機能ごとにまとまっています。

:help functions

こちらはアルファベット順です。

プラグインを書く

:help write-plugin

これも usr_41 の一部ですが。Vim script に小慣れてきたら自分でプラグインを作ってみたくなるものです。プラグインの書き方については良質な記事が Web 上にもありますが、:help に書いてある方も読んでおくといいかもしれません。

:help write-filetype-plugin

ftplugin を作る場合はこちら。

:help help-writing

プラグインを書いたら必ずドキュメントも書きましょう。このページでは自作プラグインのためのヘルプの書き方が説明されています。

Vim の哲学

:help design-goal

Vim そのものを開発するための設計目標が書かれていますが、Vim はかくあるべきという哲学とも言えます。特に design-not には Emacs との考え方の違いに言及されているので一度読んでおくと良いです。

最後に

Vim の :help は情報の宝庫です。:help をうまく活用して Vim の戦闘力を高めましょう。ちなみに、vimrc 読書会では「歩く :help」みたいな人がたくさんいて気軽に質問に答えてくれます。

明日は id:manga_osyo さんです。*1

*1:おしょーさんすごい