Справочная система

6.1 Страница справки: man

Запоминать все ключи всех команд не нужно. В Linux описание каждой программы устанавливается вместе с ней и открывается командой man (manual — «руководство»). Справка работает без интернета и описывает ту версию программы, которая установлена в системе. На прошлом занятии мы уже открывали страницу man hier с описанием каталогов.

Страница открывается на весь терминал в программе просмотра less. Структура у всех страниц одинаковая, поэтому нужный раздел быстро находится на любой из них.

Запись ls [OPTION]... [FILE]... в разделе SYNOPSIS читается так: команда ls, затем любое число ключей, затем любое число файлов, причём и ключи, и файлы можно не указывать. У каждого ключа на странице есть описание; многие ключи записываются в двух видах — коротком (-a) и длинном (--all), оба действуют одинаково.

12345

1. 1имя страницы и номер раздела: 1 — команды пользователя
2. 2NAME — назначение команды одной строкой
3. 3SYNOPSIS — запись команды; квадратные скобки — необязательные части
4. 4DESCRIPTION — описание и список ключей
5. 5короткий и длинный вариант одного ключа

Весь снимок ↗

Начало страницы справки команды ls.

Что показывает снимок. Страница справки ls начинается с разделов NAME, SYNOPSIS и DESCRIPTION; у ключей есть короткая и длинная запись.

Где это пригодится. Прежде чем искать ответ в интернете, открывают man: там описана установленная версия программы.

1

1. 1имя страницы и номер строки; h — список клавиш, q — выход

Весь снимок ↗

Строка состояния внизу страницы.

Что показывает снимок. Строка состояния показывает имя страницы и номер строки, а также напоминает клавиши h и q.

Где это пригодится. Если справка открылась и терминал не реагирует на команды, это страница просмотра: из неё выходят клавишей q.

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

Страница ls занимает больше двухсот строк, и листать её ради одного ключа долго. Вместо этого используют поиск: клавиша /, затем образец и Enter. Программа прокручивает страницу к первому совпадению и подсвечивает его, клавиша n переходит к следующему совпадению.

Искать удобнее по действию, которое нужно выполнить. Например, нужен ключ, который сортирует файлы по размеру. Образец sort by file size сразу приводит к строке с ключом -S. Строка состояния внизу экрана показывает номер строки и долю пройденной страницы: line 141/226 73%.

123

1. 1найденный ключ -S
2. 2подсвечено совпадение с образцом поиска
3. 3длинный ключ --sort задаёт тот же порядок словом size

Весь снимок ↗

Поиск по странице привёл к ключу -S; внизу строка состояния с номером строки.

Что показывает снимок. Поиск по образцу sort by file size привёл к ключу -S, найденные слова подсвечены.

Где это пригодится. Поиск по описанию действия быстрее, чем чтение страницы целиком: так находят ключи у find, cp, tar и других команд.

6.3 Разделы справки

Страницы справки разделены на пронумерованные разделы. Одно имя может встречаться в нескольких разделах: passwd — это и команда смены пароля (раздел 1), и формат файла /etc/passwd (раздел 5). Номер раздела пишут в скобках после имени: passwd(5).

man имя открывает страницу из первого раздела, где она нашлась. Чтобы открыть конкретный раздел, его номер указывают перед именем: man 5 passwd. Ключ -f показывает, в каких разделах есть страница с таким именем. Ключ -k ищет образец в кратких описаниях всех страниц: он помогает, когда имя команды неизвестно, а действие известно, например «copy files».

Для встроенных команд оболочки отдельных страниц нет: на man cd система отвечает No manual entry for cd. Описание встроенных команд выводит встроенная команда help.

123

1. 1номер раздела: 1 — команда passwd, 5 — формат файла /etc/passwd
2. 2man -k ищет по описаниям страниц
3. 3у встроенной команды cd нет страницы man

Весь снимок ↗

Одно имя в разных разделах справки и поиск по описаниям.

Что показывает снимок. У имени passwd три страницы в разных разделах; man -k нашёл команду cp по описанию; для cd страницы нет.

Где это пригодится. man -k помогает найти команду, когда известно только действие. Сообщение No manual entry — повод проверить имя командой type.

Страница man 5 passwd описывает формат файла учётных записей: одна строка на пользователя и семь полей через двоеточие. Этот файл мы читали на прошлом занятии командой getent passwd.

123

1. 1раздел 5 — «File Formats and Configuration»
2. 2одна строка на учётную запись, семь полей
3. 3поля по порядку: имя, пароль, UID, GID, комментарий, домашний каталог, оболочка

Весь снимок ↗

Страница раздела 5: формат файла /etc/passwd.

Что показывает снимок. Раздел 5 описывает формат файла /etc/passwd: одна строка на учётную запись и семь полей через двоеточие.

Где это пригодится. Перед ручной правкой любого конфигурационного файла читают его страницу в разделе 5: man 5 fstab, man 5 crontab.

6.4 Краткая справка: --help и help

Страница man подробная, но иногда нужно только вспомнить написание ключа. Большинство программ выводят краткую справку при запуске с ключом --help: список ключей и описание каждого в одну строку. Вывод длинный, поэтому его ограничивают командой head или листают, передав в less: ls --help | less.

Справку по встроенным командам оболочки — cd, type, history — выводит встроенная команда help. Какой справкой пользоваться, подсказывает type: если имя — файл программы, читают --help и man; если имя — встроенная команда, читают help.

1234

1. 1--help выводит справку прямо в терминал
2. 2ключ и его описание в одной строке
3. 3help выводит справку по встроенной команде cd
4. 4help тоже встроена в оболочку

Весь снимок ↗

Краткая справка программы и справка встроенной команды.

Что показывает снимок. ls --help вывел краткую справку в терминал, help cd — справку по встроенной команде; type подтвердил, что help встроена в оболочку.

Где это пригодится. Краткую справку открывают, когда нужно только вспомнить написание ключа. Для встроенных команд cd, history, type справку выводит help.