All linux man pages

man page (Русский)

man-страницы (от англ. manual — руководство) — справочные страницы, которые предоставляются почти всеми *nix-дистрибутивами, включая Arch Linux. Для их отображения служит команда man .

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

Contents

Доступ к man-страницам

Чтобы отобразить man-страницу, наберите

Все страницы разделены на несколько категорий:

1. Основные команды
2. Системные вызовы (функции, предоставляемые ядром linux)
3. Библиотечные вызовы (функции стандартной библиотеки языка Си)
4. Специальные файлы (обычно расположенные в /dev ) и драйверы
5. Форматы файлов и соглашения
6. Игры
7. Прочие страницы (также включая соглашения)
8. Команды для системного администрирования (для которых обычно требуются права суперпользователя) и демоны

На man-страницы принято ссылаться по имени, с указанием номера категории в скобках. Часто существуют сразу несколько man-страниц с одинаковыми именами, но в разных категориях, например man(1) и man(7). В таком случае, команде man необходимо передать номер конкретной категории перед именем man-страницы, например:

отобразит man-страницу по файлу /etc/passwd вместо утилиты passwd .

Вместо того, чтобы отображать man-страницу целиком, вы можете вывести лишь ее краткое описание, используя команду whatis . Например,

выведет краткое описание команды ls: «list directory contents» («отобразить содержимое каталога»).

Формат страниц

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

• NAME — имя команды и краткое однострочное описание ее назначения.
• SYNOPSIS — список опций и аргументов командной строки, которые принимает команда, либо параметры функции и ее заголовочный файл.
• DESCRIPTION — более подробное описание назначения и принципов работы команды или функции.
• EXAMPLES — типовые примеры использования, обычно от самых простых к более сложным.
• OPTIONS — описания для каждой из опций, которые принимает команда.
• EXIT STATUS — коды возврата и их значения.
• FILES — связанные с командой или функцией файлы.
• BUGS — вероятные проблемы, связанные с работой команды или функции и ожидающие решения. Также известны как KNOWN BUGS.
• SEE ALSO — список связанных команд и функций.
• AUTHOR, HISTORY, COPYRIGHT, LICENSE, WARRANTY — информация о программе: ее история, условия использования, создатели программы.

Поиск по страницам

Хотя команда man позволяет отображать man-страницы, возникает сложность, когда вы не знаете точного названия желаемой страницы. К счастью, вы можете воспользоваться опциями -k или —apropos , для поиска по ключевому слову в описаниях man-страниц.

Поиск работает только по индексированным страницам. Кеш индекса может устареть или вовсе отсутствовать, и на попытки поиска вы не будете получать ожидаемых результатов. Вы можете создать индекс или обновить его, выполнив

Индексация страниц должна запускаться при каждом добавлении man-страниц.

Теперь вы можете воспользоваться поиском. Например, чтобы найти man-страницы, связанные с паролями («password»), введите:

С тем же успехом, вы также можете воспользоваться командой apropos :

По-умолчанию, ключевое слово интерпретируется как регулярное выражение.

Если вы хотите произвести более углубленный поиск по всему содержимому страниц, используйте опцию -K :

Просмотр локальных страниц

Кроме утилиты man, для чтения man-страниц вы также можете использовать веб-браузер, например lynx или Firefox. Просмотр страниц в браузере позволяет воспользоваться основным преимуществом info-страниц — гиперссылками. Пользователи KDE могут читать man-страницы в Konqueror, используя URL вида:

Кроме того, вы можете установить следующие пакеты из официальных репозиториев:

1. xorg-xman для просмотра страниц в X.

2. yelp — Help Browser из состава GNOME.

Конвертирование страниц в HTML

mandoc

Установите пакет mandoc . Чтобы конвертировать страницу, для примера, free(1) , наберите:

Получившийся файл free.html теперь можно открыть в любом веб-браузере.

man2html

Сконвертируйте страницу командой:

Другая полезная функция man2html — экспорт в обычный текстовый файл, который можно распечатать:

man -H

Реализация утилиты man от GNU, также позволяет открыть страницу в веб-браузере:

