Руководство (MAN)

Как уже отмечалось, аккуратная документация - непременная составная часть проективной системы. Чтобы по всякому поводу не приниматься изучать систему целиком, надо предусмотреть средство ограничения контекста, позволяющее выбирать документацию по теме. Выходит, что документацией по какой-нибудь утилите не могут служить, скажем, технические замечания, Changelog (он же Whats new) и даже README, включаемые в исходные тексты данной утилиты. Это, условно говоря, документация для программистов (точнее - для тех, кто будет улучшать или исправлять саму утилиту). Нас же интересует документация для пользователей (т. е. для тех, кому утилита понадобится в работе).

Исторически первая, главная и наиболее сбалансированная система документации в UNIX® называется "страницы руководства" (manual pages), или, для краткости "руководства" (manuals). Страницы руководства появились уже в первой версии UNIX®.

Средством просмотра страниц руководства служит утилита man. Самый простой способ ею воспользоваться - написать что-нибудь в командной строке man. Например, команда man man выдаст руководство по самой этой утилите, которое можно просмотреть постранично, перелистывая страницы клавишей "пробел". Если вы пользуетесь каким-нибудь инструментом UNIX®, но еще не читали его руководства, прочитайте непременно! Хотя бы для того, чтобы иметь представление обо всех его возможностях. Руководства есть не только у каждой утилиты системы, но и у многих других объектов. Информационная подсистема должна давать достаточно сведений для самостоятельного решения любых принципиально разрешимых задач, а значит, описания нужны и структурам данных, и средствам интеграции, и простейшим приемам работы с системой. Все страницы руководства отнесены к восьми разделам:

1. пользовательские утилиты и прочие инструменты;

2. системные вызовы;

3. библиотечные вызовы (функции);

4. внешние устройства (и их представление в системе);

5. форматы и таблицы (типы файлов, протоколы и пр.);

6. игры и всевозможные "ненужные" утилиты (например, fortune);

7. прочее, т. е. то, что не подходит под другие разделы;

8. команды и инструменты системного администратора.

В некоторых версиях UNIX® добавляется девятый раздел, посвященный структуре ядра системы. Если у кого-то возникнет желание исправить или развить ядро, самую ответственную часть любой системы, ему будет где искать помощи.

Все грамотно написанные страницы руководства состоят из нескольких полей, названия которых во всех руководствах одинаковы, но не обязательно все поля должны присутствовать в одном руководстве. Названия полей располагаются в начале строки (остальной текст идет с отступом) и выделяются повышенной яркостью. В каждом поле объект, которому посвящено руководство, рассматривается с определенной точки зрения.