Mandoc - Mandoc

mandoc
První vydáníListopadu 2008
Stabilní uvolnění
1.14.5 / 10. března 2019; Před 20 měsíci (2019-03-10)[1]
Úložiště
Upravte to na Wikidata
NapsánoC
TypSazba
LicenceLicence ISC
webová stránkamandoc.bsd.lv

mandoc (historicky nazýván mdocml) je ISC licencováno nástroj pro formátování manuálové stránky, konkrétně ty napsané v mdoc a muž makro jazyky. Na rozdíl od groff a starší troff a nroff nástroje převážně používané pro tento účel, mandoc se zaměřuje konkrétně na manuály a není vhodný pro všeobecné použití nastavení typu.

mandoc se používá hlavně k formátování mdoc manuály používané v BSD operační systémy, ale také implementuje většinu z muž makra použitá v Linux distribuce, stejně jako podmnožina roff příkazy občas smíchané s muž makra.[2][1](1.14.5) Nepodporuje další sady maker, jako například mm a slečnanebo jakékoli funkce sazby, jako je dělení slov, písma a zarovnání.[2](kompatibilita) Jsou podporovány jednoduché styly, jako je tučné písmo a kurzíva, ale text v kurzivě je na terminálu nahrazen podtrženým textem.[3][4]

mandoc má integrovanou podporu pro preprocesor troff soelim (začlenění) a částečnou integrovanou podporu pro tbl a ekv. Má silnou podporu pro výstup UTF-8. Může také implementovat sémantické informace v manuálech mdoc sémantické vyhledávání, na které se před verzí 1.4.1 spoléhalo sqlite.[1](1.4.1)

Dějiny

Vývoj byl zahájen v listopadu 2008 konkrétně pro výrobu CSS - povoleno HTML formy příruček v reakci na omezení groff. mandoc získal počáteční textový výstup v únoru 2009.[5] Poté byl představen na AsiaBSDC v roce 2009.[6][7][8] V létě roku 2010 byl mandoc předmětem a NetBSD -murovaný Google Summer of Code projekt[9] pro výrobu PostScript a PDF výstup vedle existujícího textu, HTML a XHTML výstupy. Tato práce byla dokončena v srpnu 2010.[10] mandoc se stal výchozím formátovačem příruček pro OpenBSD 4.8, vydané v listopadu 2010.[11][12] Později se stal výchozím formátovačem v NetBSD, FreeBSD, ilumos, Zrušit Linux a Alpine Linux, a je také součástí DragonFlyBSD, MINIX 3, Debian, Ubuntu, Gentoo, a Fedora.[13] Jeho výhody byly uvedeny jako vysoká rychlost,[14] licence a čistá reimplementace.

Ukázkové použití

Následující ukazuje spuštění mandoc sama o sobě. Obvykle by to bylo voláno přes muž nástroj. V tomto příkladu foo.1 je jméno mdoc Manuál pro UNIX.[15]

 # Pipe výstup na pager. $ mandoc foo. 1 | méně # Výstup HTML se šablonou stylů. $ mandoc -thtml -styl=style.css> foo.1.html

Vícebajtové (lokalizované) příručky lze také vykreslit bez předzpracování. V tomto příkladu foo.jp.1 je japonský manuál zakódovaný do UTF-8. mandoc automaticky detekuje kódování.[15]

 # Pipe širokopásmový výstup na pager. $ mandoc foo.jp.1 | méně

V ceně vhodný implementace může při vyhledávání využívat sémantické informace:[16]

 # Hledat všechny funkce začínající řetězcem „str“ s návratovým typem size_t: $ apropos -s 3 Ft=size_t -a Nm ~ ^ str

Další funkce

  • mandoc podporuje výstup HTML 5, PostScript a PDF prostřednictvím -T parametr.[15]
  • man.cgi je CGI program určený k zobrazení ručních stránek na webu. OpenBSD používá jej k formátování všech svých manuálových stránek.[17]

Reference

  1. ^ A b C "Poznámky k vydání". 10. března 2019.
  2. ^ A b roff (7) – OpenBSD ruzne informace Manuál
  3. ^ "Kurzíva a barva na manuálových stránkách na nosh virtuálního terminálu uživatelského prostoru". jdebp.eu.
  4. ^ mandoc (1) – FreeBSD Obecné příkazy Manuál. "Styly písem se aplikují pomocí kódování s mezerami ..."
  5. ^ "Historie zdroje". Mdocml.bsd.lv. Citováno 2010-12-18.
  6. ^ „AsiaBSDCon 2009: Odporující groff pro ruční zobrazení BSD“. 2009.asiabsdcon.org. 2009-03-15. Citováno 2010-12-18.
  7. ^ "Odsuzující groff pro ruční zobrazení BSD" (PDF). Citováno 2010-12-18.
  8. ^ „Video of AsiaBSDCon presentation“. Youtube.com. Citováno 2010-12-18.
  9. ^ „Google Summer of Code: mandoc_ps“. Netbsd-soc.sourceforge.net. Citováno 2010-12-18.
  10. ^ „NetBSD Blog“. Blog.netbsd.org. 11. 8. 2010. Citováno 2010-12-18.
  11. ^ „OpenBSD 4.8“. Openbsd.org. 2010-11-01. Citováno 2010-12-18.
  12. ^ "groff odstraněn ze stromu".
  13. ^ „Dostupnost sady nástrojů Mandoc“. Mdocml.bsd.lv.
  14. ^ Unangst, Tede. „měřítka rychlosti mandoc“.
  15. ^ A b C mandoc (1) – OpenBSD Obecné příkazy Manuál
  16. ^ apropos (1) – OpenBSD Obecné příkazy Manuál
  17. ^ man.cgi (8) – OpenBSD Správce systému Manuál

externí odkazy