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