Git
英語 ▾ トピック ▾ 最新バージョン ▾ 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 <command> --help` を使用します。

`git --help ...` は `git help ...` と同じです。前者は内部的に後者に変換されるためです。

git[1] マニュアルページを表示するには、`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、および browser.<tool>.path

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

man.viewer

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

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

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

  • "konqueror": *kfmclient* を使用して、新しい konqueror タブでマニュアルページを開きます(以下の *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 ビューアーがサポートされているものの1つではない場合、対応する `man.<tool>.cmd` 設定変数が検索されます。 この変数が存在する場合、指定されたツールはカスタムコマンドとして扱われ、シェル eval が使用されて、マニュアルページを引数として渡してコマンドを実行します。

konqueror についての注記

`man.viewer` 設定変数に *konqueror* が指定されている場合、*kfmclient* を起動して、可能であれば、すでに開いている konqueror で新しいタブにマニュアルページを開こうとします。

一貫性を保つために、*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