manをVimで見る

Vimでmanを見る方法について。

manの表示を環境変数で設定
Vimの中からHelpを開く
ラッパー関数を作る
おまけ

manの表示を環境変数で設定

manコマンドでの表示はMANPAGERまたはPAGERという環境変数を設定しておくとそれを使ってマニュアルを表示します ¹。

PAGERの方は他のプログラムも使うので、 manだけに対して使いたいものがある場合はMANPAGERに指定しておきます。

manの結果はパイプで渡される様な形で表示プログラムに渡される様で、 Vimで表示したい場合には単に

export MANPAGER=vim

としておいてもダメで、

$ man bash
Vim: Warning: Input is not from a terminal

みたいに表示されておかしくなります。

表示するためには

export MANPAGER="vim -"

の様に標準入力(stdin)を表示するように設定しておきます。

ただ、これをPAGERの方に設定しておくと git diffやgit log等PAGERを使うコマンドがおかしくなるので注意。

また、manで表示されるマニュアルには表示用のシンタックス記号等が入ってる?らしく (manファイルをさらにmanコマンドが修正したもの)、そのまま表示すると文字化けの様になる部分が出るため

export MANPAGER="col -b -x|vim -"

の様に、colコマンドをはさみます。 colは入力に色々フィルターをかけて出力しなおしてくれるコマンドで、 -bはバックスペースを消したり各word毎に余計な記号を消して?くれて、 -xでタブをスペースに変換します。

さらにもう一歩Vim側の設定を加えて

export MANPAGER="col -b -x|vim -R -c 'set ft=man nolist nomod noma' -"

こんな感じにしておくと良い感じになります。

-Rオプションで読み込み専用に。

-cでVimコマンドを実行して filetypeをmanにします。Vimには予めman用にシンタックスファイルも用意されてるので ² filetypeを指定することで良い感じの色表示にしてくれます。

それから編集するわけではないのでnolistで余計な記号を映さないように。

nomodは指定する必要があるのがよく分かりませんが、下に上げる参考ページ等大概の場所で設定してあるので取り敢えず ³。

後はnoma(nomodifiable)を設定して編集そのものを禁止してしまいます。 (-Rと両方設定するのは冗長かも。)

下のページなんかだとGNUのmanだとMANPAGEにパイプを設定するのがうまくいかない、ということで

export MANPAGER="/bin/sh -c \"col -b -x|vim -R -c 'set ft=man nolist nonu noma' -\""

みたいにシェルをコマンドとして指定してその引数でパイプを使ったコマンドを呼ぶようにする必要があることもあるみたいです。

ただ、使える範囲のGNU manを使ってる様なRedHatやDebian GNU、Cygwin等では最初の方法でそのまま上手く行きました。

Using Vim as $MANPAGER - Zameer Manji

Using vim as a man-page viewer under Unix - Vim Tips Wiki

Vimの中からHelpを開く

manで1つ開く分には上ので十分なのですが、 VimではさらにVimの中からManを呼ぶ機能が有ります。

:Manというコマンドでマニュアルが開けたりします。

が、このコマンドはVimデフォルトだと ftplugin/man.vim で定義されていて ⁴ 、filetypeがmanの時のみに使える様になります。使える主なコマンド/ショートカットは次の様なもの。

:Man <command>でcommandのマニュアルを表示。
:Man <n> <command>でcommandのセクションnのマニュアルを表示。
<C-]>でカーソル下の文字のコマンドのマニュアルを表示。
<C-t>で戻る。

参考: :help Man

また、コマンドに当たる文字列の上にカーソルを置いてK(または<Leader>K)を押すと :! man <command>を呼んで、外部コマンドでmanを呼びます。

参考: :help K

:Manコマンド等についてはftpluginで定義されてるので、通常は有効化されていません。

man以外のファイルタイプでも有効にしたい場合は .vimrcに

runtime ftplugin/man.vim

と書いて常に読み込む様にしておきます。この場合でも<C-]>/<C-t>に関してはman以外のファイルタイプでは通常のタグジャンプのマッピングになったままなので挙動をおかしくしたりはしません。

また、K(<Leader>K)に関してはman.vimを改めて読み込まなくても使える様になっています ⁵。

しかし、これらのコマンドはMANPAGERやPAGERが定義されていると

