View source for Man page (Русский)

[[Category:System administration (Русский)]]
[[Category:Русский]]
[[ar:Man Page]]
[[en:man page]]
[[ko:Man Page]]
[[zh-CN:Man Page]]
{{Lowercase title}}

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

Man-страницы изначально подразумевались как самодостаточные документы. Они ограничены в возможностях ссылаться друг на друга, в отличие от поддерживающих гиперссылки [[Wikipedia:Info_(Unix)|info-файлов]] — попытки GNU создать замену традиционному формату man-страниц.

== Доступ к man-страницам ==
Чтобы отобразить man-страницу, наберите

 $ man ''имя_страницы''

Все страницы разделены на несколько категорий:
# Основные команды
# Системные вызовы (функции, предоставляемые ядром linux)
# Библиотечные вызовы (функции стандартной библиотеки языка Си)
# Специальные файлы (обычно расположенные в {{Ic|/dev}}) и драйверы
# Форматы файлов и соглашения
# Игры
# Прочие страницы (также включая соглашения)
# Команды для системного администрирования (для которых обычно требуются права суперпользователя) и демоны

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

 $ man 5 passwd

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

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

 $ whatis ls

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

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

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

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


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

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

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

 # mandb

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

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

 $ man -k password

или

 $ man --apropos password

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

 $ apropos password

По-умолчанию, ключевое слово интерпретируется как [[Wikipedia:ru:Регулярные выражения|регулярное выражение]].

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

 $ man -K password

== Цветные man-страницы ==
Текст man-страниц может отображаться в разных цветах, что упрощает их чтение. Есть два основных метода, позволяющих раскрасить страницы — с помощью утилит ''less'' и ''most''.

=== С помощью less (рекомендуется) ===

Преимущество этого способа в том, что less имеет более богатый набор возможностей, чем most, а также используется по умолчанию для отображения man-страниц.

Добавьте следующие строки в файл конфигурации вашей командной оболочки (для [[Bash]] это файл {{ic|~/.bashrc}}):

 man() {
     env LESS_TERMCAP_mb=$'\E[01;31m' \
     LESS_TERMCAP_md=$'\E[01;38;5;74m' \
     LESS_TERMCAP_me=$'\E[0m' \
     LESS_TERMCAP_se=$'\E[0m' \
     LESS_TERMCAP_so=$'\E[38;5;246m' \
     LESS_TERMCAP_ue=$'\E[0m' \
     LESS_TERMCAP_us=$'\E[04;38;5;146m' \
     man "$@"
 }

Выполните команды из файла, чтобы увидеть изменения:

 # source ~/.bashrc

Чтобы изменить эти цвета, обратитесь к статье [[Wikipedia:ru:Управляющие последовательности ANSI|Управляющие последовательности ANSI]].

