post

Vim ja:ヘルプ

Contents

はじめに

Vim には多種多様なコマンド、ショートカット、バッファ等があり、これらの機能を全て覚えることは不可能です。そして、全て覚えることはそんなに重要でもありません。必要になったときに、必要な機能を探せることが、最も大切なのです。

たとえば、あなたは長いコマンド名を毎回タイプしたくないと思い、そしてその解決策になるかもしれない Vim の「省略語」機能を思い出したとしましょう。けれども、その使い方までは思い出せなかったとします。どうしましょうか?

Vim でヘルプを得る、いろいろな方法を見てみましょう。

:help コマンド

ヘルプを得るために最初に行くべき、最も重要な場所は、組み込みのドキュメントです。Vim は私の知る限り、最も充実したユーザーマニュアルを備えているのです。

我々の例では、単に :help abbreviation を実行すれば、 abbreviations のヘルプに飛び、
:ab:iab コマンドの使い方を読むことができます。

ほかの方法もあります。何を検索してよいか分からないときは :help user-manual を実行すれば
、ユーザーマニュアル全体を参照して、やりたいことと関係あると思われる章を読むことができます。

:help 記事の読み方

:help abbreviate から、次の例を見てみましょう。

  :ab[breviate] [<expr>] {lhs} {rhs}
               add abbreviation for {lhs} to {rhs}.  If {lhs} already
               existed it is replaced with the new {rhs}.  {rhs} may
               contain spaces.
               See |:map-<expr>| for the optional <expr> argument.

Vim のヘルプには標準的な書き方があり、
私たちがコマンドの説明を全て理解しなくてもすむように、必要な部分だけが表示されるようになっています。

1 行目にはシンタックス、つまり、コマンドの使い方が書かれています。

:ab[breviate] の角かっこは、コマンド名のうちその中の文字列が省略可能であることを
表しています。あなたは、最短で :ab とタイプすれば、Vim はコマンドを認識します。
ほかに、:abb とか :abbr とか :abbre など、
フルネーム :abbreviate に至るまでどれを用いても構いません。
大抵は、できるだけ短いものを用いるものですが。

[<expr>] の角かっこもまた、’expression’ が省略可能であることを意味します。

{lhs} {rhs} における中かっこは、実際の引数の場所を表すものです。
これらはそれぞれ、「左辺」(left hand side) と「右辺」(right hand side) の略です。

2 行目以降のインデントされた段落で、コマンドが何を実行するのか、簡単に説明されています。

2 段落目に、さらに詳しい情報源が示されていることに注意しましょう。
カーソルを 2 つの「パイプ記号」(‘|’) の間に動かし、ctrl-] を押せば、
対応する :help 記事への「リンク」に飛ぶことができます。
戻ってくるには ctrl-o を押します。

:helpgrep コマンド

トピックのタイトルが分からない場合は、:helpgrep を使って、ドキュメント全体をフレーズで検索できます。
たとえば、単語のはじめを検索する方法を知りたい場合は、:helpgrep beginning of a word
を実行すればよいのです。

ドキュメントの中で、検索したフレーズが次に現れる場所に移動するには :cnext を、
前に現れる場所なら :cprev を用います。
:clist を使えば、フレーズの現れる全ての箇所のリストを見ることができます。

クイックヘルプ

Vim で開いたファイルに次のテキストをコピーし、さらに実行してみましょう。

:let &keywordprg=':help'

そしてカーソルを、単語 keywordprg 上に(どこでもよいので)動かし、
K とタイプしてください。 その単語のヘルプに、すぐに飛ばされるはずです。
このショートカットにより、わざわざ :help keywordprg とタイプする必要がなくなります。

おわりに

Vim の使い方の情報は豊富にあり、たくさんの Vimmer もあなたを喜んで助けてくれるでしょう。
Vim コミュニティーは、Vim エディターの最大の強みのひとつです。
リソースを活用し、成長し続けるコミュティーに参加しましょう。

真の喜びは、知ることではなく、発見することにある。

— Isaac Asimov