MAN - Руководство Unix

.MAN вариант №

Файл с расширением .man означает справочную страницу, которая представляет собой руководство пользователя по программированию Unix в форме документации по программному обеспечению. Он используется утилитой Man, включенной в Unix, которая используется для просмотра документации. Документация по программному обеспечению содержит информацию в разделах и на страницах, которые можно получить с помощью утилиты Man из командного терминала, введя команды. Будучи доступной на компьютере в виде электронной копии документации, для доступа к ней не требуется печатная копия или подключение к Интернету.

Unix Manual Man File Format — дополнительная информация

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

Разделы и страницы

Unix man — это системное руководство, где каждый аргумент страницы команды относится к имени программы, утилиты или функции. команда, если предоставлена информация о разделе, будет искать страницу в этом конкретном разделе. Однако поведение по умолчанию заключается в поиске страницы во всех разделах и отображении первой страницы независимо от того, существует ли она в нескольких разделах.

Номера секций

Ниже приводится информация о номерах разделов руководства, за которыми следуют типы страниц, которые они содержат.

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

Пример — Как читать MAN-страницы?

Вот пример того, как получить информацию о команде MkDir с помощью команды Man.

% man mkdir

MKDIR(1)    USER COMMANDS       MKDIR(1)

NAME
   mkdir - make a directory

SYNOPSIS
   mkdir [ -p ] dirname...

DESCRIPTION
   mkdir creates directories. Standard entries,`.',for the
   directory itself, and `..' for its parent, are made automat-
   ically.

   The -p flag allows missing parent directories
   to be created as needed.

   With the exception of the set-gid bit, the
   current umask(2V) setting determines the mode in which
   directories are created. The new directory inherits the set-gid
   bit of the parent directory. Modes may be modified after
   creation by using chmod(1V).

   mkdir requires write permission in the parent directory.

SEE ALSO
   chmod(1V), rm(1), mkdir(2v), umask(2V)