SYNOPSIS

git help [-a|--all [--[no-]verbose]] [-g|--guides]
           [-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]

DESCRIPTION

オプションがなく、コマンドまたはガイドが指定されていない場合、gitコマンドの概要と最も一般的に使用されるGitコマンドのリストが標準出力に出力されます。

オプション --all または -a を指定すると、使用可能なすべてのコマンドが標準出力に出力されます。

オプション --guides または -g を指定すると、Gitコンセプトガイドのリストも標準出力に出力されます。

コマンドまたはガイドが指定されると、そのコマンドまたはガイドのマニュアルページが表示されます。 man プログラムは、この目的のためにデフォルトで使用されますが、これは他のオプションまたは構成変数によってオーバーライドできます。

エイリアスが指定されている場合、gitは標準出力にエイリアスの定義を表示します。 エイリアスコマンドのマニュアルページを取得するには、 git COMMAND --help を使用します。

注意: git --help... は git help ... と同じであることに注意してください。これは、前者が内部で後者に変換されるためです。

git(1) のマニュアルページを表示するには、 git help git を使用します。

このページは、 git help help または git help --help で表示できます。

OPTIONS

-a
--all

使用可能なすべてのコマンドを標準出力に出力します。 このオプションは、指定されたコマンドまたはガイド名をオーバーライドします。

--verbose

--all と一緒に使用すると、認識されたすべてのコマンドの説明が出力されます。 これがデフォルトです。

-c
--config

使用可能なすべての構成変数をリストします。 これは、 git-config(1) のリストの簡単な要約です。

-g
--guides

Gitコンセプトガイドのリストを標準出力に出力します。 このオプションは、指定されたコマンドまたはガイド名をオーバーライドします。

-i
--info

コマンドのマニュアルページをinfo形式で表示します。 info プログラムがその目的で使用されます。

-m
--man

コマンドのマニュアルページをman形式で表示します。 このオプションは、 help.format 構成変数に設定された値をオーバーライドするために使用できます。

デフォルトでは、 man プログラムを使用してマニュアルページを表示しますが、 man.viewer 構成変数を使用して他の表示プログラムを選択することもできます(後述)。

-w
--web

コマンドのマニュアルページを web (HTML)形式で表示します。その目的のためにウェブブラウザが使用されます。

Webブラウザーは、構成変数 help.browser または web.browser を使用して指定できます。前者が設定されていない場合は、 web.browser を使用します。 これらの構成変数のいずれも設定されていない場合、 (git help によって呼び出される、) git web{litdd}browse ヘルパースクリプトが適切なデフォルトを選択します。 詳細については、 git-web--browse(1) を参照してください。

CONFIGURATION VARIABLES

help.format

コマンドラインオプションが渡されない場合、 help.format 構成変数がチェックされます。 この変数では、以下の値がサポートされています。 これらは git help の対応するコマンドラインオプションとして動作します:

  • man は -m|--man に対応します。

  • info は -i|--info に対応します。

  • web または html は -w|--web に対応します。

help.browser と web.browser と browser.<tool>.path

help.browser と web.browser と browser.<tool>.path は、 (コマンドラインオプションまたは構成変数のいずれかによって、) web 形式が選択されているかどうかもチェックされます。上記「OPTIONS」セクションの -w|--web と および git-web--browse(1) を参照してください。

man.viewer

man 形式が選択されている場合、 man.viewer 構成変数がチェックされます。 現在、以下の値がサポートされています:

  • man : 通常どおり man プログラムを使用します。

  • woman : emacsclient を使用してemacsで woman モードを起動します(これはemacsclientバージョン22以降でのみ機能します)。

  • konqueror : kfmclient を使用して、新しいkonquerorタブでマニュアルページを開きます(以下の「Note about konqueror」を参照)。

対応する man.<tool>.cmd 構成エントリがある場合は、他のツールの値を使用できます(後述)。

man.viewer 構成変数に複数値を指定できます。対応するプログラムは、構成ファイルにリストされている順序で試されます。

たとえば、以下の構成:

        [man]
                viewer = konqueror
                viewer = woman

最初にkonquerorを使用しようと試みます。 ただし、これは失敗する可能性があり(たとえば、DISPLAYが設定されていない場合)、その場合、emacsのwomanモードが試されます。

すべてが失敗した場合、またはビューアが設定されていない場合は、 GIT_MAN_VIEWER 環境変数で指定されたビューアが試されます。それも失敗した場合は、とにかく man プログラムが試されます。

man.<tool>.path

構成変数 man.<tool>.path を設定することにより、優先するmanビューアへのフルパスを明示的に指定できます。 たとえば、 man.konqueror.path を設定することで、konquerorへの絶対パスを設定できます。 それ以外の場合、 git help はツールがPATH上にあると想定します。

man.<tool>.cmd

man.viewer 構成変数で指定されたmanビューアがサポートされているものに含まれていない場合、対応する man.<tool>.cmd 構成変数が検索されます。 この変数が存在する場合、指定されたツールはカスタムコマンドとして扱われ、シェルのevalを使用して、引数として渡されたマニュアルページを使用してコマンドを実行します。

Note about konqueror

man.viewer 構成変数で konqueror が指定されている場合、可能であれば、 kfmclient を起動して、既に開いているkonquerorのmanページを新しいタブで開こうとします。

一貫性を保つために、 man.konqueror.path が A_PATH_TO/konqueror のようなものに設定されている場合にも、このようなトリックを試します。 つまり、代わりに A_PATH_TO/kfmclient を起動しようとします。

あなたが本当に konqueror を使用したい場合は、以下のようなものを使用できます:

        [man]
                viewer = konq

        [man "konq"]
                cmd = A_PATH_TO/konqueror

Note about git config --global

注意: これらの構成変数はすべて、たとえば以下のように、 --global フラグを使用して設定する必要があることに注意してください:

$ git config --global help.format web
$ git config --global web.browser firefox

それらは、おそらくリポジトリ固有というよりはユーザー固有であるためです。 詳細については、 git-config(1) を参照してください。

GIT

Part of the git(1) suite