Работа со справкой

Работа со справкой#

В состав пакета с Git входит подробная справочная информация о системе. Информация доступна локально и не требует подключения к сети Интернет. Важно научиться использовать ее для своей пользы.

Note

Техническая документация Git не переведена на русский язык. Дополнительно потребуется знание английского языка для ее понимания.

Git организует документацию, используя следующие внешние инструменты:

  • веб-браузер;

  • справочную систему man;

  • справочную систему info.

Последние два доступны только в текстовом терминале Linux-систем, но не в Windows. В Windows справочные страницы будут открываться в веб-браузере.

Команда git help открывает справочную страницу, ассоциированную с ключевым словом, переданного в качестве аргумента. Ключевым словом может быть название любой команды. Таким образом, команда git help clone отобразит справочную страницу по команде clone.

Note

“Отобразить справочную страницу” – значит открыть html-страницу со справкой в веб-браузере.

На справочные страницы команд Git ссылаются по форме git-<команда>(1): git-clone(1), git-branch(1) и т.д. Число в скобке показывает на тематический раздел документации, в который входит справочная страница. Раздел актуален для справочной системы man в Linux. Число (1) указывает на то, что страница описывает команду, а число (7) (оно появится ниже) – то, что не попадает в предыдущие 6 разделов.

Дополнительно к описаниям команд, в техническую документацию по Git входят инструкции по ее применению. Они также оформлены в виде справочных страниц, список которых выводит на экран команда git help --guides:

bob@pc:~$ git help --guides

The Git concept guides are:
   attributes          Определение атрибутов для путей файлов или каталогов
   cli                 Интерфейс коммандной строки Git и соглашения
   core-tutorial       Учебник по ядру Git для разработчиков
   credentials         Providing usernames and passwords to Git
   cvs-migration       Git для пользователей CVS
   diffcore            Подстройка вывода списка изменений
   everyday            Полезный минимум команд для каждодневного использования Git
   faq                 Frequently asked questions about using Git
   glossary            Глоссарий Git
   hooks               Перехватчики используемые Git
   ignore              Указание специально игнорируемых файлов
   mailmap             Map author/committer names and/or E-Mail addresses
   modules             Определение свойств подмодулей
   namespaces          Пространства имён Git
   remote-helpers      Helper programs to interact with remote repositories
   repository-layout   Содержимое репозитория Git
   revisions           Указание редакций и диапазонов для Git
   submodules          Mounting one repository inside another
   tutorial            Обучающее введение в Git
   tutorial-2          Обучающее введение в Git: часть вторая
   workflows           Обзор рекомендуемых последовательностей выполняемых действий с Git

«git help -a» и «git help -g» выводит список доступных подкоманд
и небольшую справку по понятиям. Смотрите «git help <понятие>»
или «git help <термин>» чтобы узнать больше о конкретной подкоманде
или понятии.
Смотрите «git help git» для получения общего обзора системы.

Среди приведенных выше инструкций новичкам интерес представляет “Обучающее введение в Git”. Связанная с ней справочная страница gittutorial(7) отобразит на экране команда git help tutorial .

Справочная страница git(7) – это заглавная стартовая страница, откуда можно попасть на любую другую по гиперссылкам. Откройте ее командой git help git