Git コマンドのヘルプをテキストファイルに出力する方法
2011-03-03
2分で読了
更新: 2025-12-14
目次
Git において、コマンドの使い方などは git help で見ることができます。例えば「branch」コマンドについて知りたいときは、
git help branch
とすればOKです。これでターミナルにヘルプが表示されます(qで終了)。
そして、このヘルプをテキストファイルで出力することもできます。branch.txt というファイルで出力したいときは、
git help branch > branch.txt
とすればOKです。
しかし、このままだと、ターミナルでヘルプを表示したときにアンダーラインが引いてあるものや太字の大文字になっているものなどは、その装飾の情報も含まれて表示されてしまうため、おかしな状態になってしまいます。
SSYYNNOOPPSSIISS
_g_i_t _b_r_a_n_c_h [--color[=] | --no-color] [-r | -a]
[-v [--abbrev= | --no-abbrev]]
[(--merged | --no-merged | --contains) []]
_g_i_t _b_r_a_n_c_h [--set-upstream | --track | --no-track] [-l] [-f] []
_g_i_t _b_r_a_n_c_h (-m | -M) []
_g_i_t _b_r_a_n_c_h (-d | -D) [-r] ...
(抜粋)
そこで、colcrt や col という UNIX のコマンドを合わせて使えば良いみたいです。
git help branch | colcrt | col > branch.txt
以下のように、先ほどおかしなことになっていた装飾部分は、アンダーラインが引かれたきれいなテキストになって出力されます。
SYNOPSIS
git branch [--color[=] | --no-color] [-r | -a]
--- ------
[-v [--abbrev= | --no-abbrev]]
[(--merged | --no-merged | --contains) []]
git branch [--set-upstream | --track | --no-track] [-l] [-f] []
--- ------
git branch (-m | -M) []
--- ------
git branch (-d | -D) [-r] ...
--- ------
(抜粋)
ちなみに「|」は、左のコマンド結果を右のコマンド結果に渡すという意味です。
以上、自分用メモでした(col はなくてもいいかも)。