Из Википедии, бесплатной энциклопедии
  (Перенаправлено со страницы руководства (Unix) )
Перейти к навигации Перейти к поиску

Справочная страница по man (1) в различных дистрибутивах Linux . Эта версия взята из man-db.

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

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

Страницы руководства часто упоминаются как онлайновая или онлайновая форма документации по программному обеспечению [1], даже несмотря на то, что manкоманда не требует доступа в Интернет, начиная с тех времен, когда печатные внеполосные руководства были нормой.

История [ править ]

xman , раннее приложение X11 для просмотра страниц руководства
Вводная страница руководства OpenBSD, раздел 8, отображаемая в текстовой консоли

В первые два года истории Unix документации не существовало. [2] В Руководство Unix программиста впервые был опубликован 3 ноября 1971 г. Первые фактические страницы человека были написаны Деннис Ритчи и Кен Томпсон по настоянию [ править ] их менеджер Дуг Макилрой в 1971. Помимо человека страниц, в Руководство программиста также накопилось множество коротких статей, некоторые из них учебники (например , для общего использования Unix, на C языка программирования и инструментов , таких как Yacc) и другие более подробные описания функций операционной системы. Печатная версия руководство изначально уместиться в одном связующем, а также из PWB / UNIX и 7 - е издание из Исследовательского Unix , он был разбит на два тома с напечатанных страниц человека , образующих Том 1. [3]

Более поздние версии документации имитировали лаконичность первых страниц руководства. Ричи добавил раздел «Как начать» к введению к третьему изданию , а Лоринда Черри предоставила карманный справочник «Пурпурная карта» для шестого и седьмого изданий. [2] Версии программного обеспечения были названы в честь редакции руководства; седьмое издание Руководства программиста Unix , например, пришло с 7-м изданием или версией 7 Unix. [4]

Для Четвертого издания страницы руководства были отформатированы с использованием пакета набора troff [2] и его набора -manмакросов (которые были полностью пересмотрены между Шестым и Седьмым изданиями Руководства , [3], но с тех пор кардинально не изменились). В то время доступность онлайн-документации через систему справочных страниц считалась большим достижением. По сей день практически каждое приложение командной строки Unix имеет справочную страницу, и многие пользователи Unix воспринимают отсутствие справочных страниц в программе как признак низкого качества; действительно, некоторые проекты, такие как Debian , стараются изо всех сил писать справочные страницы для программ, в которых их нет. Современные потомки 4.4BSDтакже распространять справочные страницы как одну из основных форм системной документации (заменив старые -manмакросы новыми -mdoc).

