1.5.1. Интерактивная документация
В дистрибутивы Linux входят >man-страницы с описанием большинства стандартных команд, системных вызовов и стандартных библиотечных функций. Интерактивная документация разбита на разделы, которым присвоены номера. Для программистов наиболее важными являются следующие разделы:
(1) пользовательские команды;
(2) системные вызовы:
(3) стандартные библиотечные функции:
(8) системные/административные команды.
Числа обозначают номера разделов. Для доступа к страницам интерактивной документации применяется команда >man. Она имеет вид >man имя, где имя — название команды или функции. Иногда одно и то же имя встречается в разных разделах. В этом случае номер раздела нужно указать явно, поставив его перед именем. К примеру, так вызывается страница с описанием команды >sleep (находящаяся в первом разделе):
>% man sleep
А следующая команда вызывает страницу с описанием библиотечной функции >sleep():
>% man 3 sleep
Каждая >man-страница содержит однострочное резюме команды или функции. Команда >whatis имя отображает список всех >man-страниц (во всех разделах), связанных с указанным именем. Если не известно точно, описание какой команды или функции требуется, можно выполнить поиск по ключевому слову в строках резюме с помощью команды >man -k ключевое_слово.
Страницы интерактивной документации содержат множество полезной информации и являются первым источником, к которому следует обращаться за помощью. В случае команды >man-страница описывает ее флаги и аргументы, входные и выходные значения, коды ошибок установки по умолчанию и т.п. В случае системного вызова или библиотечной функции описываются параметры и возвращаемые значения, коды ошибок и побочные эффекты, а также указывается, какие файлы заголовков нужно включать в программу при использовании функции.
Система Info содержит гораздо более подробную документацию ко многим базовым компонентам GNU/Linux, а также к ряду других программ. Информационные страницы представляют собой гипертекстовые документы, напоминающие Web-страницы. Для запуска текстовой версии справочной системы Info достаточно ввести >info в командной строке. Появится меню с описанием иерархии документов, установленных в системе. Нажав , можно получить список клавиш, посредством которых осуществляется навигация по документам системы Info.
Среди наиболее полезных документов перечислим следующие:
■ >gcc — описание компилятора >gcc
