Vimでマニュアルや日本語ヘルプを見る

Unix 系 OS にインストールされているマニュアルページを vim(1) の中で見たり、日本語ヘルプを見るための手順を整理しました。備忘録を兼ねて紹介したいと思います。

動作検証を行った環境は以下のとおりですが、Linux ディストリビューション及び WindowsCygwin 環境でも同じような結果が得られると思います。

  • さくらのレンタルサーバー(スタンダードプラン)の FreeBSD
    • ソースからインストールした Vim 7.4
  • Windows 10 x64 Professional

vim(1) でマニュアルを見るための設定

情報源

FreeBSD, Debian 等の Unix 系のシステムには、コマンド man(1) で閲覧することが出来るマニュアルページが多数インストールされています。

vim(1) には編集中のファイルのキーワードを元に、システムにインストールされているマニュアルを見ることができるそうで、Vim 日本語ドキュメントでは、以下の様な場所で手順が記載されています。

試しにマニュアルを見てみる

vim(1) の中からマニュアルを参照するためには、参照するためのキーワードも書かれたテキストが必要になります。Unix 系 OS の場合は、以下のようにしてサンプルのファイルを作成します。

$ LANG=C man ls | col -b | head > ls.txt
$ cat ls.txt

次に、以下のようにして vim(1) を起動します。

$ vim ls.txt
Vim-Japanes-Help-2016-0722_01

キーボードを操作してカーソルを ls の文字まで移動します。なお、この時のカーソルの位置は、l であっても s であっても構いません。

Vim-Japanes-Help-2016-0722_02

カーソルが ls の文字まで移動したら、その場で SHIFT-K を押します。そうすると、以下のように ls(1) が表示されます。システムによっては、日本語化された ls(1) が表示されるかもしれません。

Vim-Japanes-Help-2016-0722_03

以前の vim(1) の画面に戻る場合は、キーボードから :q を入力します。入力してすぐに画面最下部に’続けるにはENTERを押すかコマンドを入力してください‘というメッセージが表示されますので、Enter を押します。

Vim-Japanes-Help-2016-0722_04

その後、以前の画面に戻ります。

Vim-Japanes-Help-2016-0722_05

ランタイム man.vim を使ってマニュアルを見てみる

ただし、上記の方法では編集中のテキストとマニュアルを同時に表示できません。以下のコードを vim(1) で入力し、man.vim という man(1) で表示できるマニュアルページを表示させるためのプラグインを読み込んでみます。

:runtime! ftplugin/man.vim
Vim-Japanes-Help-2016-0722_06

これで :Man というコマンドが使えるようになるそうで、:Man ls のように入力して Enter を押すと、上記と同じように ls(1) が表示されます。

先ほどと違って今度は画面が分割され、上段にマニュアルページ、下段に編集中のテキストが表示されています。ただし、12.6 マニュアルを引くの説明とは違い、マニュアルページのハイライトの箇所は、通常のテキストと同じ色でした。

Vim-Japanes-Help-2016-0722_07

元の編集画面に戻る場合は、CTRL-W w を入力します。このキーバインドはトグルになっていて、編集画面とマニュアルページの画面を行ったり来たりできます。

.vimrc にランタイム自動読込を保存する

先ほど読み込んだランタイムは、Vim の設定ファイルである .vimrc に保存しなければ、次回 vim(1) を起動した時に有効になりません。

.vimrc を作成済みの場合

すでに ~/.vimrc または ~/.vim/vimrc を作成している場合は、以下のコードを追記します。

$ vim ~/.vimrc
runtime ftplugin/man.vim

.vimrc を作成していない場合

まだ .vimrc を作成していない場合は、以下のような方法で作成します。

起動中の vim(1) で作成する場合

起動中の vim(1) で作成する場合は、以下のように入力して ~/.vimrc を作成します。保存する内容は、上記と同じです。

:e ~/.vimrc
シェルのコマンドラインで作成する場合

シェルのコマンドラインで作成する場合は、以下のような方法があります。

