Страницы руководства


Страницы руководства (man pages; man — сокращение от «manual», руководство) — это первичная документация UNIX. Несмотря на то, что они считаются непонятными, трудными для изучения, и говорят даже, что их невозможно читать, они вполне дружелюбны к  пользователям — к особым пользователям. Когда создавались эти страницы, средний системный администратор писал программы на С. В  результате эта документация была написана программистами для  программистов. Пользователь, способный думать как программист, сочтет эти страницы совершенными. Я пробовал думать как программист, но  реального успеха достиг лишь после двух дней непрерывного изучения документации (помогли сильное нервное возбуждение и кофеин). За последние несколько лет упал уровень квалификации, необходимый для системного администрирования. Теперь системному  администратору не обязательно быть программистом. Аналогичная вещь произошла со страницами руководства — читать их стало легче. Страницы  руководства — это не учебник, они объясняют поведение программ, а не как достичь желаемого результата. По существу, они являются первой  линией атаки при изучении работы системы. Пользователь, отправивший письмо в почтовую рассылку, не заглянув в эти страницы  документации, наверняка получит краткий совет — заглянуть именно в них.

Разделы страниц руководства

Руководство по FreeBSD состоит из девяти разделов. Эти разделы  выглядят так:

  1. General commands (Основные команды)
  2. System calls and error numbers (Системные вызовы и коды ошибок)
  3. The С libraries (Библиотеки С)
  4. Devices and device drivers (Устройства и драйверы устройств)
  5. File formats (Форматы файлов)
  6. Game instructions (Инструкции к играм)
  7. Miscellaneous information (Всякая всячина)
  8. System maintenance commands (Команды обслуживания системы)
  9. Kernel system interfaces (Системные интерфейсы ядра)

Каждая страница руководства начинается с названия команды,  которую она описывает, вслед за которым следует номер раздела в круглых скобках, например reboot(8). Когда такое упоминание команды  встречается где-нибудь в документации, это означает, что необходимо  прочитать эту страницу руководства из указанного раздела. Почти  каждая тема имеет ссылку на страницу документации. Например, для просмотра страницы руководства по редактору vi надо ввести  следующую команду:

$ man vi

В ответ система выдаст такую информацию:

Страница начинается с названия команды (vi) и номера раздела (1),  затем следует название команды. Данная страница описывает три  команды: ex, vi и view. Дав команду man ex или man view, вы получите ту же самую страницу.

Навигация по страницам руководства

Вызвав страницу руководства, можно нажатием клавиши пробела или Page Down переместиться на один экран вперед. Если вам не требуется шагать так далеко, воспользуйтесь клавишей Enter или клавишей «стрелка вниз» для перемещения вперед на одну строку. Клавиша В или Page Up переместит вас на один экран назад. Чтобы выполнить  поиск в пределах страницы, нажмите клавишу / и вслед за символом  слэша введите искомое слово. В результате вы переместитесь к первому вхождению слова, и оно будет подсвечено. Последующие нажатия  клавиши N будут перемещать вас к следующим вхождениям этого слова.

Все это сказано в предположении, что вы используете программу  постраничного просмотра по умолчанию — more(1). Если вы пользуетесь другой программой, используйте комбинации клавиш, присущие ей. Разумеется, если вы знаете UNIX достаточно, чтобы использовать  другую программу постраничного просмотра, то вы можете пропустить этот раздел.

Поиск страниц руководства

Начинающие пользователи нередко говорят, что были бы счастливы ознакомиться со страницами руководства, если бы только могли  найти нужные им. Поиск в страницах руководства может выполняться с помощью команд apropos(1) и whatis(1). Команда apropos(1) отыщет все страницы руководства, названия или описания которых включают указанное вами слово. Команда whatis(1) выполнит такой же поиск, но отыщет только те страницы, где указанное слово встречается  целиком. Например, для случая с командой vi можно попробовать  выполнить такой поиск:

$ apropos vi

В общей сложности будет найдено 581 вхождение, что, вероятно,  много больше, чем вам может потребоваться. Большинство из этих  вхождений не имеют никакого отношения к vi(1), просто в названии или в описании этих страниц присутствует комбинация символов vi. Сочетание слов device driver имеют широкое распространение в страницах руководства, поэтому такой результат неудивителен. В подобных  случаях больше пользы может принести команда whatis(1).

$ whatis vi

Здесь было получено всего два результата, и оба имеют явное отношение к vi(1). Иногда поиск с помощью команды apropos(1) дает более  востребованные результаты, чем whatis(1). Поэкспериментируйте с этими  командами, и вы быстро поймете, какие из них когда будут вам полезны.

Номера разделов и страницы руководства

Иногда случается так, что для одного и того же названия команды  имеется несколько страниц в руководстве. Например, в каждом разделе руководства имеется вводная страница, в которой приводится  описание раздела. Чтобы указать, в каком разделе следует искать страницу руководства, указывайте номер раздела сразу вслед за командой man.

$ man 3 intro

Данная команда приведет вас на вводную страницу третьего раздела  руководства. Я рекомендую прочитать все вводные страницы хотя бы  ради того, чтобы вы осознали глубину и широту доступной информации.

Содержимое страниц руководства

Страницы руководства делятся на разделы. Хотя в странице  руководства могут присутствовать практически любые заголовки, некоторые из них являются стандартными. См. mdoc(7) для получения неполного списка и другой информации о стандартах страниц руководства:

  • NAME сообщает имя (или имена) программы или утилиты.  Некоторые программы могут иметь несколько имен, например, текстовый редактор vi(1) имеет также имена ех(1) и view(1).
  • SYNOPSIS приводит перечень возможных ключей командной строки и их аргументы или как выглядит вызов библиотечной функции. Если я уже знаком с программой, но просто не могу вспомнить  допустимые параметры, этого раздела достаточно, чтобы освежить свою память.
  • DESCRIPTION содержит краткое описание программы, библиотеки или функции. Содержимое этого раздела зависит от темы, которую охватывает страница руководства, — страницы о программах, файлах и базовых интерфейсах документируются по-разному.
  • OPTIONS (ключи) параметры командной строки программы и их  воздействие.
  • BUGS (ошибки) описывает известные проблемы, связанные с  программным кодом. Зачастую это позволяет избавиться от многих хлопот. Сколько раз вы бились, решая какую-нибудь задачу,  только чтобы убедиться, что программа не работает так, как можно было ожидать по документации? Цель раздела BUGS — сэкономить ваше время и описать известные ошибки и случаи странного поведения программы.*
  • SEE ALSO (см. также) традиционно является последним разделом.  Надо помнить, что система UNIX подобна языку и компоненты  системы связаны в одно целое. Подобно клейкой ленте, ссылки из  раздела SEE ALSO покажут, как компоненты соединяются в одно целое.

Если в какой-то момент у вас не окажется доступа к страницам  руководства, вы сможете найти их на многих веб-сайтах. Так же как и на основном веб-сайте FreeBSD.

Комментарии запрещены.