Использование man и info страниц

В операционной системе НАЙС ОС справочная информация о командах и утилитах доступна через man и info страницы. Эти страницы содержат подробные описания команд, их опций, примеров использования и другую полезную информацию. В этом руководстве мы рассмотрим, как эффективно использовать man и info страницы для получения справочной информации в НАЙС ОС.

Использование man страниц

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

Основные команды для работы с man страницами

  • man [команда] — отображает man страницу для указанной команды.
  • man -k [ключевое слово] — выполняет поиск по ключевому слову в заголовках man страниц.
  • man -f [команда] — отображает краткое описание указанной команды.

Пример использования команды man

man ls

Эта команда отображает man страницу для команды ls.

Пример использования команды man -k

man -k copy

Эта команда выполняет поиск всех команд, связанных с копированием, и отображает их список.

Пример использования команды man -f

man -f ls

Эта команда отображает краткое описание команды ls.

Навигация по man страницам

После открытия man страницы, используйте следующие клавиши для навигации:

  • стрелки вверх/вниз — прокрутка вверх и вниз.
  • Page Up/Page Down — прокрутка на одну страницу вверх и вниз.
  • g — перейти к началу страницы.
  • G — перейти к концу страницы.
  • /[текст] — поиск текста на странице.
  • n — перейти к следующему вхождению найденного текста.
  • q — выйти из man страницы.

Примеры использования man страниц

Рассмотрим несколько примеров использования man страниц для получения справочной информации.

Пример 1: Команда cp

man cp

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

Пример 2: Команда grep

man grep

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

Использование info страниц

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

Основные команды для работы с info страницами

  • info [команда] — отображает info страницу для указанной команды.
  • info — отображает основную страницу info, содержащую оглавление всех доступных info страниц.

Пример использования команды info

info ls

Эта команда отображает info страницу для команды ls.

Навигация по info страницам

После открытия info страницы, используйте следующие клавиши для навигации:

  • стрелки вверх/вниз — прокрутка вверх и вниз.
  • Page Up/Page Down — прокрутка на одну страницу вверх и вниз.
  • Space — прокрутка на одну страницу вниз.
  • Backspace — прокрутка на одну страницу вверх.
  • m — перейти к меню (оглавлению).
  • g — перейти к началу страницы.
  • G — перейти к концу страницы.
  • q — выйти из info страницы.

Примеры использования info страниц

Рассмотрим несколько примеров использования info страниц для получения справочной информации.

Пример 1: Команда coreutils

info coreutils

Эта команда отображает справочную информацию для набора утилит GNU Core Utilities.

Пример 2: Команда bash

info bash

Эта команда отображает справочную информацию для командной оболочки bash.

Поиск информации в man и info страницах

Для быстрого поиска нужной информации в man и info страницах можно использовать встроенные возможности поиска.

Поиск в man страницах

Используйте клавишу / для поиска текста на текущей man странице. Например, чтобы найти слово "example" на странице:

/example

Для перехода к следующему вхождению используйте клавишу n.

Поиск в info страницах

Используйте клавишу s для поиска текста на текущей info странице. Например, чтобы найти слово "example" на странице:

s example

Для перехода к следующему вхождению используйте клавишу s повторно.

Создание собственных man и info страниц

Создание собственных man и info страниц может быть полезным для документирования пользовательских команд и утилит.

Создание man страниц

Для создания man страницы создайте текстовый файл в формате groff, содержащий разделы, такие как NAME, SYNOPSIS, DESCRIPTION и т.д.

Пример man страницы


.TH mycommand 1 "January 2024" "1.0" "My Custom Commands"
.SH NAME
mycommand \- пример пользовательской команды
.SH SYNOPSIS
.B mycommand
[\-h] [\-v]
.SH DESCRIPTION
Более подробное описание команды.
.SH OPTIONS
.TP
.B \-h
Выводит справку.
.TP
.B \-v
Выводит версию.

Установка man страницы

Скопируйте созданный файл в соответствующий каталог man:

sudo cp mycommand.1 /usr/share/man/man1/

Обновите кеш man страниц:

sudo mandb

Создание info страниц

Для создания info страницы создайте текстовый файл в формате Texinfo.

Пример info страницы


\input texinfo
@setfilename mycommand.info
@settitle MyCommand Documentation
@node Top
@chapter Введение
Это пример документации для пользовательской команды.
@node Команда
@chapter Использование команды
@section Синопсис
@example
mycommand [опции]
@end example

Установка info страницы

Скомпилируйте файл Texinfo в формат info:

makeinfo mycommand.texi


Скопируйте созданный файл в соответствующий каталог info:


sudo cp mycommand.info /usr/share/info/

Обновите каталог info страниц:

sudo install-info --info-dir=/usr/share/info /usr/share/info/mycommand.info

Использование man и info страниц в НАЙС ОС позволяет получить подробную справочную информацию о командах и утилитах, а также создать собственную документацию для пользовательских программ. Эти инструменты являются мощным средством для изучения и эффективного использования возможностей системы.