manで自作のマニュアルを読めるようにする

まえがき

ソフトウェアにはmanコマンドで見ることのできるマニュアルが付属していることがあります. 例: github.com sl.1 というのがそうです. せっかくなのでmanコマンドでマニュアルを読めるようにします.

環境: ubuntu18.04

注意: マニュアル自体は作らないので書式には触れません

手っ取り早い方法

末尾が1なら /usr/share/man/man1にファイルを配置すれば見れます.
ただ, 自作のコマンドを/usr/local/binに配置しないように普通ここに配置しないような気がします. するのかな？

好きな場所に配置する方法

/usr/share/man/と同様のディレクトリ配置をもつディレクトリを作成します. (必要なものだけで良いです)
日本語のmanが読みたい場合はjaディレクトリ以下に同様のものを作成します. 例:

~/man
├── man1
├── man2
├── man3
├── man4
├── man5
├── man6
├── man7
├── man8
└── ja
    ├── man1
    ├── man5
    └── man8

続いて, マニュアルを配置します. マニュアルファイル末尾が1ならman1, 5ならman5に配置してください.
先程のslの例だと日本語のマニュアルsl.1.jaが付属していますが, 末尾.jaを削除した上でjaディレクトリ以下のman1に配置してください.

$ man -M ~/man sl で読めたらokです.

最後に, 環境変数を通します. $MANPATHにディレクトリを指定してあげるのが良さそうです.
例: $ echo "MANPATH=$HOME/man" >> .bashrc

以上