1 $Id: NEWS,v 1.12 2016/07/14 11:09:06 schwarze Exp $
3 This file lists the most important changes in the mdocml.bsd.lv distribution.
5 Changes in version 1.13.4, released on July 14, 2016
7 --- MAJOR NEW FEATURES ---
8 * man.conf(5): Design and implement a simpler configuration file format.
9 * man(1): Leverage less(1) -T and :t in a way resembling ctags(1)
10 to jump to the definitions of various terms inside manual pages.
11 * soelim(1): New implementation by Baptiste Daroussin.
12 * privilege limitation: Use OpenBSD pledge(2) or OS X sandbox_init(3)
14 * man.cgi(8): Support short URIs like http://man.openbsd.org/mdoc .
15 * mandoc.css: Use one unified stylesheet rather than three different ones.
16 --- MAJOR FUNCTIONALLY RELEVANT BUGFIXES ---
17 * mdoc(7): Fix multiple aspects of SYNOPSIS .Nm formatting.
18 * man(1): Fix process group handling, avoiding unclean shutdowns.
19 --- PORTABILITY IMPROVEMENTS ---
20 * Correctly use the ohash(3) compatibility implementation
21 even when building without SQLite support.
22 * Add compat glue for building on Solaris 9 and 10.
23 * Let ./configure select a supported RE syntax for word boundaries.
24 * Support LDFLAGS, to be used for example for hardening options.
25 * Avoid mixing putchar(3) and putwchar(3) on the same file descriptor,
26 it resulted in output corruption on some platforms.
27 * Avoid reusing va_lists, use va_copy(3) for better portability.
28 * Do not hardcode the path to the more(1) program.
29 --- MINOR NEW FEATURES ---
30 * roff(7): Implement \n(.$ (number of macro arguments).
31 * roff(7): Fully implement \z (do not advance cursor).
32 * roff(7): Implement the `r' conditional (register exists).
33 * roff(7): Implement \\$* (interpolate all arguments).
34 * roff(7): Parse and ignore \, and \/ (italic corrections).
35 * When there is no -m, no -M, no MANPATH and no /etc/man.conf,
36 fall back to /usr/share/man:/usr/X11R6/man:/usr/local/man.
37 * man(1): Give manuals in purely numerical sections priority over
38 manuals of the same name in sections with an alphabetical suffix.
39 * man.cgi(8): Support "header.html" and "footer.html".
40 * man.cgi(8): Set the "autofocus" attribute on the query text box.
41 * man.cgi(8): Simplify the search form, drop two useless buttons.
42 * man.cgi(8): Delete the pseudo-manpath "mandoc", assume that
43 apropos(1) and man.cgi(8) are installed in the default manpath.
44 --- RELIABILITY BUGFIXES ---
45 * mdoc(7): Avoid a use after free and an assertion failure when nodes
46 are deleted during validation.
47 * mdoc(7): Avoid a NULL pointer access when .Bd has no arguments.
48 * mdoc(7): Avoid a NULL pointer access triggered by mismatching end macros.
49 * mdoc(7): Avoid an assertion when .Fo has no argument.
50 * mdoc(7): Avoid an assertion when .Ta<tab> occurs in .Bl -column.
51 * mdoc(7): Avoid an assertion when a body gets broken and has a tail.
52 * roff(7): Avoid an assertion caused by blanks inside \o.
53 * roff(7): Make .so links to gziped manuals work without mandoc.db(5).
54 * tbl(7): Avoid a use after free when the last line of a layout is empty.
55 * eqn(7): Avoid an infinite loop caused by recursive "define".
56 * makewhatis(8): Avoid a segfault caused by unusual directory structures.
57 * Fix handling of leading, trailing, and double colons in MANPATH and -m.
58 --- MINOR BUGFIXES ---
59 * mdoc(7): Put arguments to end macros of broken partial explicit blocks
60 inside the breaking block.
61 * mdoc(7): Let .Dv force normal font.
62 * mdoc(7): Make trailing whitespace significant in .Bl -tag widths.
63 * mdoc(7): Fix macro interpretation around tabs in .Bl -column.
64 * man(7): Use the default width for .RS without arguments.
65 * man(7): On a new RS nesting level, the saved width starts from
66 the default width, not from the saved width of the previous level.
67 * man(7): Allow .PD in next-line scope.
68 * man(7): Improve handling of empty .HP.
69 * man(7): Improve formatting of .br and .sp inside .HP.
70 * man(7): Do not mistreat empty arguments to font alternating
71 macros as vertical spacing requests.
72 * man(7): Allow fill mode changes in tagged paragraph next-line scope.
73 * man(7): Fix minor bugs in block rewinding and simplify the related code.
74 * man(7): Add missing line breaks before subsection headers.
75 * man(7): Give section and subsection headers hanging indentation.
76 * man(7): Make trailing whitespace significant in .TP widths.
77 * roff(7): Don't allow breaking the output line after hyphens
78 that immediately follow escape sequences.
79 * roff(7): Ignore blank characters at the beginning of conditional blocks.
80 * roff(7): Escape breakable hyphens only after handling input line traps.
81 * roff(7): Reject \[uD800] to \[uDFFF] (surrogates) in the parser.
82 * tbl(7): Allow more than one data field after T} on the same input line.
83 * terminal output: Apply bold and italic to non-ASCII Unicode codepoints.
84 * terminal output: Improve rounding rules for horizontal scaling widths.
85 * HTML output: Render ASCII_NBRSP as " ", not "-".
86 * man(1): Do not match the first part of a name if it continues with a dot.
87 * man(1): Keep working even if the current directory is unusable.
88 * man(1): Better error message when $PAGER is invalid.
89 * makewhatis(8): Improve handling of .Va and .Vt macros.
90 * apropos(1): Print "nothing appropriate" to stderr when appropriate.
91 * apropos(1): Abort with a useful error message when elementary
92 database operations like preparing queries or binding variables fail.
93 --- STRUCTURAL CHANGES, no functional change ---
94 * mdoc(7) and man(7): Unified data structures struct roff_node etc.
95 * mdoc(7) and man(7): Unified node handling library in roff.c.
96 * mdoc(7) and man(7): Seperate validation phase from parsing.
97 * roff(7): Major character table cleanup.
98 * Link with libz rather than forking gunzip(1).
100 * Baptiste Daroussin (FreeBSD) for the new soelim(1)
101 and for release testing.
102 * Anthony Bentley (OpenBSD) for unifying mandoc.css, two nice
103 patches for man.cgi(8), some documentation patches, some bug
104 reports, and various useful discussions.
105 * Todd Miller (OpenBSD) for lots of help with process group and
106 signal handling, a few patches, some bug reports and some useful
108 * Jonathan Gray (OpenBSD) for yet more testing with afl(1)
109 again resulting in more than half a dozen important bug reports.
110 * Svyatoslav Mishyn (Crux Linux) for some patches, several bug
111 reports, and extensive release testing.
112 * Christian Neukirchen (void Linux) for a number of compatibility
113 patches and suggestions and several bug reports.
114 * Christos Zoulas (NetBSD) for a bug fix patch and some useful
115 suggestions for cleanup.
116 * Florian Obser (OpenBSD) for a bugfix patch and some bug reports.
117 * Sevan Janiyan for help with Solaris compatibility and release
118 testing on many platforms.
119 * Jan Holzhueter and OpenCSW in general for help with Solaris
120 compatibility, and for providing me with a Solaris 9/10/11 testing
122 * Michael McConville (OpenBSD) for some simple cleanup patches.
123 * Thomas Klausner (NetBSD) for some bug reports and release testing.
124 * Christian Weisgerber, Dmitrij Czarkoff, Igor Sobrado,
125 Ken Westerback, Marc Espie, Mike Belopuhov, Rafael Neves,
126 Ted Unangst, Tim van der Molen, Theo Buehler, Theo de Raadt
127 (OpenBSD), Kurt Jaeger, Dag Erling Smoergrav (FreeBSD),
128 Joerg Sonnenberger (NetBSD), Carsten Kunze (Heirloom troff),
129 Daniel Levai, Fabian Raetz, Jan Stary, Jean-Yves Migeon,
130 Lorenzo Beretta, Markus Waldeck, Maxim Belooussov, Michael Reed,
131 Peter Bray, and Serguey Parkhomovsky for bug reports and feature
133 * Alexander Hall, Andrew Fresh, Antoine Jacoutot, Doug Hogan,
134 Jason McIntyre, Jasper Lievisse Adriaanse, Kent Spillner,
135 Nicholas Marriott, Peter Hessler, Sebastien Marie, Stefan Sperling,
136 and Theo de Raadt (OpenBSD) for helpful discussions and feedback.
138 Changes in version 1.13.3, released on March 13, 2015
140 --- MAJOR NEW FEATURES ---
141 * When a manual is missing from an outdated database, let man(1)
142 show it anyway, using a KISS file system lookup as a fallback.
143 * Use this to always provide man(1), even without database support.
144 * Fatal errors no longer exist. If a file can be opened, mandoc
145 will produce some output; at worst, the output may be almost empty.
146 * New -Wunsupp message level.
147 --- POTENTIONALLY SECURITY RELEVANT BUGFIXES ---
148 * Fix a potential write buffer overrun on incomplete string conditionals.
149 http://mdocml.bsd.lv/cgi-bin/cvsweb/roff.c#rev1.241
150 * Fix a potential write buffer overrun on backslash at EOF in a conditional.
151 http://mdocml.bsd.lv/cgi-bin/cvsweb/roff.c#rev1.247
152 * Fix a use after free sometimes hit when validation deletes a block.
153 http://mdocml.bsd.lv/cgi-bin/cvsweb/mdoc_macro.c#rev1.180
154 --- MAJOR FUNCTIONALLY RELEVANT BUGFIXES ---
155 * Let man(1) show manuals for the current architecture by default,
156 and support the MACHINE environment variable.
157 * Fix the man(1) and apropos(1) -m option, it didn't work at all.
158 * Do not spawn a pager when there is no output.
159 * In makewhatis(8), fix detection of hardlinked manuals on platforms
160 having padding in struct inodev (typically 64bit platforms).
161 --- PORTABILITY IMPROVEMENTS ---
162 * Ignore O_CLOEXEC when the operating system doesn't provide it.
163 * Avoid forward reference to enum type which violates ISO C99.
164 * Support homebrew-style linking on Mac OS X.
165 --- MINOR NEW FEATURES ---
166 * lookup: Accept digit+letter and "n" as section names in man(1),
167 and consistently handle digit+letter in file name extensions.
168 * lookup: Speed up -s/-S by using the "mlinks" rather than the "keys" table.
169 * output: Insert horizontal lines between formatted manual pages.
170 * input: New stricter and more resilient UTF-8 parser.
171 * mdoc(7): Refactor block rewinding for simpler and more robust parsing.
172 * man(7): Use the -Ios option when .TH has less than four arguments.
173 * tbl(7): Implement the "center" option.
174 * tbl(7): New option and format parsers, improved in many respects.
175 * roff(7): Basic implementation of the \o escape sequence (overstrike),
176 and improved rendering of overstrikes in PostScript and PDF output.
177 * Message improvements, in particular for, but not restricted to,
178 eqn(7), tbl(7), and wrong numbers of arguments in mdoc(7) and man(7),
179 in various cases also improving output generated by invalid input.
180 * Delete the -V option. It serves no purpose but keeps confusing people.
181 * gmdiff: Minimal support for Heirloom roff.
182 --- RELIABILITY BUGFIXES ---
183 * tbl(7): Fix a read buffer overrun on 'f' at EOL in a layout.
184 * roff(7): Fix a read buffer overrun on incomplete numerical conditions.
185 * mdoc(7): Fix a NULL pointer access on .Nd followed by an explicit block.
186 * mdoc(7): Fix a NULL pointer access on .It Xo without .Xc.
187 * mdoc(7): Fix a NULL pointer access on .Eo without a tail.
188 * mdoc(7): Fix a NULL pointer access in the validation of empty .St macros.
189 * man(7)/tbl(7): Fix a NULL pointer access on .TS right after .TP.
190 * tbl(7): Fix a NULL pointer access on layout lines without any cells.
191 * eqn(7): Fix NULL pointer accesses in the terminal formatter.
192 * roff(7): Fix a NULL pointer access on trailing \s-/\s+ without an argument.
193 * gz: Fix a potential NULL pointer access after waitpid() failure.
194 * roff(7): Don't let the modulo operator divide by zero.
195 * input: Fix an assertion failure on certain invalid UTF-8 input.
196 * terminal output: Allow arbitrary depth of the font stack (assertion fix).
197 * mdoc(7): Fix assertion failures and endless loops on invalid block closing.
198 * mdoc(7): Fix an assertion failure on .Bl .Sm not followed by .It.
199 * mdoc(7): Fix an assertion failure on .Bl -column ... .El .Ta.
200 * tbl(7): Fix assertion failures by macros inside table data,
201 but do not throw away the macro arguments.
202 * Prevent certain kinds of unreasonable input from producing excessive
203 output, in one case caused by unsigned integer underflow.
204 * Fix a potential memory leak in makewhatis(8) on very long filenames.
205 --- MINOR BUGFIXES ---
206 * mdoc(7): Fix parsing of badly nested blocks with multiple identical blocks.
207 * mdoc(7): Support negative indentations for displays and lists.
208 * mdoc(7): Don't mistreat negative .sp arguments as large positive ones.
209 * mdoc(7): Some spacing fixes for .Eo/.Ec.
210 * man(7): Support negative horizontal widths.
211 * man(7): Do not print out invalid .IP arguments.
212 * man(7): Correctly handle scaling units after .PD.
213 * man(7): Support .RE with an argument.
214 * man(7): Fix restoring indentation after .RS with large negative arguments.
215 * tbl(7): Prevent tables from breaking the filling of preceding text.
216 * tbl(7): Fix vertical spacing at the beginning of tables.
217 * tbl(7): Parser and formatter fixes for line drawing and font modifiers.
218 * tbl(7): Correct handling of blank data lines.
219 * eqn(7): Add sometimes missing whitespace before equation output.
220 * roff(7): Fix vertical scaling, most of it was wrong.
221 * roff(7): Slightly improve \w width measurements.
222 * roff(7): Accept the historic aliases \s10 to \s39 for \s(10 to \s(39.
223 * roff(7): Correctly escape quotes when expanding macro arguments.
224 * roff(7): Correctly handle scaling units in numerical expressions,
225 and some other improvements to the parsing of numerical expressions.
226 * roff(7): Three minor fixes with respect to evaluation of conditionals.
227 * roff(7): Let .it accept numerical expressions, not just constants.
228 * mandoc_char(7): Correct some character names and renderings.
229 * If earlier files set a non-zero exit status, never reset it to zero.
231 * Jonathan Gray (OpenBSD) for yet more testing with afl (the American
232 Fuzzy Lop security fuzzer), again resulting in many bug reports.
233 * Theo de Raadt (OpenBSD) for suggesting the main new feature (man(1) file
234 system lookup) and for reporting an important bug (pager without output).
235 * Theo Buehler for an important bug report (-s/-S slowness)
236 and for proposing a nice new feature (lines between pages).
237 * Jason McIntyre for an important bug report (hardlink detection)
238 and multiple documentation patches.
239 * Pascal Stumpf (OpenBSD) and Alessandro de Laurenzis for
240 important bug reports (architecture and man -m, respectively).
241 * Thomas Klausner (NetBSD) for proposing a new feature (man(7) -Ios),
242 a bug report, and release testing.
243 * Anthony Bentley, Daniel Dickman, Ted Unangst (OpenBSD) and
244 Kristaps Dzonsons (bsd.lv) for source code patches and bug reports.
245 * Christian Weisgerber (OpenBSD) for more than half a dozen bug reports.
246 * Carsten Kunze (Heirloom troff) for bug reports and release testing.
247 * Antoine Jacoutot (OpenBSD) for release testing.
248 * Alexis Hildebrandt (Homebrew), Baptiste Daroussin (FreeBSD),
249 Jonathan Perkin (SmartOS), Pedro Giffuni (FreeBSD), Svyatoslav
250 Mishyn (Crux Linux), Ulrich Spoerlein (FreeBSD), Jan Stary, Patrick
251 Keshishian, Sebastien Marie, and Steffen Nurpmeso for bug reports.
253 Changes in version 1.13.2, released on December 13, 2014
255 --- MAJOR NEW FEATURES ---
256 * Include an implementation of man(1), the manual page viewer.
257 * Unified set of command line option, each one supported by all
258 command names, including new options -a (format all), -c (no
259 pager), -h (synopsis only), and -w (list filenames).
260 * Support the MANPAGER and PAGER environment variables.
261 * Support gzip'ed manuals by the whole toolset, even as .so targets.
262 * Support UTF-8 and Latin-1 input by the whole toolset, delete preconv(1).
263 * Switch the default output mode from -Tascii to -Tlocale.
264 * Improve -Tascii output for Unicode escape sequences.
265 * Let the -Thtml output mode produce polyglot HTML5.
266 * Many improvements for eqn(7), in particular in-line equations,
267 MathML output in -Thtml mode, and much improved terminal formatting.
268 --- PORTABILITY IMPROVEMENTS ---
269 * Change the build sequence to the usual ./configure; make; make install.
270 * Support ./configure.local for build customizations.
271 * Autodetect wchar, sqlite3, and manpath support.
272 * Provide a fallback version of fts(3) for systems lacking it.
273 * Support choosing alternative binary and manual names.
274 --- MINOR NEW FEATURES ---
275 * Rudimentary implementation of the e, x, and z tbl(7) layout
276 modifiers to equalize, maximize, and ignore the width of columns.
277 * Implement font modifiers in tbl(7) layouts.
278 * Allow comma-separated options in the tbl(7) options line.
279 * Parse and ignore the .pl (page length) roff(7) request.
280 * Implement .An -[no]split for the mdoc(7) -Thtml output mode.
281 * Support bold italic font in PostScript and PDF output.
282 * Warn about commas in function arguments and parentheses in function names.
283 * Warn about botched .Xr ordering and punctuation below SEE ALSO.
284 * Warn about AUTHORS sections without .An macros.
285 * Warn about attempts to call non-callable macros.
286 * New developer documentation manual page mandoc_headers(3).
288 * Fix read buffer overrun sometimes triggered by trailing whitespace.
289 * Fix read buffer overrun triggered by certain invalid \H sequences.
290 * Fix NULL pointer access triggered by .Bl without any arguments.
291 * Fix NULL pointer access triggered by .It Nm Fo without .Fc.
292 * Fix NULL pointer access triggered by .Sh Xo .Sh without .Xc.
293 * Fix NULL pointer access triggered by missing .Nm.
294 * Fix an assertion triggered by .It right after .El.
295 * Fix an assertion triggered by .Ec without preceding .Eo.
296 * Fix an assertion triggered by .Sm or .Db with multiple arguments.
297 * Fix assertion failures triggered by very large width arguments.
298 * Fix a division by zero in the roff(7) parser.
299 * Prevent negative arguments to .ll from causing integer underflow.
300 * Correctly autodetect source format even when .Dd is preceded by .ll.
301 * Multiple fixes with respect to .Bd and .Bl -offset and -width.
302 * Many bugfixes with respect to scaling units.
303 * Multiple fixes with respect to delimiter handling by in-line macros.
304 * Multiple fixes with respect to .Pf.
305 * Make \c work properly in no-fill mode.
306 * Stricter syntax checking of Unicode character names.
308 * Kristaps Dzonsons for rewriting the eqn(7) parser, implementing
309 HTML5 and MathML output, and various other code contributions.
310 * Jonathan Gray (OpenBSD) for extensive testing with afl (the
311 American Fuzzy Lop security fuzzer) resulting in many bug reports.
312 * Anthony Bentley (OpenBSD), Baptiste Daroussin (FreeBSD), Daniel
313 Dickman, Doug Hogan, Jason McIntyre, Theo de Raadt (OpenBSD),
314 and Martin Natano for source code patches.
315 * Carsten Kunze (Heirloom troff), Daniel Levai (Slackware),
316 Garrett D'Amore (illumos), Giovanni Becchis, Matthew Dempsky,
317 Stuart Henderson, Ted Unangst, Todd Miller (OpenBSD), Thomas
318 Klausner (NetBSD), Ulrich Spoerlein (FreeBSD), Justin Haynes,
319 Marcus Merighi, Sebastien Marie, Steffen Nurpmeso and Theo Buehler
322 Changes in version 1.13.1, released on August 10, 2014
324 --- MAJOR NEW FEATURES ---
325 * A complete apropos(1)/makewhatis(8)/man.cgi(8) suite
326 based on SQLite3 is now included.
327 * The roff(7) parser now provides an almost complete implementation
328 of numerical expressions.
329 * Warning and error messages have been improved in many ways.
330 Almost all fatal errors were downgraded to normal errors and some
331 even to warnings. Almost all messages now mention the macro where
332 the issue is detected and many indicate the workaround employed.
333 The mandoc(1) manual now includes a list explaining all messages.
334 --- MINOR NEW FEATURES ---
335 * The roff(7) parser now supports the .ami (append to macro with
336 indirectly specified name), .as (append to user-defined
337 string), .dei (define macro with indirectly specified name),
338 .ll (line length), and .rr (remove register) requests.
339 * The roff(7) parser now supports string comparison and numerical
340 conditionals in the .if and .ie requests.
341 * The roff parser now fully supports the \B (validate numerical
342 expression) and partially supports the \w (measure text width)
344 * The terminal formatter now supports the \: (optional line break)
346 * The roff parser now supports expansion of user-defined strings
347 involving indirect references.
348 * The roff(7) parser now handles some pre-defined read-only
349 number registers that occur in the pod2man(1) preamble.
350 * For backward compatibility, the mdoc(7) parser and formatters
351 now support the obsolete macros .En, .Es, .Fr, and .Ot.
352 * The mdoc(7) formatter non partially supports .Bd -centered.
353 * tbl(7) now handles leading and trailing vertical lines.
354 * The build system now provides fallback versions of strcasestr(3)
355 and strsep(3) for systems lacking them.
356 * The mdoc(7) manual now explains how various standards
357 supported by the .St macro are related to each other.
359 * In the roff(7) parser, several bugs were fixed with respect
360 to closing conditional blocks on macro lines.
361 * Parsing of roff(7) identifiers and escape sequences was improved
362 in multiple respects.
363 * In the mdoc(7) parser, the handling of defective document
364 prologues was improved in multiple ways.
365 * The mdoc(7) parser no longer skips content before the first section
366 header, and it no longer deletes non-.% content from .Rs blocks.
367 * In the mdoc(7) parser, a crash was fixed related to weird .Sh headers.
368 * In the mdoc(7) parser, handling of .Sm with missing or invalid
369 arguments was corrected.
370 * In the mdoc(7) parser, trailing punctuation at the end of partial
371 implicit macros no longer triggers end-of-sentence spacing.
372 * In the terminal formatter, two crashes were fixed: one triggered by
373 excessive indentation and another by excessively long .Nm arguments.
374 * In the terminal formatter, a floating point rounding bug was
375 fixed that sometimes caused an off-by-one error in indentation.
376 * In the UTF-8 formatter, rendering of accents, breakable hyphens,
377 and non-breakable spaces was corrected.
378 * In the HTML formatter, encoding of special characters was
379 corrected in multiple respects.
380 * In the mdoc(7) formatter, rendering of .Ex and .Rv was
381 improved for various edge cases.
382 * In the mdoc(7) formatter, handling of empty .Bl -inset item
384 * In the man(7) formatter, some bugs were fixed with respect
385 to same-line detection in the context of .TP and .nf macros,
386 and the indentation of .IP and .TP blocks was improved.
387 * The mandoc(3) library no longer prints to stderr.
389 Abhinav Upadhyay (NetBSD), Andreas Voegele, Anthony Bentley (OpenBSD),
390 Christian Weisgerber (OpenBSD), Havard Eidnes (NetBSD), Jan Stary,
391 Jason McIntyre (OpenBSD), Jeremie Courreges-Anglas (OpenBSD),
392 Joerg Sonnenberger (NetBSD), Juan Francisco Cantero Hurtado (OpenBSD),
393 Marc Espie (OpenBSD), Matthias Scheler (NetBSD), Pascal Stumpf (OpenBSD),
394 Paul Onyschuk (Alpine Linux), Sebastien Marie, Steffen Nurpmeso,
395 Stuart Henderson (OpenBSD), Ted Unangst (OpenBSD), Theo de Raadt (OpenBSD),
396 Thomas Klausner (NetBSD), and Ulrich Spoerlein (FreeBSD)
397 for reporting bugs and missing features.
399 Changes in version 1.12.3, released on December 31, 2013
401 * In the mdoc(7) SYNOPSIS, line breaks and hanging indentation
402 now work correctly for .Fo/.Fa/.Fc and .Fn blocks.
403 Thanks to Franco Fichtner for doing part of the work.
404 * The mdoc(7) .Bk macro got some addititonal bugfixes.
405 * In mdoc(7) macro arguments, double quotes can now be quoted
406 by doubling them, just like in man(7).
407 Thanks to Tsugutomo ENAMI for the patch.
408 * At the end of man(7) macro lines, end-of-sentence spacing
409 now works. Thanks to Franco Fichtner for the patch.
410 * For backward compatibility, the man(7) parser now supports the
411 man-ext .UR/.UE (uniform resource identifier) block macros.
412 * The man(7) parser now handles closing blocks that are not open
414 * The man(7) parser now ignores blank lines right after .SH and .SS.
415 * In the man(7) formatter, reset indentation when leaving a block,
416 not just when entering the next one.
417 * The roff(7) .nr request now supports incrementing and decrementing
418 number registers and stops parsing the number right before the
419 first non-digit character.
420 * The roff(7) parser now supports the alternative escape sequence
421 syntax \C'uXXXX' for Unicode characters.
422 * The roff(7) parser now parses and ignores the .fam (font family)
423 and .hw (hyphenation points) requests and the \d and \u escape
425 * The roff(7) manual got a new ESCAPE SEQUENCE REFERENCE.
427 Changes in version 1.12.2, released on Oktober 5, 2013
429 * The mdoc(7) to man(7) converter, to be called as mandoc -Tman,
430 is now fully functional.
431 * The mandoc(1) utility now supports the -Ios (default operating system)
432 input option, and the -Tutf8 output mode now actually works.
433 * The mandocdb(8) utility no longer truncates existing databases when
434 starting to build new ones, but only replaces them when the build
436 * The man(7) parser now supports the PD macro (paragraph distance),
437 and (for GNU man-ext compatibility only) EX (example block) and EE
438 (example end). Plus several bugfixes regarding indentation, line
439 breaks, and vertical spacing, and regarding RS following TP.
440 * The roff(7) parser now supports the \f(BI (bold+italic) font escape,
441 the \z (zero cursor advance) escape and the cc (change control
442 character) and it (input line trap) requests. Plus bugfixes regarding
443 the \t (tab) escape, nested escape sequences, and conditional requests.
444 * In mdoc(7), several bugs were fixed related to UTF-8 output of quoting
445 enclosures, delimiter handling, list indentation and horizontal and
446 vertical spacing, formatting of the Lk, %U, and %C macros, plus some
447 bugfixes related to the handling of syntax errors like badly nested
448 font blocks, stray Ta macros outside column lists, unterminated It Xo
449 blocks, and non-text children of Nm blocks.
450 * In tbl(7), the width of horizontal spans and the vertical spacing
451 around tables was corrected, and in man(7) files, a crash was fixed
452 that was triggered by some particular unclosed T{ macros.
453 * For mandoc developers, we now provide a tbl(3) library manual and
454 gmdiff, a very small, very simplistic groff-versus-mandoc output
456 * Provide this NEWS file.
458 Changes in version 1.12.1, released on March 23, 2012
460 * Significant work on apropos(1) and mandocdb(8). These tools are now
461 much more robust. A whatis(1) implementation is now handled as an
462 apropos(1) mode. These tools are also able to minimally handle
463 pre-formatted pages, that is, those already formatted by another
464 utility such as GNU troff.
465 * The man.cgi(7) script is also now available for wider testing.
466 It interfaces with mandocdb(8) manuals cached by catman(8).
467 HTML output is generated on-the-fly by libmandoc or internal
468 methods to convert pre-formatted pages.
469 * The mailing list archive for the discuss and tech lists are being
470 hosted by Gmane at gmane.comp.tools.mdocml.user and
471 gmane.comp.tools.mdocml.devel, respectively.
473 Changes in version 1.12.0, released on October 8, 2011
475 * This version features a new, work-in-progress mandoc(1) output mode:
476 -Tman. This mode allows a system maintainer to distribute man(7)
477 media for older systems that may not natively support mdoc(7), such
478 as old Solaris systems.
479 * The -Ofragment option was added to mandoc(1)'s -Thtml and -Txhtml modes.
480 * While adding features, an apropos(1) utility has been merged from the
481 mandoc-tools sandbox. This interfaces with mandocdb(8) for semantic
482 search of manual content. apropos(1) is different from the traditional
483 apropos primarily in allowing keyword search (such as for functions,
484 utilities, etc.) and regular expressions. Note that the calling
485 syntax for apropos is likely to change as it settles down.
486 * In documentation news, the mdoc(7) and man(7) manuals have been
487 made considerably more readable by adding MACRO OVERVIEW sections, by
488 moving the gory details of the LANGUAGE SYNTAX to the roff(7) manual,
489 and by moving the very technical MACRO SYNTAX sections down to the
491 * Furthermore, for tbl(7), the -Tascii mode horizontal spacing of tables
492 was rewritten completely. It is now compatible with groff(1), both
493 with and without frames and rulers.
494 * Nesting of indented blocks is now supported in man(7), and several
495 bugs were fixed regarding indentation and alignment.
496 * The page headers in mdoc(7) are now nicer for very long titles.
498 Changes in version 1.11.7, released on September 2, 2011
500 * Added demandoc(1) utility for stripping away macros and escapes.
501 This replaces the historical deroff(1) utility.
502 * Also improved the mdoc(7) and man(7) manuals.
504 Changes in version 1.11.6, released on August 16, 2011
506 * Handling of tr macro in roff(7) implemented. This makes Perl
507 documentation much more readable. Hyphenation is also now enabled in
508 man(7) format documents. Many other general improvements have been
511 Changes in version 1.11.5, released on July 24, 2011
513 * Significant eqn(7) improvements. mdocml can now parse arbitrary eqn
514 input (although few GNU extensions are accepted, nor is mixing
515 low-level roff with eqn). See the eqn(7) manual for details.
516 For the time being, equations are rendered as simple in-line text.
517 The equation parser satisfies the language specified in the
518 Second Edition User's Guide:
519 http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps
521 Changes in version 1.11.4, released on July 12, 2011
523 * Bug-fixes and clean-ups across all systems, especially in mandocdb(8)
524 and the man(7) parser. This release was significantly assisted by
525 participants in OpenBSD's c2k11. Thanks!
527 Changes in version 1.11.3, released on May 26, 2011
529 * Introduce locale-encoding of output with the -Tlocale output option and
530 Unicode escaped-character input. See mandoc(1) and mandoc_char(7),
531 respectively, for details. This allows for non-ASCII characters (e.g.,
532 \[u5000]) to be rendered in the locale's encoding, if said environment
533 supports wide-character encoding (if it does not, -Tascii is used
534 instead). Locale support can be turned off at compile time by removing
535 -DUSE_WCHAR in the Makefile, in which case -Tlocale is always a synonym
537 * Furthermore, multibyte-encoded documents, such as those in UTF-8, may
538 be on-the-fly recoded into mandoc(1) input by using the newly-added
539 preconv(1) utility. Note: in the future, this feature may be
540 integrated into mandoc(1).
542 Changes in version 1.11.2, released on May 12, 2011
544 * Corrected some installation issues in version 1.11.1.
545 * Further migration to libmandoc.
546 * Initial public release (this utility is very much under development)
547 of mandocdb(8). This utility produces keyword databases of manual
548 content, which features semantic querying of manual content.
550 Changes in version 1.11.1, released on April 4, 2011
552 * The earlier libroff, libmdoc, and libman soup have been merged into
553 a single library, libmandoc, which manages all aspects of parsing
554 real manuals, from line-handling to tbl(7) parsing.
555 * As usual, many general fixes and improvements have also occurred.
556 In particular, a great deal of redundancy and superfluous code has
557 been removed with the merging of the backend libraries.
558 * see also the changes in 1.10.10
560 Changes in version 1.10.10, March 20, 2011, NOT released
562 * Initial eqn(7) functionality is in place. For the time being,
563 this is limited to the recognition of equation blocks;
564 future version of mdocml will expand upon this framework.
566 Changes in version 1.10.9, released on January 7, 2011
568 * Many back-end fixes have been implemented: argument handling (quoting),
569 man(7) improvements, error/warning classes, and many more.
570 * Initial tbl(7) functionality (see the "TS", "TE", and "T&" macros in
571 the roff(7) manual) has been merged from tbl.bsd.lv. Output is still
572 minimal, especially for -Thtml and -Txhtml, but manages to at least
573 display data. This means that mandoc(1) now has built-in support
574 for two troff preprocessors via libroff: soelim(1) and tbl(1).
576 Changes in version 1.10.8, released on December 24, 2010
578 * Overhauled the -Thtml and -Txhtml output modes. They now display
579 readable output in arbitrary browsers, including text-based ones like
580 lynx(1). See HTML and XHTML manuals in the DOCUMENTATION section
581 for examples. Attention: available style-sheet classes have been
582 considerably changed! See the example.style.css file for details.
583 Lastly, libmdoc and libman have been cleaned up and reduced in size
585 * see also the changes in 1.10.7
587 Changes in version 1.10.7, December 6, 2010, NOT released
589 Significant improvements merged from OpenBSD downstream, including:
590 * many new roff(7) components,
591 * in-line implementation of troff's soelim(1),
592 * broken-block handling,
593 * overhauled error classifications, and
594 * cleaned up handling of error conditions.
596 Changes in version 1.10.6, released on September 27, 2010
598 * Calling conventions for mandoc(1) have changed: -W improved and -f
600 * Non-ASCII characters are also now uniformly discarded.
601 * Lots of documentation improvements.
602 * Many incremental fixes accomodating for groff's more interesting
604 * Lastly, pod2man(1) preambles are now fully accepted after some
605 considerable roff(7) and special character support.
607 Changes in version 1.10.5, released on July 27, 2010
609 * Primarily a bug-fix and polish release, but including -Tpdf support
610 in mandoc(1) by way of "Summer of Code". Highlights:
611 * fix "Sm" and "Bd" handling
612 * fix end-of-sentence handling for embedded sentences
613 * polish man(7) documentation
614 * document all mdoc(7) macros
615 * polish mandoc(1) -Tps output
616 * lots of internal clean-ups in character escapes
617 * un-break literal contexts in man(7) documents
618 * improve -Thtml output for -man
619 * add mandoc(1) -Tpdf support
621 Changes in version 1.10.4, released on July 12, 2010
623 * Lots of features developed during both "Summer of Code" and the
624 OpenBSD c2k10 hackathon:
625 * minimal "ds" roff(7) symbols are supported
626 * beautified SYNOPSIS section output
627 * acceptance of scope-block breakage in mdoc(7)
628 * clarify error message status
629 * many minor bug-fixes and formatting issues resolved
630 * see also changes in 1.10.3
632 Changes in version 1.10.3, June 29, 2010, NOT released
634 * variable font-width and paper-size support in mandoc(1) -Tps output
635 * "Bk" mdoc(7) support
637 Changes in version 1.10.2, released on June 19, 2010
639 * Small release featuring text-decoration in -Tps output,
640 a few minor relaxations of errors, and some optimisations.
642 Changes in version 1.10.1, released on June 7, 2010
644 * This primarily focusses on the "Bl" and "It" macros described in
645 mdoc(7). Multi-line column support is now fully compatible with groff,
646 as are implicit list entries for columns.
647 * Removed manuals(7) in favour of http://manpages.bsd.lv.
648 * The way we handle the SYNOPSIS section (see the SYNOPSIS documentation
649 in MANUAL STRUCTURE) has also been considerably simplified compared
651 * Furthermore, the -Owidth=width output option has been added to -Tascii,
653 * Lastly, initial PostScript output has been added with the -Tps option
654 to mandoc(1). It's brutally simple at the moment: fixed-font, with no
657 Changes in version 1.10.0, released on May 29, 2010
659 * Release consisting of the results from the m2k10 hackathon and up-merge
660 from OpenBSD. This requires a significant note of thanks to Ingo
661 Schwarze (OpenBSD) and Joerg Sonnenberger (NetBSD) for their hard work,
662 and again to Joerg for hosting m2k10. Highlights (mostly cribbed from
663 Ingo's m2k10 report) follow in no particular order:
664 * a libroff preprocessor in front of libmdoc and libman stripping out
665 roff(7) instructions;
666 * end-of-sentence (EOS) detection in free-form and macro lines;
667 * correct handling of tab-separated columnar lists in mdoc(7);
668 * improved main calling routines to optionally use mmap(3) for better
670 * cleaned up exiting when invoked as -Tlint or over multiple files
672 * error and warning message handling re-written to be unified for
673 libroff, libmdoc, and libman;
674 * handling of badly-nested explicit-scoped macros;
675 * improved free-form text parsing in libman and libmdoc;
676 * significant GNU troff compatibility improvements in -Tascii,
677 largely in terms of spacing;
678 * a regression framework for making sure the many fragilities of GNU
679 troff aren't trampled in subsequent work;
680 * support for -Tascii breaking at hyphens encountered in free-form text;
681 * and many more minor fixes and improvements
683 Changes in version 1.9.25, released on May 13, 2010
685 * Fixed handling of "\*(Ba" escape.
686 * Backed out -fno-ign-chars (pointless complexity).
687 * Fixed erroneous breaking of literal lines.
688 * Fixed SYNOPSIS breaking lines before non-initial macros.
689 * Changed default section ordering.
690 * Most importantly, the framework for end-of-sentence double-spacing is
691 in place, now implemented for the "end-of-sentence, end-of-line" rule.
692 * This is a stable roll-back point before the mandoc hackathon in Rostock!
694 Changes in version 1.9.24, released on May 9, 2010
696 * Rolled back break-at-hyphen.
697 * -DUGLY is now the default (no feature splits!).
698 * Free-form text is not de-chunked any more: lines are passed
699 whole-sale into the front-end, including whitespace.
700 * Added mailing lists.
702 Changes in version 1.9.23, released on April 7, 2010
704 * mdocml has been linked to the OpenBSD build.
705 * This version incorporates many small changes, mostly from patches
706 by OpenBSD, allowing crufty manuals to slip by with warnings instead
708 * Some subtle semantic issues, such as punctuation scope, have also
710 * Lastly, some issues with -Thtml have been fixed, which prompted an
711 update to the online manual pages style layout.
713 Changes in version 1.9.22, released on March 31, 2010
715 * Adjusted merge of the significant work by Ingo Schwarze
716 in getting "Xo" blocks (block full implicit, e.g., "It"
717 for non-columnar lists) to work properly. This isn't
718 enabled by default: you must specify -DUGLY as a compiler
719 flag (see the Makefile for details).
721 Changes in version 1.9.20, released on March 30, 2010
723 * More efforts to get roff instructions in man(7) documents under
724 control. Note that roff instructions embedded in line-scoped,
725 next-line macros (e.g. "B") are not supported.
726 * Leading punctuation for mdoc(7) macros, such as "Fl ( ( a",
727 are now correctly handled.
729 Changes in version 1.9.18, released on March 27, 2010
731 * Many fixes (largely pertaining to scope)
732 and improvements (e.g., handling of apostrophe-control macros,
733 which fixes the strange "BR" seen in some macro output)
734 to handling roff instructions in man(7) documents.
736 Changes in version 1.9.17, released on March 25, 2010
738 * Accept perlpod(1) standard preamble.
739 * Also accept (and discard) "de", "dei", "am", "ami", and "ig"
742 Changes in version 1.9.16, released on March 22, 2010
744 * Inspired by patches and bug reports by Ingo Schwarze,
745 allowed man(7) to accept non-printing elements to be nested
746 within next-line scopes, such as "br" within "B" or "TH",
748 * Longsoon architecture also noted and Makefile cleaned up.
750 Changes in version 1.9.15, released on February 18, 2010
752 * Moved to our new BSD.lv home.
753 * XHTML is now an acceptable output mode for mandoc(1);
754 * "Xr" made more compatible with groff;
755 * "Vt" fixed when invoked in SYNOPSIS;
756 * "\\" escape removed;
757 * end-of-line white-space detected for all lines;
758 * subtle bug fixed in list display for some modes;
759 * compatibility layer checked in for compilation in diverse
761 * and column lengths handled correctly.
763 For older releases, see the ChangeLog files
764 in http://mdocml.bsd.lv/snapshots/ .