Смотрите также статью [http://linuxtidbits.wordpress.com/2009/03/23/less-colors-for-man-pages/ цветные man-страницы с less].

=== С помощью most (не рекомендуется) ===

Утилита most выполняет ту же задачу, что less и ''more'', но имеет меньший набор возможностей. Настройка цветов для most проще, однако требуется дополнительная настройка для того, чтобы most работал наподобие less.

[[pacman (Русский)#Установка определенных пакетов|Установите]] пакет {{Pkg|most}}, доступный в [[Official repositories (Русский)|официальных репозиториях]].

В файле {{ic|/etc/man_db.conf}} раскомментируйте параметр {{ic|pager}} и установите ему значение {{ic|most -s}}:

 DEFINE     pager     most -s

Откройте любую man-страницу для проверки.

Настройка цветов осуществляется в пользовательском файле {{ic|~/.mostrc}} (нужно создать, если он отсутствует), либо в системном файле {{ic|/etc/most.conf}}. Пример конфигурации:

 % Color settings
 color normal lightgray black
 color status yellow blue
 color underline yellow black
 color overstrike brightblue black

Другой пример, показывающий, как настроить сочетания клавиш, подобно {{Ic|less}} (переход к строке назначен на клавишу {{ic|J}}):

 % less-like keybindings
 unsetkey "^K"
 unsetkey "g"
 unsetkey "G"
 unsetkey ":"
 
 setkey next_file ":n"
 setkey find_file ":e"
 setkey next_file ":p"
 setkey toggle_options ":o"
 setkey toggle_case ":c"
 setkey delete_file ":d"
 setkey exit ":q"
 
 setkey bob "g"
 setkey eob "G"
 setkey down "e"
 setkey down "E"
 setkey down "j"
 setkey down "^N"
 setkey up "y"
 setkey up "^Y"
 setkey up "k"
 setkey up "^P"
 setkey up "^K"
 setkey page_down "f"
 setkey page_down "^F"
 setkey page_up "b"
 setkey page_up "^B"
 setkey other_window "z"
 setkey other_window "w"
 setkey search_backward "?"
 setkey bob "p"
 setkey goto_mark "'"
 setkey find_file "E"
 setkey edit "v"

=== Цветные страницы в xterm или rxvt-unicode ===

Быстрый способ раскрасить цвета man-страниц, которые просматриваются через {{Pkg|xterm}} / {{Ic|uxterm}} или {{Pkg|rxvt-unicode}}, заключается в редактировании файла {{ic|~/.Xresources}}.

В подразделах представлена конфигурация для xterm и rxvt-unicode.

==== xterm ====

 *VT100.colorBDMode:     true
 *VT100.colorBD:         red
 *VT100.colorULMode:     true
 *VT100.colorUL:         cyan

Эти настройки заменяют начертания текста цветами. Добавьте также:

 *VT100.veryBoldColors: 6

если вы хотите видеть цвета и начертания одновременно. Смотрите также {{ic|man xterm}} для описания ресурса терминала {{ic|veryBoldColors}}.

==== rxvt-unicode ====

Конфигурация:

 URxvt.colorIT:      #87af5f
 URxvt.colorBD:      #d7d7d7
 URxvt.colorUL:      #87afd7

После внесения изменений в файл, выполните:
 $ xrdb -load ~/.Xresources

Запустите {{Ic|xterm}}/{{Ic|uxterm}} или {{Ic|rxvt-unicode}} и вы должны увидеть цветные man-страницы. Эти настройки добавляют цвета для слов, написанных '''полужирным''' и <u>подчеркнутым</u> шрифтом в {{Ic|xterm/uxterm}}, и цвета для слов в '''полужирном''', <u>подчеркнутом</u>, и ''наклонном'' начертаниях в {{Ic|rxvt-unicode}}. Вы можете также совмещать эти атрибуты в различные комбинации.

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

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

 man:<name>

Кроме того, вы можете [[pacman (Русский)#Установка определенных пакетов|установить]] следующие пакеты из [[Official repositories (Русский)|официальных репозиториев]]:

1. {{pkg|xorg-xman}} для просмотра страниц в [[Xorg (Русский)|X]].

2. {{pkg|yelp}} — Help Browser из состава [[GNOME (Русский)|GNOME]].

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

==== mdocml ====

Установите {{AUR|mdocml}} из [[AUR (Русский)|AUR]]. Чтобы конвертировать страницу, для примера {{ic|free(1)}}, наберите:

 $ gunzip -c /usr/share/man/man1/free.1.gz | mandoc -Thtml -Ostyle=style.css 1> free.html

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

==== man2html ====

Установите {{Pkg|man2html}} из [[Official repositories (Русский)|официальных репозиториев]].

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

 $ man free | man2html -compress -cgiurl man$section/$title.$section$subsection.html > ~/man/free.html

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

 $ man free | man2html -bare > ~/free.txt

==== man -H ====

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

 $ man -H free

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

==== roffit ====

Установите {{AUR|roffit}} из [[AUR (Русский)|AUR]].

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

 $ gunzip -c /usr/share/man/man1/free.1.gz | roffit > free.html

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

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

 man -t ''имя_страницы'' | ps2pdf - ''pdf_файл''

По [https://www.google.com/search?q=manpage+pdf+troff&num=100&hl=en&prmd=imvns&source=lnms&tbm=isch&sa=X&ei=5BZpUI3oH6rI2AXvx4CoAw&ved=0CAoQ_AUoAQ&biw=1321&bih=1100 этой ссылке] вы можете посмотреть, как будет выглядеть получившийся PDF-документ.

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

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

{{hc|Usage: manpdf [<section>] <manpage>|<nowiki>
#!/usr/bin/perl
use File::stat;

$pdfdir = $ENV{"HOME"}."/.manpdf";
-d $pdfdir || mkdir $pdfdir || die "can't create $pdfdir";
$manpage = $ARGV[0];
chop($manpath = `man -w $manpage`);
die if $?;

$maninfo = stat($manpath) or die;
$manpath =~ s@.*/man./(.*)(\.(gz|bz2))?$@$1@;
$pdfpath = "$pdfdir/$manpath.pdf";
$pdftime = 0;
if (-f $pdfpath) {
    $pdfinfo = stat($pdfpath) or die;
    $pdftime = $pdfinfo->mtime;
}
if (!-f $pdfpath || $maninfo->mtime > $pdftime) {
    system "man -t $manpage | ps2pdf -dPDFSETTINGS=/screen - $pdfpath";
}
die if !-f $pdfpath;
if (!fork) {
    open(STDOUT, "/dev/null");
    open(STDERR, "/dev/null");
    exec "mupdf", "-r", "96", $pdfpath;
    #exec "acroread", $pdfpath;
}
</nowiki>}}

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

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

* [http://man7.org/linux/man-pages/index.html Man7.org.] Первоисточник страниц для {{pkg|man-pages}}.
* [http://manpages.debian.net/ man-страницы Debian GNU/Linux]
* [http://leaf.dragonflybsd.org/cgi/web-man man-страницы DragonFlyBSD]
* [http://www.freebsd.org/cgi/man.cgi man-страницы FreeBSD Hypertext]
* [http://www.manpages.spotlynx.com/ man-страницы Linux and Solaris 10]
* [http://manpagehelp.net man-страницы Linux/FreeBSD] с комментариями пользователей
* [http://linux.die.net/man/ man-страницы на die.net]
* [http://www.kernel.org/doc/man-pages/ man-страницы на kernel.org]
* [http://netbsd.gw.com/cgi-bin/man-cgi man-страницы NetBSD]
* [http://developer.apple.com/documentation/Darwin/Reference/ManPages/index.html man-страницы Mac OS X]
* [http://unixhelp.ed.ac.uk/alphabetical/index.html man-страницы UNIX]
* [http://www.openbsd.org/cgi-bin/man.cgi man-страницы OpenBSD]
* [http://man.cat-v.org/plan_9/ Руководство Plan 9 — Том 1]
* [http://man.cat-v.org/inferno/ Руководство Inferno — Том 1]
* [http://sfdoccentral.symantec.com/sf/5.0MP3/linux/manpages/index.html man-страницы Storage Foundation]
* [http://www.unix.com/man-page/OpenSolaris/1/man/ man-страницы форума The UNIX and Linux Forums]
* [http://manpages.ubuntu.com/ репозиторий man-страниц Ubuntu]

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

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

* ascii(7)
* boot(7)
* charsets(7)
* chmod(1)
* credentials(7)
* fstab(5)
* hier(7)
* systemd(1)
* locale(1P)(5)(7)
* printf(3)
* proc(5)
* regex(7)
* signal(7)
* term(5)(7)
* termcap(5)
* terminfo(5)
* utf-8(7)

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

 $ man -s 7 -k ".*"

А также страницы, относящиеся непосредственно к Arch Linux:
* archlinux(7)
* mkinitcpio(8)
* pacman(8)
* pacman-key(8)
* pacman.conf(5)

== Смотрите также ==

* [[General recommendations (Русский)|Основные рекомендации]] — Основные рекомендации по Arch Linux.
* [http://wiki.gentoo.org/wiki/Man_page Man page] — статья на Gentoo wiki.