日本語 ▾ トピック ▾ 最新バージョン ▾ 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] の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, および browser.<tool>.path

web 形式が選択された場合(コマンドラインオプションまたは設定変数のいずれか)、help.browserweb.browser、および browser.<tool>.path もチェックされます。上記の OPTIONS セクションの -w|--webgit-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 設定変数が検索されます。この変数が存在する場合、指定されたツールはカスタムコマンドとして扱われ、manページが引数として渡されてコマンドを実行するためにシェルevalが使用されます。

Konqueror に関する注意

man.viewer 設定変数で konqueror が指定された場合、可能な限り、すでに開いているkonquerorで新しいタブにmanページを開くために kfmclient を起動します。

一貫性のため、man.konqueror.pathA_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