Упражнение 12: документация: man, info

Поскольку вы уже попробовали работать с Linux, пришло время представить вам инструменты для работы с онлайн-документацией Linux. Вы уже знаете о man, потому что я просил вас искать информацию с его помощью. Возможно, вы даже читали документацию man. В любом случае, что вам нужно знать о man для эффективного использования?

Во-первых, страницы руководства представляют собой сжатые текстовые файлы со специальными отметками, поэтому программа man знает, как форматировать их для вас. В Debian они находятся в /usr/share/man/. Вы можете просматривать их с помощью zless. Это даже не программа, а скрипт оболочки, который распаковывает файлы и вызывает less.

Далее я приведу примеры использования man и его классификацию:

1. Исполняемые программы или команды оболочки.
2. Системные вызовы (функции, предоставляемые ядром).
3. Вызовы библиотек (функции в программных библиотеках).
4. Специальные файлы (обычно находятся в каталоге /dev).
5. Форматы файлов и соглашения, например /etc/passwd.
6. Игры.
7. Прочее (включая макросы и условности), например man(7), groff(7).
8. Команды системного администрирования (обычно доступны только пользователю root).
9. Примеры внутренних процедур [нестандартно].

Это буквальное значение. Чтобы вызвать соответствующую категорию man, введите её номер, например, man 1. Если вы не понимаете, что означает какая-либо категория, не беспокойтесь, сейчас вам нужны только первая и восьмая категории, которые относятся к установленным программам и работе системных администраторов. Кроме того, вы уже знаете, что такое man(7).

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

• NAME — название программы и краткое описание.
• SYNOPSIS — краткий список доступных опций программы.
• DESCRIPTION — описание программы и объяснение доступных параметров.
• OPTIONS — некоторые страницы руководства продолжают объяснять доступные параметры.
• EXIT STATUS — каждая программа возвращает код, представляющий её успех или неудачу. Здесь объясняется значение этих кодов.
• RETURN VALUE — обычно совпадает с состоянием выхода.
• ERRORS — известные ошибки в программе.
• ENVIRONMENT — переменные среды. Установите их перед вызовом программы.
• FILES — обычно это файлы конфигурации программы.
• VERSIONS — информация об изменениях в программе.
• CONFORMING TO — сведения о совместимости.
• NOTES — автор страницы руководства не знает, где разместить эту информацию.
• BUGS — известные проблемы в программе.
• EXAMPLE — содержит пример вызова программы. Очень полезно!
• AUTHORS — кто написал программу.
• SEE ALSO — связанные страницы руководства.

Теперь перейдём к условностям:

• Жирный текст — отображается точно так, как показано на рисунке.
• Курсивный текст — заменяется соответствующими параметрами. Большая часть этого текста отображается не курсивом, а как подчёркивание.
• [-abc] — любой или все параметры в [] являются необязательными.
• -a|-b — опции, разделённые |, нельзя использовать вместе.
• argument … — параметры повторяются.
• [expression] … — всё выражение в [] повторяется.

Я продемонстрирую это на примере. man less покажет:

Хорошо, это выглядит немного пугающе. Первые четыре строки просты, просто введите то, что показано:

1. less -?
2. less –help
3. less -V
4. less –version

Начиная с пятой строки, мы видим, что курсивный текст действительно отображается как подчёркивание. И это кажется совершенно непонятным. Давайте посмотрим вместе.

5. less [-+]aBcCdeEfFgGiIJKLmMnNqQrRsSuUVwWX~] — это выглядит ещё более пугающим.

Прежде всего, он является необязательным, поскольку все параметры заключены в []. Во-вторых, при указании параметра необходимо начинать с -. Это обязательно. В-третьих, после этого вы можете указать дополнительный модификатор +, который дополнительно объясняется на странице руководства. В-четвёртых, вы можете указать один или несколько параметров команды, показанных здесь в виде последовательности букв. Например, вы можете ввести less -S .bashrc или less –+S .bashrc или less -SG .bashrc .profile или меньше –+SG .bashrc .profile.

6. [-b space] [-h lines] [-j line] [-k keyfile] — просто говоря, вы можете указать любой вариант -b, -h, -j, -k, каждый с параметром пробел, несколько строк, одна строка и файл ключей, которые объясняются на странице руководства.

7. [-{oO} logfile] [-p pattern] [-P prompt] [-t tag] — почти то же самое, что и шестая строка. -{oO} означает, что вы можете указать -o или -O, но не оба одновременно.

8. [-T tagsfile] [-x tab,…] [-y lines] [-[z] lines] — опять же, почти то же самое, что и шестая строка. -x tab,… означает, что вы можете указывать несколько значений после -x, таких как -x9 или -x9,17. -[z] lines означает, что -z является необязательным, и вы можете вводить less -10 вместо less -z10.

9. [-# shift] [+[+]cmd] [- -] [filename]… — это немного загадочнее. +[+]cmd означает, что вы можете ввести less +cmd или less ++ cmd. - - — это просто префикс. [filename]… читает один или несколько, что означает, что вы можете указать несколько файлов при вызове less, например less .bashrc, less .bashrc .profile и другие.

Мы закончили! Не так страшно, правда? Помните, что, поскольку вы используете less для просмотра страницы руководства, чтобы найти значение некоторых параметров, введите /key или &key. Например, чтобы найти смысл -T, введите -/-T.

Сейчас я предоставлю вам список полезных команд man:

• man -k — перечисляет все страницы руководства в системе. Не очень полезно, но вы, возможно, захотите увидеть этот список. Или вы можете подсчитать их, введя man -k | wc.
• man -k [search string] — ищет описание в страницах руководства. Попробуйте это: man -k tty.
• man -wK [search string] — поиск в тексте страниц руководства. Попробуйте это: man –wK tty.

Итак, вот и всё для man. Теперь есть ещё один полезный инструмент документации, info. Список команд следующий:

• info […] — вызов info. Если вы вызываете его без параметров, он приведёт вас к странице индекса.
• , , , позволяют прокручивать текст.
• открывает ссылку под курсором. Ссылки начинаются с *.
• — переход к следующей ссылке в документе.
• u — переход на уровень выше.
• p — переход на предыдущую страницу, как в браузере.
• n — переход на следующую страницу.
• q — закрыть info.

Чтобы использовать vi-опции для запуска info, я надеюсь, вы уже знакомы с ними, введите info -vi-keys. Теперь вы можете использовать j и k для прокрутки.

Дополнительное задание

Введите man man и попробуйте расшифровать раздел SYNOPSIS (описание), который объясняет, как его вызывать. Введите info и h, прочитайте раздел помощи info.