日本語 ▾ トピック ▾ 最新バージョン ▾ git-help は 2.43.0 で最終更新されました

名前

git-help - Gitに関するヘルプ情報を表示する

書式

git help [-a|--all] [--[no-]verbose] [--[no-]external-commands] [--[no-]aliases]
git help [[-i|--info] [-m|--man] [-w|--web]] [<command>|<doc>]
git help [-g|--guides]
git help [-c|--config]
git help [--user-interfaces]
git help [--developer-interfaces]

説明

オプションや *<command>* または *<doc>* が指定されていない場合、*git* コマンドの書式と、最も一般的に使用されるGitコマンドのリストが標準出力に表示されます。

`--all` または `-a` オプションが指定された場合、利用可能なすべてのコマンドが標準出力に表示されます。

`--guides` または `-g` オプションが指定された場合、Gitの概念ガイドのリストも標準出力に表示されます。

コマンドまたはその他のドキュメントが指定された場合、関連するマニュアルページが表示されます。デフォルトでは *man* プログラムが使用されますが、これは他のオプションや設定変数によって上書きできます。

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

`git --help ...` は内部的に `git help ...` に変換されるため、両者は同一であることに注意してください。

git[1] の man ページを表示するには、`git help git` を使用します。

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

オプション

-a
--all

利用可能なすべてのコマンドを標準出力に表示します。

--no-external-commands

`--all` と組み合わせて使用すると、`$PATH` 内で見つかった外部の「git-*」コマンドのリスト表示を除外します。

--no-aliases

`--all` と組み合わせて使用すると、設定されたエイリアスのリスト表示を除外します。

--verbose

`--all` と組み合わせて使用すると、認識されているすべてのコマンドの説明を表示します。これはデフォルトです。

-c
--config

利用可能なすべての設定変数を一覧表示します。git-config[1] のリストの短い要約です。

-g
--guides

Git の概念ガイドのリストを標準出力に表示します。

--user-interfaces

リポジトリ、コマンド、およびファイルインターフェースのドキュメントのリストを標準出力に表示します。

`.git/info/exclude` などのリポジトリ内ファイルインターフェース (詳細は gitrepository-layout[5] を参照) や、`.mailmap` などのツリー内設定 (詳細は gitmailmap[5] を参照) もここに文書化されています。

このドキュメントのセクションでは、一般的または広範なユーザーインターフェースの慣習 (例: gitcli[7]) や、githooks[5] で説明されているファイルベースの `.git/hooks/*` インターフェースなどの擬似設定についても説明しています。

--developer-interfaces

ファイル形式、プロトコル、およびその他の開発者インターフェースのドキュメントのリストを標準出力に表示します。

-i
--info

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

-m
--man

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

デフォルトでは *man* プログラムがマニュアルページの表示に使用されますが、`man.viewer` 設定変数を使用して他の表示プログラムを選択できます (以下を参照)。

-w
--web

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

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

設定変数

help.format

コマンドラインオプションが渡されない場合、`help.format` 設定変数がチェックされます。この変数には以下の値がサポートされており、対応するコマンドラインオプションと同じように *git help* を動作させます。

  • "man" は *`-m|--man`* に対応し、

  • "info" は *`-i|--info`* に対応し、

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

help.browser, web.browser, and browser.<tool>.path

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

man.viewer

*man* 形式が選択された場合、`man.viewer` 設定変数がチェックされます。現在サポートされている値は以下の通りです。

  • "man": 通常通り *man* プログラムを使用する、

  • "woman": *emacsclient* を使用してemacsで「woman」モードを起動する (これはemacsclientバージョン22以降でしか動作しません)、

  • "konqueror": *kfmclient* を使用してkonquerorの新しいタブでmanページを開く (以下の *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 が使用されて、manページを引数としてコマンドが実行されます。

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

git config --global に関する注意

これらの設定変数は、おそらく `--global` フラグを使用して設定されるべきであることに注意してください。例えば、以下のようにです。

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

これらはリポジトリ固有というよりは、ユーザー固有のものである可能性が高いからです。これに関する詳細については git-config[1] を参照してください。

GIT

git[1] スイートの一部

scroll-to-top