В операционных системах Linux предусмотрена развитая система встроенной документации. Умение самостоятельно находить ответы на вопросы является одним из важнейших навыков, который в сообществе часто описывается правилом RTFM (Read That Fine Manual — необходимость начинать решение любой задачи с изучения документации),.
Источники информации в командной строке можно разделить на несколько основных категорий:
1. Страницы руководства (man)
Основная и самая объемная справочная система в Linux, предоставляющая подробные руководства (manual pages) практически для каждой команды, утилиты или конфигурационного файла,,.
Вызов: man <имя_команды>,.
Структура: Страницы оформлены по стандарту и содержат такие разделы, как NAME (имя и краткое описание), SYNOPSIS (синтаксис вызова и доступные ключи), DESCRIPTION (подробное описание), OPTIONS (описание параметров), FILES (связанные файлы) и SEE ALSO (ссылки на смежные темы),,.
Разделы: Руководства man разделены на 9 нумерованных разделов. Например, 1 — это команды пользователя, 2 — системные вызовы, 5 — форматы конфигурационных файлов, 8 — команды системного администрирования,,. Если имена объектов совпадают, нужный раздел указывается в команде: man 5 passwd или man 8 passwd,.
Навигация: Просмотр осуществляется с помощью программы less (перемещение стрелками или Page Up/Page Down, поиск с помощью /, выход клавишей q),,,.
2. Информационная система info
Более современный и структурированный формат документации проекта GNU. В отличие от линейных страниц man, документы info представляют собой гипертекст в виде дерева, разбитый на узлы (nodes) с меню и ссылками для перехода,,.
Вызов: info <имя_команды>,.
Навигация: Для чтения info используются клавиши n (следующий узел), p (предыдущий узел), u (на уровень вверх), Tab (перемещение по ссылкам), Enter (переход по ссылке) и q (выход),. Такая структура больше напоминает обучающее руководство (tutorial), чем сухой справочник.
3. Быстрая справка (--help и help)
Если полная документация не требуется, можно запросить краткую подсказку прямо в терминале:
Ключ --help (или -h): Большинство утилит поддерживают этот параметр (команда --help). Программа выводит на стандартный экран краткую сводку по синтаксису и основным опциям, не открывая отдельного окна просмотра,,.
Команда help: Используется для получения справки по встроенным командам самой оболочки bash (например, cd, alias, unset), для которых нет отдельных исполняемых файлов и, как следствие, нет своих коротких man-страниц,.
4. Утилиты поиска по справочной системе
Если вы не знаете точного имени команды или хотите найти все связанные документы, используются встроенные базы данных (создаваемые утилитой makewhatis или обновляемые через cron),:
apropos <слово> (или man -k): Ищет указанное ключевое слово в названиях и кратких описаниях всех man-страниц системы. Полезно, если вы знаете задачу, но не помните саму команду,,.
whatis <команда> (или man -f): Выводит однострочное описание указанной команды из базы данных, а также показывает, в каких разделах man есть информация о ней,,.
5. Сопроводительная документация
Если для программы нет документации в man или info, разработчики часто поставляют текстовые файлы (например, README или HOWTO), а также примеры конфигураций. Обычно в Linux они располагаются в системном каталоге /usr/share/doc/,.
Автор: к.п.н., Румянцев Сергей Александрович, доцент Финансового университета при Правительстве РФ; доцент ОЧУВО Международного инновационного университета; Консалтинг, управление разработкой ПО; системный и бизнес анализ; менеджмент; аналитиз данных; управление ИТ. Телефон для связи +79269444818 (мессенджеры)
Короткая ссылка:
В операционных системах Linux предусмотрена развитая система встроенной документации. Умение самостоятельно находить ответы на вопросы является одним из важнейших навыков, который в сообществе часто описывается правилом RTFM (Read That Fine Manual — необходимость начинать решение любой задачи с изучения документации),.
Источники информации в командной строке можно разделить на несколько основных категорий:
1. Страницы руководства (man)
Основная и самая объемная справочная система в Linux, предоставляющая подробные руководства (manual pages) практически для каждой команды, утилиты или конфигурационного файла,,.
Вызов: man <имя_команды>,.
Структура: Страницы оформлены по стандарту и содержат такие разделы, как NAME (имя и краткое описание), SYNOPSIS (синтаксис вызова и доступные ключи), DESCRIPTION (подробное описание), OPTIONS (описание параметров), FILES (связанные файлы) и SEE ALSO (ссылки на смежные темы),,.
Разделы: Руководства man разделены на 9 нумерованных разделов. Например, 1 — это команды пользователя, 2 — системные вызовы, 5 — форматы конфигурационных файлов, 8 — команды системного администрирования,,. Если имена объектов совпадают, нужный раздел указывается в команде: man 5 passwd или man 8 passwd,.
Навигация: Просмотр осуществляется с помощью программы less (перемещение стрелками или Page Up/Page Down, поиск с помощью /, выход клавишей q),,,.
2. Информационная система info
Более современный и структурированный формат документации проекта GNU. В отличие от линейных страниц man, документы info представляют собой гипертекст в виде дерева, разбитый на узлы (nodes) с меню и ссылками для перехода,,.
Вызов: info <имя_команды>,.
Навигация: Для чтения info используются клавиши n (следующий узел), p (предыдущий узел), u (на уровень вверх), Tab (перемещение по ссылкам), Enter (переход по ссылке) и q (выход),. Такая структура больше напоминает обучающее руководство (tutorial), чем сухой справочник.
3. Быстрая справка (--help и help)
Если полная документация не требуется, можно запросить краткую подсказку прямо в терминале:
Ключ --help (или -h): Большинство утилит поддерживают этот параметр (команда --help). Программа выводит на стандартный экран краткую сводку по синтаксису и основным опциям, не открывая отдельного окна просмотра,,.
Команда help: Используется для получения справки по встроенным командам самой оболочки bash (например, cd, alias, unset), для которых нет отдельных исполняемых файлов и, как следствие, нет своих коротких man-страниц,.
4. Утилиты поиска по справочной системе
Если вы не знаете точного имени команды или хотите найти все связанные документы, используются встроенные базы данных (создаваемые утилитой makewhatis или обновляемые через cron),:
apropos <слово> (или man -k): Ищет указанное ключевое слово в названиях и кратких описаниях всех man-страниц системы. Полезно, если вы знаете задачу, но не помните саму команду,,.
whatis <команда> (или man -f): Выводит однострочное описание указанной команды из базы данных, а также показывает, в каких разделах man есть информация о ней,,.
5. Сопроводительная документация
Если для программы нет документации в man или info, разработчики часто поставляют текстовые файлы (например, README или HOWTO), а также примеры конфигураций. Обычно в Linux они располагаются в системном каталоге /usr/share/doc/,.
В операционных системах Linux предусмотрена развитая система встроенной документации. Умение самостоятельно находить ответы на вопросы является одним из важнейших навыков, который в сообществе часто описывается правилом RTFM (Read That Fine Manual — необходимость начинать решение любой задачи с изучения документации),.
Источники информации в командной строке можно разделить на несколько основных категорий:
1. Страницы руководства (man)
Основная и самая объемная справочная система в Linux, предоставляющая подробные руководства (manual pages) практически для каждой команды, утилиты или конфигурационного файла,,.
Вызов: man <имя_команды>,.
Структура: Страницы оформлены по стандарту и содержат такие разделы, как NAME (имя и краткое описание), SYNOPSIS (синтаксис вызова и доступные ключи), DESCRIPTION (подробное описание), OPTIONS (описание параметров), FILES (связанные файлы) и SEE ALSO (ссылки на смежные темы),,.
Разделы: Руководства man разделены на 9 нумерованных разделов. Например, 1 — это команды пользователя, 2 — системные вызовы, 5 — форматы конфигурационных файлов, 8 — команды системного администрирования,,. Если имена объектов совпадают, нужный раздел указывается в команде: man 5 passwd или man 8 passwd,.
Навигация: Просмотр осуществляется с помощью программы less (перемещение стрелками или Page Up/Page Down, поиск с помощью /, выход клавишей q),,,.
2. Информационная система info
Более современный и структурированный формат документации проекта GNU. В отличие от линейных страниц man, документы info представляют собой гипертекст в виде дерева, разбитый на узлы (nodes) с меню и ссылками для перехода,,.
Вызов: info <имя_команды>,.
Навигация: Для чтения info используются клавиши n (следующий узел), p (предыдущий узел), u (на уровень вверх), Tab (перемещение по ссылкам), Enter (переход по ссылке) и q (выход),. Такая структура больше напоминает обучающее руководство (tutorial), чем сухой справочник.
3. Быстрая справка (--help и help)
Если полная документация не требуется, можно запросить краткую подсказку прямо в терминале:
Ключ --help (или -h): Большинство утилит поддерживают этот параметр (команда --help). Программа выводит на стандартный экран краткую сводку по синтаксису и основным опциям, не открывая отдельного окна просмотра,,.
Команда help: Используется для получения справки по встроенным командам самой оболочки bash (например, cd, alias, unset), для которых нет отдельных исполняемых файлов и, как следствие, нет своих коротких man-страниц,.
4. Утилиты поиска по справочной системе
Если вы не знаете точного имени команды или хотите найти все связанные документы, используются встроенные базы данных (создаваемые утилитой makewhatis или обновляемые через cron),:
apropos <слово> (или man -k): Ищет указанное ключевое слово в названиях и кратких описаниях всех man-страниц системы. Полезно, если вы знаете задачу, но не помните саму команду,,.
whatis <команда> (или man -f): Выводит однострочное описание указанной команды из базы данных, а также показывает, в каких разделах man есть информация о ней,,.
5. Сопроводительная документация
Если для программы нет документации в man или info, разработчики часто поставляют текстовые файлы (например, README или HOWTO), а также примеры конфигураций. Обычно в Linux они располагаются в системном каталоге /usr/share/doc/,.