:! man 'bash'
sh: -c: line 0: syntax error near unexpected token `||'
sh: -c: line 0: `(cd '/usr/local/share/man' && /usr/bin/tbl '/usr/local/share/man/man1/bash.1' | /usr/bin/groff -Wall -mtty-char -Tascii -mandoc -c | ( || true))'
Error executing formatting or display command.
System command (cd '/usr/local/share/man' && /usr/bin/tbl '/usr/local/share/man/man1/bash.1' | /usr/bin/groff -Wall -mtty-char -Tascii -mandoc -c | ( || true)) exited with status 512.
sh: -c: line 0: syntax error near unexpected token `||'
sh: -c: line 0: `(cd '/usr/share/man' && /usr/bin/gunzip -c '/usr/share/man/man1/bash.1.gz' | /usr/bin/tbl | /usr/bin/groff -Wall -mtty-char -Tascii -mandoc -c | ( || true))'
Error executing formatting or display command.
System command (cd '/usr/share/man' && /usr/bin/gunzip -c '/usr/share/man/man1/bash.1.gz' | /usr/bin/tbl | /usr/bin/groff -Wall -mtty-char -Tascii -mandoc -c | ( || true)) exited with status 512.
No manual entry for bash

みたいなエラーを出したりします ⁶ 。定義されてるとダメなので、

$ export PAGER=

みたいに空文字にしておいても駄目。

$ unset PAGER

として変数を消して置く必要が有ります。なので.vimrcの中で値を

let $PAGER = ''

みたいにして消しても駄目。

ということで、最初の環境変数を使った方法だと中でさらに他のマニュアルを見たい時に上手く行きません。

ラッパー関数を作る

環境変数だけでやろうとすると不具合が出てくるので、 manコマンド自体を変更してしまいます。

こんな感じ:

.bashrc

function man {
  local p
  local m
  if [ "$PAGER" != "" ];then
    p="$PAGER"
  fi
  if [ "$MANPAGER" != "" ];then
    m="$MNNPAGER"
  fi
  unset PAGER
  unset MANPAGER
  val=$(command man $* 2>&1)
  ret=$?
  if [ $ret -eq 0 ];then
    echo "$val"|col -bx|vim -R -c 'set ft=man' -
  else
    echo "$val"
  fi
  if [ "$p" != "" ];then
    export PAGER="$p"
  fi
  if [ "$m" != "" ];then
    export MANPAGER="$m"
  fi
  return $ret
}

vimに渡す引数の最後の-を忘れないように注意。

やってることはPAGERやMANPAGERを一旦unsetした後に manを呼んであとで回復させてます。

また、manコマンドは直接vimには渡さず、一度結果をみてエラーならそのままecho、そうでないならvimに渡す、と言った形。

また、vimの引数にはft=manのみ指定していますが、他のオプションは.vimrcの方で下の様に設定しています。

.vimrc

" Enable plugin
filetype plugin on

" Load Man command even for other file types than man.
runtime ftplugin/man.vim

" Close immediately by q, set non-modifiable settings
autocmd FileType man nn <buffer> q :q!<CR>
autocmd FileType man setlocal nospell ts=8 nolist ro nomod noma

.vimrcではpluginを有効にし、runtime ftplugin/man.vimとプラグインを読み込んで、 autocmdでqのマップとsetlocalを行っています。

qの方はqだけで直ぐにファイルを閉じれる様にしているだけです。 (通常lessなどでマニュアルを開いたのと同じ様に。)

2つ目のautocmdの方でsetlocalを行っていて、ここで

nospell: スペルチェックを表示しない(編集するわけでもないのに特殊な用語とかをチェックしても仕方ないので)
ts=8: 内部から:Manした時にはcolを通して無いのでタブがVimで設定した幅になってしまうので、マニュアルで通常使われる8幅に。
nolist: 特殊文字を表示しない。
ro: readonly。内部で開いた時には-Rが渡されてないので。
nomod: nomodified状態に。
noma: nomodifiableに。

の設定に指定ます(上の環境変数の物に少し追加)。

こんな感じで設定しておくと、通常のmanコマンドで開く時も、 Vimで何か編集中に:Manでマニュアルを開くことも、マニュアルページで<C-]>でさらにカーソル下のマニュアルページに飛ぶことも、 Kで外部コマンドでmanを開くことも出来る様になります。

おまけ

上のautocmdについてはmanの場合だけじゃなくて、他の場合にも有用で、実際にはhelp、qf、refなんかの場合にも設定しています。

autocmd FileType help,qf,man,ref nn <buffer> q :q!<CR>
autocmd FileType help,qf,man,ref setlocal nospell ts=8 nolist ro nomod noma

その他参考:

man ascii is misaligned when using vim as a pager - Unix & Linux Stack Exchange