git-help

Имя

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, исключить из списка внешние команды "git-*", найденные в $PATH.

--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]), и псевдо-конфигурацию, например, интерфейс на основе файлов .git/hooks/* , описанный в githooks[5].

--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

Переменные help.browser, web.browser и browser.<tool>.path также будут проверены, если выбран формат web (либо с помощью опции командной строки, либо переменной конфигурации). См. -w|--web в разделе «Опции» выше и git-web--browse[1].

man.viewer

Переменная конфигурации man.viewer будет проверена, если выбран формат man . В настоящее время поддерживаются следующие значения:

"man": использовать программу man как обычно,
"woman": использовать emacsclient для запуска режима "woman" в emacs (это работает только начиная с версий emacsclient 22),
"konqueror": использовать kfmclient для открытия страницы руководства в новой вкладке konqueror (см. Note about konqueror ниже).

Значения для других инструментов могут быть использованы, если есть соответствующая запись конфигурации man.<tool>.cmd (см. ниже).

Переменной конфигурации man.viewer могут быть заданы несколько значений. Соответствующие программы будут проверены в порядке, указанном в файле конфигурации.

Например, эта конфигурация:

        [man]
                viewer = konqueror
                viewer = woman

попытается использовать konqueror в первую очередь. Но это может не сработать (например, если DISPLAY не задан), и в этом случае будет использован режим woman emacs.

Если все попытки окажутся безуспешными или если просмотрщик не настроен, будет проверена программа, указанная в переменной среды GIT_MAN_VIEWER. Если и это не сработает, программа man будет использована.

man.<tool>.path

Вы можете явно указать полный путь к предпочитаемому просмотрщику man, установив переменную конфигурации man.<tool>.path. Например, вы можете настроить абсолютный путь к konqueror, установив man.konqueror.path. В противном случае git help предполагает, что инструмент доступен в PATH.

man.<tool>.cmd

Когда просмотрщик man, указанный переменными конфигурации man.viewer, не входит в список поддерживаемых, тогда будет проверяться соответствующая переменная конфигурации man.<tool>.cmd. Если эта переменная существует, указанный инструмент будет обрабатываться как пользовательская команда, и для её запуска будет использоваться оболочка eval с передачей страницы руководства в качестве аргументов.

Примечание о konqueror

Когда konqueror указан в переменной конфигурации man.viewer, мы запускаем 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].

© 2005–2026 Linus Torvalds and others
Licensed under the GNU General Public License version 2.
https://git-scm.com/docs/git-help