Мандок - Mandoc

Mandoc
изначальный выпускНоябрь 2008 г.
Стабильный выпуск
1.14.5 / 10 марта 2019 г.; 20 месяцев назад (2019-03-10)[1]
Репозиторий
Отредактируйте это в Викиданных
Написано вC
ТипВерстка
ЛицензияЛицензия ISC
Интернет сайтMandoc.bsd.lv

Mandoc (исторически называется mdocml) является Лицензия ISC утилита для форматирования страницы руководства, в частности написанные в mdoc и человек макроязыки. в отличие от Groff и старше Troff и nroff инструменты, в основном используемые для этой цели, mandoc ориентирован именно на руководства и не подходит для общего назначения наборный.

mandoc в основном используется для форматирования mdoc руководства, используемые в Операционные системы BSD, но он также реализует большую часть человек макросы, используемые в Linux дистрибутивов, а также подмножество roff команды иногда смешиваются с человек макросы.[2][1](1.14.5) Он не поддерживает другие наборы макросов, такие как мм и РС, или любые функции набора, такие как расстановка переносов, шрифты и выравнивание.[2](совместимость) Поддерживаются простые стили, такие как полужирный и курсив, но текст, выделенный курсивом, заменяется подчеркнутым текстом на терминале.[3][4]

mandoc имеет встроенную поддержку препроцессора troff soelim (включение) и частично встроенную поддержку таблица и уравнение. Он имеет сильную поддержку вывода UTF-8. Он также может использовать семантическую информацию в руководствах по mdoc для реализации семантический поиск, который до версии 1.4.1 полагался на sqlite.[1](1.4.1)

История

Разработка началась в ноябре 2008 года специально для производства CSS -включено HTML формы руководств в ответ на ограничения Groff. Первоначальный текстовый формат mandoc вышел в феврале 2009 года.[5] Затем он был представлен на AsiaBSDCon-2009.[6][7][8] Летом 2010 года мандок стал предметом NetBSD воспитанный Google Summer of Code проект[9] для производства PostScript и PDF вывод вместе с существующим текстом, HTML и XHTML выходы. Эта работа была завершена в августе 2010 года.[10] mandoc стал программой форматирования руководств по умолчанию для OpenBSD 4.8, выпущенный в ноябре 2010 года.[11][12] Позже он стал средством форматирования по умолчанию в NetBSD, FreeBSD, иллюзия, Void Linux и Alpine Linux, а также входит в DragonFlyBSD, МИНИКС 3, Debian, Ubuntu, Gentoo, и Fedora.[13] Его преимущества были заявлены как высокая скорость,[14] лицензия и чистая реализация.

Пример использования

Следующее демонстрирует запуск Mandoc самостоятельно. Обычно он вызывается через человек полезность. В этом примере foo.1 это имя mdoc Руководство UNIX.[15]

 # Передать вывод на пейджер. $ mandoc foo.1 | меньше # Вывод HTML с таблицей стилей. $ mandoc -Thtml -Ostyle=style.css> foo.1.html

Многобайтовые (локализованные) руководства также могут отображаться без предварительной обработки. В этом примере foo.jp.1 это руководство на японском языке, закодированное в UTF-8. mandoc автоматически определит кодировку.[15]

 # Направлять вывод широких символов на пейджер. $ mandoc foo.jp.1 | меньше

Включенный по поводу реализация может использовать семантическую информацию в поиске:[16]

 # Искать все функции, начинающиеся с 'str', имеющие тип возвращаемого значения size_t: $ apropos -s 3 Ft=size_t -a Нм ~ ^ str

Другие свойства

  • Mandoc поддерживает вывод HTML 5, PostScript и PDF через -T параметр.[15]
  • man.cgi это CGI программа, предназначенная для отображения справочных страниц в сети. OpenBSD использует его для форматирования всех своих справочных страниц.[17]

Рекомендации

  1. ^ а б c «Примечания к выпуску». 10 марта 2019.
  2. ^ а б roff (7) – OpenBSD Разнообразная информация Руководство
  3. ^ «Курсив и цвет на страницах руководства на виртуальном терминале nosh в пользовательском пространстве». jdebp.eu.
  4. ^ мандок (1) – FreeBSD Общие команды Руководство. «Стили шрифтов применяются с использованием кодировки с обратным интервалом ...»
  5. ^ «Источники истории». Mdocml.bsd.lv. Получено 2010-12-18.
  6. ^ «AsiaBSDCon 2009: прекращение поддержки groff для ручного отображения BSD». 2009.asiabsdcon.org. 2009-03-15. Получено 2010-12-18.
  7. ^ "Прекращение поддержки groff для ручного отображения BSD" (PDF). Получено 2010-12-18.
  8. ^ «Видео презентации AsiaBSDCon». Youtube.com. Получено 2010-12-18.
  9. ^ "Google Summer of Code: mandoc_ps". Netbsd-soc.sourceforge.net. Получено 2010-12-18.
  10. ^ "Блог NetBSD". Blog.netbsd.org. 2010-08-11. Получено 2010-12-18.
  11. ^ "OpenBSD 4.8". Openbsd.org. 2010-11-01. Получено 2010-12-18.
  12. ^ "groff удален из дерева".
  13. ^ «Доступность набора инструментов mandoc». Mdocml.bsd.lv.
  14. ^ Unangst, Тед. "тесты скорости mandoc".
  15. ^ а б c мандок (1) – OpenBSD Общие команды Руководство
  16. ^ по поводу (1) – OpenBSD Общие команды Руководство
  17. ^ man.cgi (8) – OpenBSD Системный менеджер Руководство

внешняя ссылка