В версии man-db команды man было скрытое пасхальное яйцо , которое заставляло команду возвращать "gimme gimme gimme" при запуске в 00:30 (отсылка к песне ABBA Gimme! Gimme! Gimme! (Человек После полуночи) . Он был представлен в 2011 году [5], но сначала был ограничен [6], а затем удален в 2017 году [7] после того, как был окончательно обнаружен [8].

Форматирование [ править ]

Часть справочной страницы Man (1) FreeBSD , набранная в формате PDF .

Форматом страниц руководства по умолчанию является troff , либо с макропакетом man (ориентированный на внешний вид), либо с mdoc (ориентированный на семантику). Это позволяет набирать справочную страницу в PostScript , PDF и другие различные форматы для просмотра или печати.

В некоторых системах Unix есть пакет для команды man2html , которая позволяет пользователям просматривать свои справочные страницы с помощью HTML-браузера. Системы с groff и man-db должны использовать вместо этого высококачественный собственный HTML-вывод ( man --html ). GNU Emacs Программа женщина (от «без человека») позволяет просматривать человек страниц из редактора. [9]

В 2010 году OpenBSD отказался от troff для форматирования man-страниц в пользу mandoc , специализированного компилятора / форматировщика для man-страниц с встроенной поддержкой вывода в PostScript , HTML , XHTML и терминал. Он предназначен только для поддержки подмножества troff, используемого на страницах руководства, особенно тех, которые используют макросы mdoc.

Онлайн-сервисы [ править ]

Довольно много веб-сайтов предлагают онлайн-доступ к страницам руководства из различных Unix-подобных систем.

В феврале 2013 года сообщество BSD увидело запуск новой службы mdoc.su с открытым исходным кодом , которая унифицировала и сократила доступ к сценариям man.cgi основных современных проектов BSD с помощью уникальной службы детерминированного сокращения URL-адресов на основе nginx для * BSD man. страниц. [10] [11] [12]

Для Linux настроена служба man7.org для обслуживания руководств, относящихся к системе. [13] Сервис ManKier предоставляет более широкий выбор и также интегрирует страницы TLDR. [14]

Использование команд [ править ]

Чтобы прочитать страницу руководства для команды Unix, пользователь может ввести:

мужчина <имя_команды>

Страницы традиционно обозначаются обозначением «имя (раздел)»: например ftp(1),. В этом разделе описаны различные способы ссылки на тему - например, как системный вызов, или команда или пакет оболочки (командной строки), или файл конфигурации пакета, или как конструкция / заголовок кодирования.

Одно и то же имя страницы может появляться в нескольких разделах руководства, например, когда совпадают имена системных вызовов , пользовательских команд или пакетов макросов . Примеры: man(1)и man(7), или exit(2)и exit(3). Синтаксис доступа к разделу руководства, отличному от заданного по умолчанию, варьируется в зависимости от реализации man.

Например, в Solaris и illumos синтаксис чтения printf(3C):

мужчина -s 3c printf

В производных от Linux и BSD такой же вызов будет:

мужчина 3  printf

который ищет printf в разделе 3 справочных страниц.

Разделы руководства [ править ]

Руководство обычно делится на восемь пронумерованных разделов, организованных следующим образом (по Research Unix , BSD , macOS и Linux ): [15] [16] [17] [18]

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

Системные вызовы POSIX часто присутствуют в разделах 2 и 3, где раздел 2 содержит документацию по системным вызовам из локальной операционной системы, а раздел 3 содержит документацию по системным вызовам из Руководства программиста POSIX. [ необходима цитата ]

В Unix System V используется аналогичная схема нумерации, но в другом порядке: [19]

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

В некоторых системах доступны некоторые из следующих разделов:

РазделОписание
0 Заголовочные файлы библиотеки C (Unix v6)
9Подпрограммы ядра (FreeBSD, SVR4, Linux) [18] [16]
пКоманды Tcl / Tk
ИксСистема X Window

Некоторые разделы далее подразделяются с помощью суффикса; например, в некоторых системах раздел 3C предназначен для вызовов библиотеки C, 3M - для математической библиотеки и так далее. Следствием этого является то, что раздел 8 (команды системного администрирования) иногда отнесен к подразделу 1M раздела основных команд. Некоторые суффиксы подразделов имеют общее значение в разделах:

ПодразделОписание
пСпецификации POSIX
ИксДокументация по системе X Window

(Раздел 3 обычно является исключением из-за множества суффиксов для разных языков.)

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

Макет [ править ]

Все страницы руководства имеют общий макет, оптимизированный для представления на простом текстовом дисплее ASCII , возможно, без какой-либо формы выделения или управления шрифтом. Присутствующие разделы могут включать: [20] ( СТРУКТУРА РУКОВОДСТВА )

НАЗВАНИЕ
Имя команды или функции, за которым следует однострочное описание того, что она делает.
ОБЗОР
В случае команды - формальное описание того, как ее запускать и какие параметры командной строки она принимает. Для программных функций - список параметров, которые принимает функция, и заголовочный файл, содержащий ее объявление.
ОПИСАНИЕ
Текстовое описание функционирования команды или функции.
ПРИМЕРЫ
Некоторые примеры общего использования.
СМОТРИТЕ ТАКЖЕ
Список связанных команд или функций.

Могут присутствовать и другие разделы, но они недостаточно стандартизированы на страницах руководства. Общие примеры включают: ОПЦИИ, СТАТУС ВЫХОДА, ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ, СРЕДА, ОШИБКИ, ФАЙЛЫ, АВТОР, СООБЩЕНИЕ ОБ ОШИБКАХ, ИСТОРИЯ и АВТОРСКИЕ ПРАВА.

Авторские [ править ]

Страницы руководства могут быть написаны либо в старых manмакросах, либо в новых docмакросах, либо в их комбинации ( mandoc). [21] Набор manмакросов обеспечивает минимальные функции форматированного текста с директивами для строки заголовка, заголовков разделов, (полужирный, мелкий или курсив) шрифтов, абзацев и добавления / уменьшения отступа. [22] Новый mdocязык является более семантическим по своей природе и содержит специализированные макросы для большинства стандартных разделов, таких как имя программы, синопсис, имена функций и имена авторов. Эта информация может быть использована для реализации семантического поиска руководств такими программами, как mandoc. Хотя он также включает директивы для непосредственного управления стилем, ожидается, что специализированные макросы охватят большинство вариантов использования. [20] Оба проекта - mandoc и groff - считают mdocпредпочтительным формат для новых документов. [23]

Хотя man-страницы для troff представляют собой текст, набранный римским шрифтом из 10 пунктов , это различие обычно спорно, потому что man-страницы просматриваются в терминале (TTY), а не на бумаге. В результате макрос «мелкий шрифт» используется редко. [24] С другой стороны, полужирный и курсивный текст поддерживается терминалом через ECMA-48 , и groff grottyотправляет их по запросу, когда обнаруживает поддерживающий терминал. Однако стандарт BSD поддерживает только полужирный и подчеркнутый (как замену курсиву) текст с помощью последовательности «backspace-then-overstrike» пишущей машинки, которая должна быть переведена в ECMA-48 с помощью less. [25] [26]

Страницы руководства обычно написаны на английском языке, но в системе могут быть доступны переводы на другие языки. Известно, что GNU man-dbи mandoc manищут локализованные справочные страницы в подкаталогах. [27] [15] ( Обзор ) [16]

Альтернативы [ править ]

Несколько альтернатив, manкоторые пользовались большой популярностью, за исключением, возможно, системы GNU Project " info", ранней и простой гипертекстовой системы. Существует также сторонняя программа, известная как TLDR pages ( tldr), которая предоставляет простые примеры для распространенных случаев использования, похожие на шпаргалку . [28]

Кроме того, некоторые приложения с графическим интерфейсом пользователя Unix (особенно те, которые созданы с использованием сред разработки GNOME и KDE ) теперь предоставляют документацию для конечных пользователей в формате HTML и включают встроенные средства просмотра HTML, например, yelpдля чтения справки внутри приложения.

См. Также [ править ]

  • Список команд Unix
  • Список приложений Plan 9
  • Информация
  • по поводу
  • ПРОЧТИ МЕНЯ
  • RTFM
  • ManOpen - графическая утилита man для NeXT / macOS

Ссылки [ править ]

  1. ^ "man (1) - отображать страницы документации онлайн-руководства" . Перекрестная ссылка BSD . FreeBSD . Проверено 1 апреля 2019 . Выложите резюме . Утилита man находит и отображает страницы документации онлайн-руководства.
  2. ^ а б в Макилрой, доктор медицины (1987). Читатель Research Unix: аннотированные выдержки из Руководства программиста, 1971–1986 (PDF) (технический отчет). CSTR. Bell Labs. 139.
  3. ^ а б Дарвин, Ян; Коллиер, Джеффри. «Эволюция UNIX: 1975–1984 Часть I - Разнообразие» . Проверено 22 декабря 2012 года .Первоначально опубликовано в Microsystems 5 (11), ноябрь 1984 г.
  4. Перейти ↑ Fiedler, Ryan (октябрь 1983 г.). «Учебник по Unix / Часть 3: Unix на рынке микрокомпьютеров» . БАЙТ . п. 132 . Проверено 30 января 2015 года .
  5. ^ "GIT коммит 002a6339b1fe8f83f4808022a17e1aa379756d99" . Проверено 22 ноября 2017 года .
  6. ^ "GIT совершает 84bde8d8a9a357bd372793d25746ac6b49480525" . Проверено 22 ноября 2017 года .
  7. ^ "GIT коммит b225d9e76fbb0a6a4539c0992fba88c83f0bd37e" . Проверено 25 сентября 2018 года .
  8. ^ " " Почему человек печатает «дай мне дай мне» в 00:30? " " . Проверено 22 ноября 2017 года .
  9. ^ Райт, Фрэнсис Дж. "WoMan: Просмотрите страницы руководства Unix" WO (без) Man " " . GNU . Дата обращения 3 августа 2020 .
  10. ^ Пали, Габор, изд. (12 мая 2013 г.). «Ежеквартальный отчет о состоянии FreeBSD, январь-март 2013 г.» . FreeBSD . Проверено 25 декабря 2014 .
  11. ^ Murenin Константин А. (19 февраля 2013). "объявление mdoc.su, короткие URL-адреса страниц руководства" . [email protected] (список рассылки) . Проверено 25 декабря 2014 .
  12. ^ Murenin Константин А. (23 февраля 2013). «mdoc.su - Краткие URL-адреса страниц руководства для FreeBSD, OpenBSD, NetBSD и DragonFly BSD» . Проверено 25 декабря 2014 .
  13. ^ "Справочные страницы Linux в Интернете" . man7.org .
  14. ^ "О" . ManKier .
  15. ^ a b man(1)  -  Руководство по основным командам Linux
  16. ^ a b c man(1)  -  Руководство по основным командам FreeBSD
  17. ^ "Справочные страницы для исследований Unix, восьмое издание" . man.cat-v.org .
  18. ^ a b «Руководство программиста Unix - Введение» . www.bell-labs.com . 3 ноября 1971 г.
  19. ^ "System V выпуск 4 руководств" . bitsavers.trailing-edge.com .
  20. ^ a b mdoc(7)  -  Руководство по разной информации FreeBSD
  21. ^ groff_tmac(5)  -  Руководство по форматам файлов Linux
  22. ^ man(7)  -  Руководство по Linux Miscellanea
  23. ^ «Заявление о миссии Groff - 2014» . www.gnu.org . Параллельно с работой над man (7) будет активно поддерживаться mdoc (7) и продвигаться его использование.
  24. ^ "человек" . Руководство GNU Troff . Проверено 31 декабря 2019 года .
  25. ^ «Курсив и цвет на страницах руководства виртуального терминала nosh в пользовательском пространстве» . jdebp.eu .
  26. ^ mandoc(1)  -  Руководство по основным командам FreeBSD . «Стили шрифтов применяются с использованием кодировки с обратным интервалом ...»
  27. ^ «командная строка - справочные страницы Linux на разных языках» . Спросите Ubuntu .
  28. ^ "Страницы TLDR" . tldr.sh .

Внешние ссылки [ править ]

  • History of UNIX Manpages для истории первоисточников UNIX Manpages.
  • Репозиторий страниц руководства UNIX и Linux с почти 300 000 хорошо отформатированных страниц руководства.
  • Что означают числа на странице руководства?

Эта статья основана на материалах, взятых из Free On-line Dictionary of Computing до 1 ноября 2008 г. и включенных в соответствии с условиями «перелицензирования» GFDL версии 1.3 или новее.