$ echo runtime ftplugin/man.vim >> ~/.vimrc

.vimrc にプラグイン man.vim を設定しましたので、次回 vim(1) を起動した時も上記と同じように :Man ls のように入力するとマニュアルページを表示することが出来ます。

Vim の日本語ヘルプを見るための設定

Vim日本語ドキュメントのサイトでは Vim のヘルプファイルを日本語に翻訳したものをブラウザで閲覧できますが、このサイトとほぼ同じ内容のものが、GitHubvimdoc-ja で公開されています。

日本語に翻訳されたヘルプファイルを利用するための手順は、wiki – vimdoc-ja に掲載されています。その手順に沿って設定しました。なお、香り屋版Vim は最初から日本語ヘルプを見ることが出来ますので、以下の作業は不要です。

Vim 日本語ヘルプのダウンロード

ヘルプファイルをダウンロードする方法には .tar.gz または .zip 形式のファイルをダウンロードして展開する方法と、Git のクライアントコマンドである git(1) を使って clone する方法があります。

今回は git(1) を使ってダウンロードしました。もしホームディレクトリに .vim というディレクトリを作成していなければ、以下のようにして作成します。

$ mkdir ~/.vim

git(1) を使用してダウンロードする場合は、以下のようになります。

$ git clone https://github.com/vim-jp/vimdoc-ja.git ~/.vim/bundle/vimdoc-ja
Cloning into /home/hogehoge/.vim/bundle/vimdoc-ja...
remote: Counting objects: 9004, done.
remote: Total 9004 (delta 0), reused 0 (delta 0), pack-reused 9004
Receiving objects: 100% (9004/9004), 25.06 MiB | 3.69 MiB/s, done.
Resolving deltas: 100% (6890/6890), done.
Checking connectivity... done.
 
$ ls -Al ~/.vim/bundle/vimdoc-ja
drwxr-xr-x  7 hogehoge  users   512  7月 23 12:39 .git
-rw-r--r--  1 hogehoge  users    12  7月 23 12:39 .gitignore
-rw-r--r--  1 hogehoge  users   904  7月 23 12:39 README.md
drwxr-xr-x  2 hogehoge  users  3072  7月 23 12:39 doc
drwxr-xr-x  2 hogehoge  users   512  7月 23 12:39 syntax

Vim 日本語ヘルプの利用方法

GitHub から持ってきたソースでコンパイルした Vim の場合、:help コマンドで表示されたヘルプファイルは英語で表示されていると思います。そのため、日本語のヘルプファイルを表示できるよう、設定を行います。

Vim-Japanes-Help-2016-0722_08

日本語ヘルプを利用するための設定

vim(1) を起動して以下のようにランタイムパスを設定した後、:helptags コマンドを使ってタグファイルを生成します。

:set runtimepath+=~/.vim/bundle/vimdoc-ja
:helptags ~/.vim/bundle/vimdoc-ja/doc

その後 :help コマンドを実行すると、日本語のヘルプファイルが表示されると思います。

Vim-Japanes-Help-2016-0722_09

もし英語のヘルプファイルが表示される場合は、以下のようにすると優先順位を上げられるそうです。

:set helplang=ja,en

なお、上記の設定を .vimrc に追記しなければ、次回 vim(1) を起動した時に反映されません。忘れないうちに、上記の設定を .vimrc に追記しておきましょう。

日本語ヘルプの使い方

Vim のヘルプファイルを下方にスクロールすると |quickref| とか |tutor| のような箇所があり、これは タグ と呼ばれるそうです。調べたいタグにカーソルを移動して CTRL-] を押すと、以下のように選択したタグの説明箇所にジャンプしてくれます。

Vim-Japanes-Help-2016-0722_10

タグの利用方法は、*quickref.txt*移動: タグの利用に説明があります。

 

Vim を使い始めて間もないため、私が理解できている範囲で紹介させていただきました。最後までお読みいただきありがとうございました。

 

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です