Команда запустит браузер, установленный в переменной окружения BROWSER . Вы можете указать браузер явно, передав путь до исполняемого файла сразу после опции -H .

roffit

Для конвертирования страницы выполните:

Конвертирование в PDF

Man-страницы всегда были удобны для печати: они написаны в формате troff, который является типографским языком. Если у вас установлен ghostscript, конвертирование man-страниц в PDF выполнить очень просто:

По этой ссылке вы можете посмотреть, как будет выглядеть получившийся PDF-документ.

Обратите внимание, что шрифты главным образом ограничены набором Times и имеют жестко заданные размеры. Документ не будет содержать гиперссылок. Некоторые man-страницы форматировались так, чтобы выглядеть хорошо в терминале, однако могут отображаться некорректно в форме PostScript или PDF-документов.

Следующий perl-скрипт конвертирует man-страницы в PDF, кэшируя файлы в каталоге $HOME/.manpdf/ , и открывает программу для просмотра документа mupdf .

Просмотр онлайн-страниц

Существуют множество онлайн-хранилищ man-страниц; вот небольшой список:

Полезные страницы

Здесь приведен небольшой список полезных man-страниц, которые могут помочь вам получить более углубленные знания о множестве полезных вещей. Некоторые из них могут служить хорошими справочниками (например, таблица ASCII).

Вам могут быть интересны также и другие страницы седьмой категории:

А также страницы, относящиеся непосредственно к Arch Linux:

Источник

man page

man pages—abbreviation for «manual pages»—are the form of documentation that is available on almost all UNIX-like operating systems, including Arch Linux. The command used to display them is man .

In spite of their scope, man pages are designed to be self-contained documents, consequentially limiting themselves to referring to other man pages when discussing related subjects. This is in sharp contrast with the hyperlink-aware Info documents, GNU’s attempt at replacing the traditional man page format.

Contents

Installation

man-db implements man on Arch Linux, and less is the default pager used with man. mandoc can also be used.

man-pages provides the Linux man pages.

Some localized man pages are also available:

You can use some applications to view man pages:

• GNOME Help — Help viewer for GNOME. It can show man pages via yelp man: or the undocumented Ctrl+L keybinding from an existing window.

https://wiki.gnome.org/Apps/Yelp || yelp

• KHelpCenter — Application to show KDE Applications’ documentation. Man pages are in UNIX manual pages or by running khelpcenter man: .

https://userbase.kde.org/KHelpCenter || khelpcenter

• Konqueror — KDE file manager and web browser. It can show man pages via man: .

https://konqueror.org/ || konqueror

• xman — Provides a categorized look at man pages.

https://xorg.freedesktop.org/ || xorg-xman

Accessing man pages

To read a man page, simply enter:

Manuals are sorted into several sections. For a full listing see the section entitled «Sections of the manual pages» in man-pages(7) .

Man pages are usually referred to by their name, followed by their section number in parentheses. Often there are multiple man pages of the same name, such as man(1) and man(7) . In this case, give man the section number followed by the name of the man page, for example:

to read the man page on /etc/passwd , rather than the passwd utility.

Or equivalently, the man page followed by the section number, separated by a period:

Searching manuals

Man pages can be searched when the exact name of a page is not known using any of the following equivalent commands:

expression is interpreted as a regular expression by default.

To search for keywords in whole page texts, use the -K option instead.

One-line descriptions of man pages can be displayed using the whatis command. For example, for a brief description of the man page sections about ls , type:

Page width

The man page width is controlled by the MANWIDTH environment variable.

If the number of columns in the terminal is too small (e.g. the window width is narrow), the line breaks will be wrong. This can be very disturbing for reading. You can fix this by setting the MANWIDTH on man invocation. With Bash , that would be:

Reading local man pages

Instead of the standard interface, using browsers such as lynx and Firefox to view man pages allows users to reap info pages’ main benefit of hyperlinked text. Alternatives include the following:

Conversion to HTML

mandoc

Install the mandoc package. To convert a page, for example free(1) :

Now open the file called free.html in your favourite browser.

man2html

First, install man2html from the official repositories.

Now, convert a man page:

