Difference between revisions of "Man page (Русский)"

From ArchWiki
Jump to navigation Jump to search
m (Использование локальных man страниц)
Line 11: Line 11:
 
{{Article summary end}}
 
{{Article summary end}}
  
'''Man страницы''' (от англ. manual — руководство) - это обширная документация, предустановленная почти во всех значительных UNIX подобных операционных системах, включая Arch Linux. Для их отображения служит команда {{Codeline|man}}.
+
'''Man страницы''' (от англ. manual — руководство) - это обширная документация, предустановленная почти во всех значительных UNIX подобных операционных системах, включая Arch Linux. Для их отображения служит команда {{ic|man}}.
  
 
Не смотря на свой масштаб, man страницы разработаны как самодостаточные документы и вследствие чего ограничены в возможности ссылаться на другие man страницы во время обсуждения связанных тем. В противоположность гипертекстовым info файлам - попытке GNU заменить формат традиционных man страниц.
 
Не смотря на свой масштаб, man страницы разработаны как самодостаточные документы и вследствие чего ограничены в возможности ссылаться на другие man страницы во время обсуждения связанных тем. В противоположность гипертекстовым info файлам - попытке GNU заменить формат традиционных man страниц.
Line 34: Line 34:
 
  $ man 5 passwd
 
  $ man 5 passwd
  
чтобы прочитать man по {{Codeline|/etc/passwd}}, вместо утилиты {{Codeline|passwd}}.
+
чтобы прочитать man по {{ic|/etc/passwd}}, вместо утилиты {{ic|passwd}}.
  
Очень краткие описание программ можно прочитать из man страниц не выводя из целиком с помощью команды {{Codeline|whatis}}. Например, для краткого описания ls, напечатайте:
+
Очень краткие описание программ можно прочитать из man страниц не выводя из целиком с помощью команды {{ic|whatis}}. Например, для краткого описания ls, напечатайте:
  
 
  $ whatis ls
 
  $ whatis ls
  
и {{Codeline|whatis}} выведет "list directory contents."
+
и {{ic|whatis}} выведет "list directory contents."
  
 
==Формат==
 
==Формат==
Line 57: Line 57:
  
 
==Поиск документации==
 
==Поиск документации==
Хотя утилита {{Codeline|man}} позовляет пользователям проматривать страницы руководств, возникает проблема, когда вы не знаете точного имени желаемой man страницы!
+
Хотя утилита {{ic|man}} позовляет пользователям проматривать страницы руководств, возникает проблема, когда вы не знаете точного имени желаемой man страницы!
К счастью, вы можете воспользоваться опцией {{Codeline|-k}} или {{Codeline|--apropos}} для поиска в кратком описании страницы руководства заданного ключевого слова. Например, чтобы найти страницу относящуюся к "password":
+
К счастью, вы можете воспользоваться опцией {{ic|-k}} или {{ic|--apropos}} для поиска в кратком описании страницы руководства заданного ключевого слова. Например, чтобы найти страницу относящуюся к "password":
  
 
  $ man -k password
 
  $ man -k password
Line 66: Line 66:
 
  $ man --apropos password
 
  $ man --apropos password
  
Это эквивалентно вызову команды {{Codeline|apropos}}:
+
Это эквивалентно вызову команды {{ic|apropos}}:
  
 
  $ apropos password
 
  $ apropos password
Line 77: Line 77:
 
создание комфортных условий для большинства является необходимым.
 
создание комфортных условий для большинства является необходимым.
  
Есть два основных способа получения цвеных man страниц: использование {{Codeline|most}}, или с помощью опций для {{Codeline|less}}. Первый проще в настройках в ущерб дополнительных функций присущих {{Codeline|less}}.
+
Есть два основных способа получения цвеных man страниц: использование {{ic|most}}, или с помощью опций для {{ic|less}}. Первый проще в настройках в ущерб дополнительных функций присущих {{ic|less}}.
  
 
===Первый способ: используя 'most'===
 
===Первый способ: используя 'most'===
 
Установите {{package Official|most}} с помощью [[pacman]]:
 
Установите {{package Official|most}} с помощью [[pacman]]:
 
  # pacman -S most
 
  # pacman -S most
Это программа подобна {{Codeline|less}} и {{Codeline|more}}, а также с легкостью позволяет отображать цветной текст.
+
Это программа подобна {{ic|less}} и {{ic|more}}, а также с легкостью позволяет отображать цветной текст.
  
 
Отредактируйте {{Filename|/etc/man_db.conf}}, раскомментируйте определение просмоторщика из замените его следующим образом:
 
Отредактируйте {{Filename|/etc/man_db.conf}}, раскомментируйте определение просмоторщика из замените его следующим образом:
Line 101: Line 101:
 
  color overstrike brightblue black
 
  color overstrike brightblue black
  
Следующий пример демострирует настройку привязки клавиш схожую с {{Codeline|less}} (перейти на следующую строку установленно для 'J'):
+
Следующий пример демострирует настройку привязки клавиш схожую с {{ic|less}} (перейти на следующую строку установленно для 'J'):
 
  % less-like keybindings
 
  % less-like keybindings
 
  unsetkey "^K"
 
  unsetkey "^K"
Line 142: Line 142:
 
