HEADS UP: Mandoc integrated
I have just integrated 5025 import and use mandoc. This means a few things. If you are an end-user, the following changes will be present in illumos builds that include this commit: * There is a new mandoc(1) command, that can format both man(5) and mdoc(5) man pages. It can generate various different formats. See the man page for it for more info. * The whatis database has been renamed from windex to whatis, and has a slightly different format. If you use apropos(1) or whatis(1) -- or the man -k flag -- you will need to rebuild the database with catman -w or man -w. * Support for ditroff output, and the TCAT environment variable, is removed. * Support for preformatted man pages is removed. The mandoc(1) formatter is efficient enough that there is little reason to want preformatted pages. (If someone really wants this to come back, please let me know -- I can probably write new code to add it back if there is a compelling argument in favor of it.) * Support for SGML pages is completely removed. All vestiges. * Some pages may have botched formatting. In particular, if there is buggy markup in some pages, the new formatter may misformat such errors. Please file bugs for any problems you notice. * New pages use sections INTERFACE STABILITY, CODE SET INDPENDENCE, ARCHITECTURE, and MT-LEVEL rather than an attributes(5) table. (Same content, but presented as sections rather than in inconsistently formatted tables.) * If you write new pages, please use mdoc(5) format instead of man(5). There are numerous benefits to this, but most importantly the markup is semantic rather than physical, and much easier to read and maintain. Also, more consistent formatting output will result. Developers using illumos-gate will also notice a few things: * There is a new check target for the man directories. Please use the check target to validate man pages. * git pbchk also validates man page formatting using mandoc -Tlint. (hg pbchk should as well, but I've not fully validated that.) * Please only provide new content in mdoc(5) format. Please let me know if you spot any problems. I've tried hard to make this integrate have the smallest impact sensible for folks. Thanks! - Garrett ------------------------------------------- illumos-discuss Archives: https://www.listbox.com/member/archive/182180/=now RSS Feed: https://www.listbox.com/member/archive/rss/182180/21175430-2e6923be Modify Your Subscription: https://www.listbox.com/member/?member_id=21175430&id_secret=21175430-6a77cda4 Powered by Listbox: http://www.listbox.com