Another use for man2html is exporting to raw, printer-friendly text:

man -H

The man-db implementation also has the ability to do this on its own:

This will read your BROWSER environment variable to determine the browser. You can override this by passing the binary to the -H option.

roffit

To convert a man page:

Conversion to PDF

man pages have always been printable: they are written in troff(1) , which is fundamentally a typesetting language. Therefore, you can easily convert man pages to any of the formats supported as output devices by groff, which is used by man-db . For a list of output devices, see the -T option in groff(1) (or mandoc(1) if you use the mandoc package).

This will produce a PDF file:

Caveats: Fonts are generally limited to Times at hardcoded sizes. Some man pages were specifically designed for terminal viewing, and will not look right in PS or PDF form.

Online man pages

There are several online databases of man pages, including:

Noteworthy man pages

Here follows a non-exhaustive list of noteworthy pages that might help you understand a lot of things more in-depth. Some of them might serve as a good reference (like the ASCII table).

Источник

Man-страницы в Linux. Как пользоваться. Установка

При работе в Linux иногда требуется чтение документации, руководств или help’ов. В Linux есть отличная документация, которая размещена в Man-страницах.

Что такое Man-страницы

Man-страницы (от слова manual — руководство) — это целая библиотека в системе Linux, содержащая руководства по командам, утилитам, программированию и другим областям системы и не только.

Как открыть Man-страницы

Для чтения Man-страниц предназначена команда man .

Чтобы получить руководство по использованию какой-либо команды нужно выполнить команду:

Например, чтобы вывести руководство по команде wget, нужно выполнить команду:

Синтаксис команды man

В общем виде синтаксис команды man следующий:

Разделы

Man-страницы разделены по тематикам на разделы (на секции). Каждый раздел имеет свой номер. Всего существует 8 основных разделов.

Если вы не указали раздел, при выполнении команды man , то сначала будет выполнен поиск руководства в первом разделе, если его там нет, то во втором и так далее.

Например, откроем руководство по команде sleep. В данном случае будет использоваться первый раздел.

А теперь получим справку по библиотечному вызову sleep языка программирования C (раздел 3):

Ниже представлена таблица с номерами разделов и их назначением (тематикой).

Номер раздела	Описание
1	Основные команды.
2	Системные вызовы.
3	Библиотечные функции, включая стандартную библиотеку языка C.
4	Специальные файлы (обычно устройства из /dev ) и драйвера.
5	Форматы файлов и соглашения.
6	Игры и скринсейверы.
7	Разное.
8	Команды системного администрирования и демоны.

Для указания ссылок на Man-страницы часто используют следующую запись: имя(раздел) . Например, aporopos(1) , less(1) , exit(3) .

Поиск Man-страниц

Самая полезная опция команды man , это опция -k .

-k — поиск Man-страниц. Выводит список Man-страниц, в которых встречается искомый запрос.

Горячие клавиши и поиск внутри Man-страницы

Вверх , Вниз , Enter — просмотр (прокрутка) Man-страницы.
PgUb , PgDn , Пробел — постраничное пролистывание.

/ — поиск внутри страницы. Нажимаете клавишу / , при этом внизу появляется строка для ввода текста. Вводите текст, который вы хотите найти, и нажимаете Enter .
? — поиск в обратном направлении (снизу вверх). Аналогично нужно ввести текст для поиска и нажать Enter .
n — переход к следующему вхождению.
Shift+n — переход к предыдущему вхождению.
& — поиск внутри страницы, но вместо подсвечивания результатов, вывести только строки, где было найдено искомое слово.

h — открыть справку по командам и горячим клавишам. Чтобы закрыть справку, используется клавиша q .

q — закрыть Man-страницу.

Установка Man-страниц

Как правило, базовые man-страницы обычно всегда установлены в дистрибутивах Linux, но иногда их нужно устанавливать самостоятельно. Для установки Man-страниц выполните следующие команды.
Для Ubuntu:

Для Fedora, CentOS:

Для установки Man-страниц, содержащих описание библиотечных функций языка программирования C, выполните следующие команды.
Для Ubuntu:

Источник