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