2.1.1. man

Команда man (сокращение от “manual” - руководство, справочник) это традиционная форма интерактивной документации в операционных системах Unix и Linux. Будучи представленными в виде файлов в специальном формате, “man pages” (комп. сленг. “маны”) написаны для огромного числа команд и распространяются вместе с программным обеспечением. При вызове из командной строки man какая-то_команда (обычно) будет показана страница руководства для указанной команды; в нашем примере это была бы воображаемая какая-то_команда.

Как понимаете, количество страниц руководства может увеличиваться очень быстро, что приводит к запутыванию и затруднению работы с ними, даже для опытных пользователей. Поэтому, чтобы избежать этих проблем, страницы сгруппированы по разделам. Эта система существует уже очень давно, настолько давно, что вы часто будете встречать команды, программы и даже библиотечные функции, которые ссылаются на свой раздел страницы руководства.

Например:

Вы можете увидеть ссылку на man(1). Эта цифра означает, что документация по команде “man” находится в 1-м разделе 1 (команды пользователя); вы можете указать, что вам нужна страница по “man” именно из первого раздела с помощью команды man 1 man. Указание раздела полезно в том случае, если существует несколько пунктов с одинаковым именем.

В дополнение к man(1) также ещё существуют команды whatis(1) и apropos(1), целью которых является упрощение поиска информации в системе man.

Команда whatis даёт очень кратное описание системных команд; что-то в духе карманного справочника по командам.

Пример:

% whatis whatis
whatis (1)  - search the whatis database for complete words

Команда apropos используется для поиска страницы, содержащей указанное ключевое слово.

Пример:

% apropos wav
cdda2wav    (1)  - a sampling utility that dumps CD audio data into wav sound files
netwave_cs  (4)  - Xircom Creditcard Netwave device driver
oggdec      (1)  - simple decoder, Ogg Vorbis file to PCM audio file (WAV or RAW)
wavelan     (4)  - AT&T GIS WaveLAN ISA device driver
wavelan_cs  (4)  - AT&T GIS WaveLAN PCMCIA device driver
wvlan_cs    (4)  - Lucent WaveLAN/IEEE 802.11 device driver

Если вы хотите получить дополнительную информацию по этим командам, почтите их собственные страницы руководства ;)

2.1.2. Каталог /usr/doc

Исходные тексты для большинства собранных нами пакетов поставляются с различного рода документацией: файлы README, инструкции по использованию, файлы лицензий и т.п. Все эти документы устанавливаются в каталог /usr/doc. Каждая из программ (обычно) устанавливает свою собственную документацию в таком виде:

/usr/doc/$программа-$версия

Где $программа - это название программы, по которой вы хотите получить информацию, а $версия - (очевидно) соответствующая версия программного пакета, установленного в вашей системе.

Например, чтобы прочитать документацию по команде man(1), вам следует перейти (cd) в каталог:

% cd /usr/doc/man-$версия

Если прочтение соответствующей страницы руководства не дало вам достаточно информации, тогда следущим вашим шагом должно быть посещение каталога /usr/doc.

2.1.3. Документы HOWTO и mini-HOWTO

Истинный дух сообщества Open Source заключается в предоставлении коллекции документов HOWTO/mini-HOWTO. Название этих файлов говорит само за себя (примерный перевод звучит “как сделать...”) - документы и руководства, описывающие как сделать то или иное. Если вы установили коллекцию HOWTO, эти документы будут находиться в каталоге /usr/doc/Linux-HOWTOs, а mini-HOWTO - в /usr/doc/Linux-mini-HOWTOs.

В этот же набор пакетов входит коллекция FAQ, что является акронимом

Эти документы написаны в виде “Вопросов с ответами” (что, собственно, и обозначает аббревиатура - Часто задаваемые вопросы). FAQ'и часто могут оказаться весьма полезным источником для поиска информации, если вы ищете что-то в духе “Как быстро исправить” что-нибудь. Если вы установили FAQ'и во время установки системы, вы найдёте их в каталоге /usr/doc/Linux-FAQs.

Эти файлы стоит прочитать в том случае, если вы не уверены в том, что делать дальше в определённых ситуациях. Они охватывают удивительно широкий диапазон рассматриваемых тем и (довольно часто) очень подробно. Приятного вам чтения!