BSDCan2015 - ZI

BSDCan 2015
The Technical BSD Conference

Ingo Schwarze
Day Talks #2 - 13 June - 2015-06-13
Room DMS 1120
Start time 16:15
Duration 01:00
ID 594
Event type Lecture
Track Hacking
Language used for presentation English

mandoc: becoming the main BSD manual toolbox

Since my talk at BSDCan 2014, FreeBSD and illumos (formerly OpenSolaris) have switched to use mandoc as the default manual page formatter, and the scope of the mandoc toolbox has also expanded with respect to functionality: OpenBSD now uses it as a replacement for the traditional BSD implementations of the offline and online manual viewers man(1) and man.cgi(8), and there are significant improvements to eqn(7) and UTF-8 support.

The talk will present an overview of several topics:

  • What needed to be done to replace man(1) and man.cgi(8) in OpenBSD, what the advantages are, and what the price is;
  • how the new eqn(7) MathML output works and in which respects the newly improved eqn(7) terminal output is now better than in groff(1);
  • how the new transparent UTF-8 input and output works without requiring the user to specify any options;
  • which types of errors were found by Jonathan Gray with the American Fuzzy Lop (afl), and what lessons are to be learned from that work;
  • how the new -Wunsupp option is going to simplify porting of software and improve manual page formatting quality in FreeBSD ports;
  • what Anthony Bentley did with pod2mdoc(1) on LibreSSL documentation, and which future possibilities exist in the vicinity;
  • which operating systems now use mandoc, what the recommended next steps are for these systems, and in which directions i'm planning to continue mandoc development.