:<small>''Источник: [http://nion.modprobe.de/blog/archives/572-less-colors-for-man-pages.html nion's blog - less colors for man pages]''</small>
 
:<small>''Источник: [http://nion.modprobe.de/blog/archives/572-less-colors-for-man-pages.html nion's blog - less colors for man pages]''</small>
  
В качестве альтернативы, получение приблизительно таких же цветных справочных страниц возможно с помощью {Codeline|less}}. Этот метод имеет то преимущество, что {{Codeline|less}} имеет больший набор функций, чем {{Codeline|most}}, и этот способ может быть предпочтительней для опытных пользователей.
+
В качестве альтернативы, получение приблизительно таких же цветных справочных страниц возможно с помощью {Codeline|less}}. Этот метод имеет то преимущество, что {{ic|less}} имеет больший набор функций, чем {{ic|most}}, и этот способ может быть предпочтительней для опытных пользователей.
  
 
Добавьте следующее в файл конфигурации оболочки(shell). Для [[Bash]] это {{Filename|~/.bashrc}}:
 
Добавьте следующее в файл конфигурации оболочки(shell). Для [[Bash]] это {{Filename|~/.bashrc}}:
Line 172: Line 172:
 
  $ man free | man2html -compress -cgiurl man$section/$title.$section$subsection.html > ~/man/free.html
 
  $ man free | man2html -compress -cgiurl man$section/$title.$section$subsection.html > ~/man/free.html
  
Также, {{codeline|man2html}} можно использовать для экспортирование в сырой, подходящий для принтера, текст:
+
Также, {{ic|man2html}} можно использовать для экспортирование в сырой, подходящий для принтера, текст:
 
  $ man free | man2html -bare > ~/free.txt
 
  $ man free | man2html -bare > ~/free.txt
  

Revision as of 17:45, 12 February 2012

This template has only maintenance purposes. For linking to local translations please use interlanguage links, see Help:i18n#Interlanguage links.


Local languages: Català – Dansk – English – Español – Esperanto – Hrvatski – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Norsk Bokmål – Polski – Português – Slovenský – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – العربية – ไทย – 日本語 – 正體中文 – 简体中文 – 한국어


External languages (all articles in these languages should be moved to the external wiki): Deutsch – Français – Română – Suomi – Svenska – Tiếng Việt – Türkçe – فارسی

Tango-preferences-desktop-locale.pngThis article or section needs to be translated.Tango-preferences-desktop-locale.png

Notes: please use the first argument of the template to provide more detailed indications. (Discuss in Talk:Man page (Русский)#)

Template:Article summary start Template:Article summary text Template:Article summary end

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

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

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

Чтобы прочитать man страницу, просто введите:

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

Руководства отсортированы по нескольким секциям:

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

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

$ man 5 passwd

чтобы прочитать man по /etc/passwd, вместо утилиты passwd.

Очень краткие описание программ можно прочитать из man страниц не выводя из целиком с помощью команды whatis. Например, для краткого описания ls, напечатайте:

$ whatis ls

и whatis выведет "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 для поиска в кратком описании страницы руководства заданного ключевого слова. Например, чтобы найти страницу относящуюся к "password":

$ man -k password

или:

$ man --apropos password

Это эквивалентно вызову команды apropos:

$ apropos password

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

Цветные man страницы

Для некоторых пользователей цветные man страницы позволяют получить более четкое представление и легче переварить содержимое. Учитывая, что новые пользователи Linux вынуждены тратить значительно количество времени для ознакомления с основными пользовательскими инструментами, создание комфортных условий для большинства является необходимым.

Есть два основных способа получения цвеных man страниц: использование most, или с помощью опций для less. Первый проще в настройках в ущерб дополнительных функций присущих less.

Первый способ: используя 'most'

Установите Template:Package Official с помощью pacman:

# pacman -S most

Это программа подобна less и more, а также с легкостью позволяет отображать цветной текст.

Отредактируйте Template:Filename, раскомментируйте определение просмоторщика из замените его следующим образом:

DEFINE     pager     most -s

Протестируйте новые настройки напечатав:

$ man whatever_man_page

Изменение цвета требует редактирования Template:Filename (создайте, если его не существует) или редактирования Template:Filename для глобальных настроек. Например, Template:Filename:

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

Следующий пример демострирует настройку привязки клавиш схожую с less (перейти на следующую строку установленно для '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"

Второй способ: использование 'less'

Источник: nion's blog - less colors for man pages

В качестве альтернативы, получение приблизительно таких же цветных справочных страниц возможно с помощью {Codeline|less}}. Этот метод имеет то преимущество, что less имеет больший набор функций, чем most, и этот способ может быть предпочтительней для опытных пользователей.

Добавьте следующее в файл конфигурации оболочки(shell). Для Bash это Template:Filename:

man() {
	env \
		LESS_TERMCAP_mb=$(printf "\e[1;37m") \
		LESS_TERMCAP_md=$(printf "\e[1;37m") \
		LESS_TERMCAP_me=$(printf "\e[0m") \
		LESS_TERMCAP_se=$(printf "\e[0m") \
		LESS_TERMCAP_so=$(printf "\e[1;47;30m") \
		LESS_TERMCAP_ue=$(printf "\e[0m") \
		LESS_TERMCAP_us=$(printf "\e[0;36m") \
			man "$@"
}

Чтобы настроить цвета, смотрите Wikipedia:ANSI escape code для справки.

Чтение man страниц с помощью браузера

Использование таких браузеров, как lynx и Firefox для просмотра man страниц позволяет пользователям воспользоваться основным преимуществом информационных страниц: текст с гиперссылками. Кроме того, пользователи KDE могут читать страницы man в браузере Konqueror с помощью:

man:<name>

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

Для начала, установите Template:Package AUR из AUR.

Теперь, сконвертируйте man страницу:

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

Также, man2html можно использовать для экспортирование в сырой, подходящий для принтера, текст:

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

GNU реализация man, находящегося в репозиториях Arch также позволяет сделать это самостоятельно, без посторонних утилит:

$ man -H free

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

man -H /путь/к/бинарнику free

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

Есть несколько онлайновых баз данных страниц man, включая: