Vimのhelpを快適に引こう

この記事はVim Advent Calendar 2013 : ATNDの58日目の記事です。 57日目は@deris0126さんによるVimのタブで開いているバッファのdiffを簡単に表示するpluginを書いたでした。

Vimのhelpを自由自在に引けることは、真のvimmerになるための第一歩。

:helpを使いこなす = Vimを極めるための一歩

– Vimの極め方

ということで、数多くのVimmerがVimのhelpの使い方を解説したり、おすすめのhelpを紹介したりしています。しかし、helpを読むための設定、カスタマイズ方法を紹介するものがあまりないように思えたので、今回は既存のhelpに関する記事のまとめと、設定/カスタマイズ方法を中心に書いていきます。

help記事のまとめ

Helpの使い方全般

まずは上記の記事や:h helphelp.txtで使い方を覚えましょう。さらっと流し見するだけでも未だに使いこなせてないものがたくさん見つかったりなどすることがあり、今一度読んでみるのもいいのではないでしょうか。

詳しい使い方については上記の記事でほぼ解説されているのでここでは割愛します。

ここから設定Tips

Kでカーソル下の単語のhelpを引く

set keywordprg=:help " Open Vim internal help by K command

デフォルトでKはmanを引く設定になっていますが、上記の設定でvimのhelpを引けるようになります。visualモードで選択した範囲を引くこともできます。引きたいものが関数だと括弧を含めるかどうかで結果が変わるので(を含めて選択して引くといったことができるのでいい感じです。K押しやすい。

helpがちょっと読みにくい

nnoremap <Space>t :<C-u>tab help<Space>
nnoremap <Space>v :<C-u>vertical belowright help<Space>
" MoveToNewTab
nnoremap <silent> tm :<C-u>call <SID>MoveToNewTab()<CR>
function! s:MoveToNewTab()
    tab split
    tabprevious

    if winnr('$') > 1
        close
    elseif bufnr('$') > 1
        buffer #
    endif

    tabnext
endfunction

参考: あにゃログ – vim でタブを使う

直接helpとは関係ありませんが、使い始めの頃helpのウィンドウが読みづらくて仕方なかった覚えがあります。特に開いた後ちまちまwindowのサイズを大きくするのは面倒くさい。

ということで、最初からtab/vsplitで開く設定や、カレントウィンドウを別のタブに開き直すキーマップを使うといいと思います。MoveToNewTabの設定によって「気軽にKで開く->本格的に読みたいからタブページで開き直す」という流れなどがスムーズになっておすすめです。

カレントウィンドウを別のタブに開き直すMoveToNewTabの設定は最初の頃設定してライフチェンジングした覚えがあり、今でもかなり使ってます。help以外でも使えますね。

help用の設定をする

augroup MyVimrc
  autocmd!
augroup END

" qでhelpを閉じる
autocmd MyVimrc help nnoremap <buffer> q <C-w>c

" 一気に複数設定する場合
function! s:init_help()
  nnoremap <buffer> q <C-w>c
  nnoremap <buffer> <Space><Space> <C-]>
  " etc ...
endfunction
autocmd MyVimrc help call s:init_help()

個人的にはqで閉じるくらいしか設定していませんが、もっと便利な設定とかきっとあるので自分好みにしていきたい。

日本語でも読みたい

vim-jp/vimdoc-ja

set helplang& helplang=en,ja “ If true Vim master, use English help file. NeoBundle ‘vim-jp/vimdoc-ja’

僕の場合最初は英語だけを設定しており、なんとか頑張ってhelpを読むといった状態でした。

それはそれでいいことだとも言えるのですが、なんだかんだ日本語だとよりわかりやすかったり、英語でわからなかったら日本語で読めばいいという安心感からhelpを読む抵抗が減るので、英語環境でvimを使っていてまだ使っていない方はインストールしておくと良いと思います。

上記の設定だとkeywordの後に@jaをつけることで日本語helpが読め、デフォルトでは英語になります。

自動でhelpを折りたたんでほしい

thinca/vim-ft-help_fold

NeoBundleLazy ‘thinca/vim-ft-help_fold’, { \ ‘filetypes’ : ‘help’ \ }

これは、前々から思っていて、無ければ自分で作ってみようかと思っていた時期が僕にもありました。

が、調べてみるとthincaさんがすでに作ってた。試してみたところfoldtextも含めいい感じに折りたたんでくれます。

折りたたみ好きはぜひ

Uniteでhelpを引く

tsukkee/unite-help
Shougo/unite-help

“ NeoBundleLazy ‘tsukkee/unite-help’ NeoBundleLazy ‘Shougo/unite-help’, { \ ‘unite_sources’ : ‘help’ \ }

“ Execute help. nnoremap :Unite -start-insert help ” Execute help by cursor keyword. nnoremap g :UniteWithCursorWord help

書いている時に気づいたのですがShougoさんのfork版が存在してメンテナンスされてるっぽいです。中身の差分みてないので何が改善されてるかは知らない(怠慢)

追記: 主にキャッシュ周りが改善されているようです

Uniteでインクリメンタルに検索できてhelpが格段にひきやすくなるので良さげです。

ブラウザでもhelpを引く

Vim documentation: help(日本語)
Vim documentation: help(英語)

Vim記事を呼んでいるとき、LingrのVim部屋で気になるものがあったけど、botに検索してもらうほどでもないかな..というとき、手元のタブレットでvimのヘルプが読みたいときなどなど、ブラウザでvimのhelpを読めると便利な場面がきっとあるとおもいます。

そんな時は上記の日本語版ヘルプ or Sourceforgeの本家のヘルプを読むといいんですが、日本語版は検索がGoogleカスタム検索で少し不便、英語版は検索機能は高いけどレイアウトが見づらい…両方わざわざアクセスするの面倒くさい…

そういった不満を改善する(かもしれない)ブックマークレット、作りました。

GitHub: haya14busa/vimdoc-marklet

ブックマークバーにドラッグ&ドロップで登録できます。

上から日本語版ヘルプを検索、英語版ヘルプを検索、どちらかを開いているときにもう片方の言語で開くブックマークレットです。(en-to-jaとかネーミングおかしいのは目を瞑りましょう)

vimdoc@ja,@enは事前に選択しておくとそのワードで検索します。これでVim記事読む時もhelpが手軽に読めて便利。

日本語版ヘルプの検索機能は、Googleカスタム検索ではなく、おしょーさんにつけてもらったLingrのbotが使っている方法のリダイレクトバージョンを使っているので、ほとんどvimの検索ワードと同じように使えるはずです。おしょーさんありがとうございます。

まとめ

ここまで個人的に有用だと思うhelpに関する設定やプラグインを紹介しましたが、もっと便利な設定や知見がきっとたくさんあります。それを上級Vimmerに教えてもらう…のもいいですが、それだけでなく自分でhelpを読み込んで使いこなせるようになりましょう!(自戒)

Let’s :help!

Don’t panic!

haya14busa

haya14busa’s memo