Annotation of mandoc/NEWS, Revision 1.6.2.1
1.6.2.1 ! schwarze 1: $Id: NEWS,v 1.6 2014/08/11 01:39:00 schwarze Exp $
! 2:
! 3: The 1.12 branch is only adequate for systems requiring makewhatis(8)
! 4: and apropos(1) support but lacking either SQLite3 or fts(3).
! 5: Otherwise, please migrate to the 1.13 branch.
! 6: See the INSTALL file for details.
1.1 schwarze 7:
8: This file lists the most important changes in the mdocml.bsd.lv distribution.
1.5 schwarze 9:
1.6.2.1 ! schwarze 10: Changes in version 1.12.4, released on August 20, 2014
! 11: The following bugfixes are not yet contained in 1.13.1:
! 12:
! 13: * In the mdoc(7) parser, a NULL pointer dereference was fixed for .Bl
! 14: macros having no type and none of -width, -offset, or -compact
! 15: * In the mdoc(7) parser, a NULL pointer dereference was fixed that could
! 16: be triggered by invalid macro sequences like .Bl -hang .It Bo .Sh.
! 17: * In the mdoc(7) parser, an assertion crash was fixed that could be
! 18: triggered by stray .It macros right after .El.
! 19: * In the man(7) parser, a memory leak was fixed that could be triggered
! 20: by certain macros occurring at invalid positions inside .RS and .UR.
! 21: * In all formatters, interpretation of scaling units was corrected.
! 22: * In the escape sequence formatter, an out-of-bounds buffer read access
! 23: was fixed that could be triggered by certain invalid escape sequences.
! 24:
1.5 schwarze 25: Changes in version 1.13.1, released on August 10, 2014
1.6.2.1 ! schwarze 26: The following changes are also contained in 1.12.4:
1.5 schwarze 27:
28: --- MAJOR NEW FEATURES ---
29: * The roff(7) parser now provides an almost complete implementation
30: of numerical expressions.
31: * Warning and error messages have been improved in many ways.
32: Almost all fatal errors were downgraded to normal errors and some
33: even to warnings. Almost all messages now mention the macro where
34: the issue is detected and many indicate the workaround employed.
35: The mandoc(1) manual now includes a list explaining all messages.
36: --- MINOR NEW FEATURES ---
37: * The roff(7) parser now supports the .ami (append to macro with
38: indirectly specified name), .as (append to user-defined
39: string), .dei (define macro with indirectly specified name),
40: .ll (line length), and .rr (remove register) requests.
41: * The roff(7) parser now supports string comparison and numerical
42: conditionals in the .if and .ie requests.
43: * The roff parser now fully supports the \B (validate numerical
44: expression) and partially supports the \w (measure text width)
45: escape sequences.
46: * The terminal formatter now supports the \: (optional line break)
47: escape sequence.
48: * The roff parser now supports expansion of user-defined strings
49: involving indirect references.
50: * The roff(7) parser now handles some pre-defined read-only
51: number registers that occur in the pod2man(1) preamble.
52: * For backward compatibility, the mdoc(7) parser and formatters
53: now support the obsolete macros .En, .Es, .Fr, and .Ot.
54: * The mdoc(7) formatter non partially supports .Bd -centered.
55: * tbl(7) now handles leading and trailing vertical lines.
56: * The build system now provides fallback versions of strcasestr(3)
57: and strsep(3) for systems lacking them.
58: * The mdoc(7) manual now explains how various standards
59: supported by the .St macro are related to each other.
60: --- BUGFIXES ---
61: * In the roff(7) parser, several bugs were fixed with respect
62: to closing conditional blocks on macro lines.
63: * Parsing of roff(7) identifiers and escape sequences was improved
64: in multiple respects.
65: * In the mdoc(7) parser, the handling of defective document
66: prologues was improved in multiple ways.
67: * The mdoc(7) parser no longer skips content before the first section
68: header, and it no longer deletes non-.% content from .Rs blocks.
69: * In the mdoc(7) parser, a crash was fixed related to weird .Sh headers.
70: * In the mdoc(7) parser, handling of .Sm with missing or invalid
71: arguments was corrected.
72: * In the mdoc(7) parser, trailing punctuation at the end of partial
73: implicit macros no longer triggers end-of-sentence spacing.
74: * In the terminal formatter, two crashes were fixed: one triggered by
75: excessive indentation and another by excessively long .Nm arguments.
76: * In the terminal formatter, a floating point rounding bug was
77: fixed that sometimes caused an off-by-one error in indentation.
78: * In the UTF-8 formatter, rendering of accents, breakable hyphens,
79: and non-breakable spaces was corrected.
80: * In the HTML formatter, encoding of special characters was
81: corrected in multiple respects.
82: * In the mdoc(7) formatter, rendering of .Ex and .Rv was
83: improved for various edge cases.
84: * In the mdoc(7) formatter, handling of empty .Bl -inset item
85: heads was improved.
86: * In the man(7) formatter, some bugs were fixed with respect
87: to same-line detection in the context of .TP and .nf macros,
88: and the indentation of .IP and .TP blocks was improved.
89: * The mandoc(3) library no longer prints to stderr.
90: --- THANKS TO ---
91: Abhinav Upadhyay (NetBSD), Andreas Voegele, Anthony Bentley (OpenBSD),
92: Christian Weisgerber (OpenBSD), Havard Eidnes (NetBSD), Jan Stary,
93: Jason McIntyre (OpenBSD), Jeremie Courreges-Anglas (OpenBSD),
94: Joerg Sonnenberger (NetBSD), Juan Francisco Cantero Hurtado (OpenBSD),
95: Marc Espie (OpenBSD), Matthias Scheler (NetBSD), Pascal Stumpf (OpenBSD),
96: Paul Onyschuk (Alpine Linux), Sebastien Marie, Steffen Nurpmeso,
97: Stuart Henderson (OpenBSD), Ted Unangst (OpenBSD), Theo de Raadt (OpenBSD),
98: Thomas Klausner (NetBSD), and Ulrich Spoerlein (FreeBSD)
99: for reporting bugs and missing features.
1.4 schwarze 100:
101: Changes in version 1.12.3, released on December 31, 2013
102:
103: * In the mdoc(7) SYNOPSIS, line breaks and hanging indentation
104: now work correctly for .Fo/.Fa/.Fc and .Fn blocks.
105: Thanks to Franco Fichtner for doing part of the work.
106: * The mdoc(7) .Bk macro got some addititonal bugfixes.
107: * In mdoc(7) macro arguments, double quotes can now be quoted
108: by doubling them, just like in man(7).
109: Thanks to Tsugutomo ENAMI for the patch.
110: * At the end of man(7) macro lines, end-of-sentence spacing
111: now works. Thanks to Franco Fichtner for the patch.
112: * For backward compatibility, the man(7) parser now supports the
113: man-ext .UR/.UE (uniform resource identifier) block macros.
114: * The man(7) parser now handles closing blocks that are not open
115: more gracefully.
116: * The man(7) parser now ignores blank lines right after .SH and .SS.
117: * In the man(7) formatter, reset indentation when leaving a block,
118: not just when entering the next one.
119: * The roff(7) .nr request now supports incrementing and decrementing
120: number registers and stops parsing the number right before the
121: first non-digit character.
122: * The roff(7) parser now supports the alternative escape sequence
123: syntax \C'uXXXX' for Unicode characters.
124: * The roff(7) parser now parses and ignores the .fam (font family)
125: and .hw (hyphenation points) requests and the \d and \u escape
126: sequences.
127: * The roff(7) manual got a new ESCAPE SEQUENCE REFERENCE.
1.1 schwarze 128:
1.2 schwarze 129: Changes in version 1.12.2, released on Oktober 5, 2013
1.1 schwarze 130:
131: * The mdoc(7) to man(7) converter, to be called as mandoc -Tman,
132: is now fully functional.
133: * The mandoc(1) utility now supports the -Ios (default operating system)
134: input option, and the -Tutf8 output mode now actually works.
135: * The mandocdb(8) utility no longer truncates existing databases when
136: starting to build new ones, but only replaces them when the build
137: actually succeeds.
138: * The man(7) parser now supports the PD macro (paragraph distance),
139: and (for GNU man-ext compatibility only) EX (example block) and EE
140: (example end). Plus several bugfixes regarding indentation, line
141: breaks, and vertical spacing, and regarding RS following TP.
142: * The roff(7) parser now supports the \f(BI (bold+italic) font escape,
143: the \z (zero cursor advance) escape and the cc (change control
144: character) and it (input line trap) requests. Plus bugfixes regarding
145: the \t (tab) escape, nested escape sequences, and conditional requests.
146: * In mdoc(7), several bugs were fixed related to UTF-8 output of quoting
147: enclosures, delimiter handling, list indentation and horizontal and
148: vertical spacing, formatting of the Lk, %U, and %C macros, plus some
149: bugfixes related to the handling of syntax errors like badly nested
150: font blocks, stray Ta macros outside column lists, unterminated It Xo
151: blocks, and non-text children of Nm blocks.
152: * In tbl(7), the width of horizontal spans and the vertical spacing
153: around tables was corrected, and in man(7) files, a crash was fixed
154: that was triggered by some particular unclosed T{ macros.
155: * For mandoc developers, we now provide a tbl(3) library manual and
156: gmdiff, a very small, very simplistic groff-versus-mandoc output
157: comparison tool.
1.2 schwarze 158: * Provide this NEWS file.
1.1 schwarze 159:
160: Changes in version 1.12.1, released on March 23, 2012
161:
162: * Significant work on apropos(1) and mandocdb(8). These tools are now
163: much more robust. A whatis(1) implementation is now handled as an
164: apropos(1) mode. These tools are also able to minimally handle
165: pre-formatted pages, that is, those already formatted by another
166: utility such as GNU troff.
167: * The man.cgi(7) script is also now available for wider testing.
168: It interfaces with mandocdb(8) manuals cached by catman(8).
169: HTML output is generated on-the-fly by libmandoc or internal
170: methods to convert pre-formatted pages.
171: * The mailing list archive for the discuss and tech lists are being
172: hosted by Gmane at gmane.comp.tools.mdocml.user and
173: gmane.comp.tools.mdocml.devel, respectively.
174:
175: Changes in version 1.12.0, released on October 8, 2011
176:
177: * This version features a new, work-in-progress mandoc(1) output mode:
178: -Tman. This mode allows a system maintainer to distribute man(7)
179: media for older systems that may not natively support mdoc(7), such
180: as old Solaris systems.
181: * The -Ofragment option was added to mandoc(1)'s -Thtml and -Txhtml modes.
182: * While adding features, an apropos(1) utility has been merged from the
183: mandoc-tools sandbox. This interfaces with mandocdb(8) for semantic
184: search of manual content. apropos(1) is different from the traditional
185: apropos primarily in allowing keyword search (such as for functions,
186: utilities, etc.) and regular expressions. Note that the calling
187: syntax for apropos is likely to change as it settles down.
188: * In documentation news, the mdoc(7) and man(7) manuals have been
189: made considerably more readable by adding MACRO OVERVIEW sections, by
190: moving the gory details of the LANGUAGE SYNTAX to the roff(7) manual,
191: and by moving the very technical MACRO SYNTAX sections down to the
192: bottom of the page.
193: * Furthermore, for tbl(7), the -Tascii mode horizontal spacing of tables
194: was rewritten completely. It is now compatible with groff(1), both
195: with and without frames and rulers.
196: * Nesting of indented blocks is now supported in man(7), and several
197: bugs were fixed regarding indentation and alignment.
198: * The page headers in mdoc(7) are now nicer for very long titles.
199:
200: Changes in version 1.11.7, released on September 2, 2011
201:
202: * Added demandoc(1) utility for stripping away macros and escapes.
203: This replaces the historical deroff(1) utility.
204: * Also improved the mdoc(7) and man(7) manuals.
205:
206: Changes in version 1.11.6, released on August 16, 2011
207:
208: * Handling of tr macro in roff(7) implemented. This makes Perl
209: documentation much more readable. Hyphenation is also now enabled in
210: man(7) format documents. Many other general improvements have been
211: implemented.
212:
213: Changes in version 1.11.5, released on July 24, 2011
214:
215: * Significant eqn(7) improvements. mdocml can now parse arbitrary eqn
216: input (although few GNU extensions are accepted, nor is mixing
217: low-level roff with eqn). See the eqn(7) manual for details.
218: For the time being, equations are rendered as simple in-line text.
219: The equation parser satisfies the language specified in the
220: Second Edition User's Guide:
221: http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps
222:
223: Changes in version 1.11.4, released on July 12, 2011
224:
225: * Bug-fixes and clean-ups across all systems, especially in mandocdb(8)
226: and the man(7) parser. This release was significantly assisted by
227: participants in OpenBSD's c2k11. Thanks!
228:
229: Changes in version 1.11.3, released on May 26, 2011
230:
231: * Introduce locale-encoding of output with the -Tlocale output option and
232: Unicode escaped-character input. See mandoc(1) and mandoc_char(7),
233: respectively, for details. This allows for non-ASCII characters (e.g.,
234: \[u5000]) to be rendered in the locale's encoding, if said environment
235: supports wide-character encoding (if it does not, -Tascii is used
236: instead). Locale support can be turned off at compile time by removing
237: -DUSE_WCHAR in the Makefile, in which case -Tlocale is always a synonym
238: for -Tascii.
239: * Furthermore, multibyte-encoded documents, such as those in UTF-8, may
240: be on-the-fly recoded into mandoc(1) input by using the newly-added
241: preconv(1) utility. Note: in the future, this feature may be
242: integrated into mandoc(1).
243:
244: Changes in version 1.11.2, released on May 12, 2011
245:
246: * Corrected some installation issues in version 1.11.1.
247: * Further migration to libmandoc.
248: * Initial public release (this utility is very much under development)
249: of mandocdb(8). This utility produces keyword databases of manual
250: content, which features semantic querying of manual content.
251:
252: Changes in version 1.11.1, released on April 4, 2011
253:
254: * The earlier libroff, libmdoc, and libman soup have been merged into
255: a single library, libmandoc, which manages all aspects of parsing
256: real manuals, from line-handling to tbl(7) parsing.
257: * As usual, many general fixes and improvements have also occurred.
258: In particular, a great deal of redundancy and superfluous code has
259: been removed with the merging of the backend libraries.
1.3 schwarze 260: * see also the changes in 1.10.10
261:
262: Changes in version 1.10.10, March 20, 2011, NOT released
263:
264: * Initial eqn(7) functionality is in place. For the time being,
265: this is limited to the recognition of equation blocks;
266: future version of mdocml will expand upon this framework.
1.1 schwarze 267:
268: Changes in version 1.10.9, released on January 7, 2011
269:
270: * Many back-end fixes have been implemented: argument handling (quoting),
271: man(7) improvements, error/warning classes, and many more.
272: * Initial tbl(7) functionality (see the "TS", "TE", and "T&" macros in
273: the roff(7) manual) has been merged from tbl.bsd.lv. Output is still
274: minimal, especially for -Thtml and -Txhtml, but manages to at least
275: display data. This means that mandoc(1) now has built-in support
276: for two troff preprocessors via libroff: soelim(1) and tbl(1).
277:
278: Changes in version 1.10.8, released on December 24, 2010
279:
1.3 schwarze 280: * Overhauled the -Thtml and -Txhtml output modes. They now display
1.1 schwarze 281: readable output in arbitrary browsers, including text-based ones like
282: lynx(1). See HTML and XHTML manuals in the DOCUMENTATION section
283: for examples. Attention: available style-sheet classes have been
284: considerably changed! See the example.style.css file for details.
285: Lastly, libmdoc and libman have been cleaned up and reduced in size
286: and complexity.
1.3 schwarze 287: * see also the changes in 1.10.7
288:
289: Changes in version 1.10.7, December 6, 2010, NOT released
290:
291: Significant improvements merged from OpenBSD downstream, including:
292: * many new roff(7) components,
293: * in-line implementation of troff's soelim(1),
294: * broken-block handling,
295: * overhauled error classifications, and
296: * cleaned up handling of error conditions.
1.1 schwarze 297:
298: Changes in version 1.10.6, released on September 27, 2010
299:
300: * Calling conventions for mandoc(1) have changed: -W improved and -f
301: deprecated.
302: * Non-ASCII characters are also now uniformly discarded.
303: * Lots of documentation improvements.
304: * Many incremental fixes accomodating for groff's more interesting
305: productions.
306: * Lastly, pod2man(1) preambles are now fully accepted after some
307: considerable roff(7) and special character support.
308:
309: Changes in version 1.10.5, released on July 27, 2010
310:
311: * Primarily a bug-fix and polish release, but including -Tpdf support
312: in mandoc(1) by way of "Summer of Code". Highlights:
313: * fix "Sm" and "Bd" handling
314: * fix end-of-sentence handling for embedded sentences
315: * polish man(7) documentation
316: * document all mdoc(7) macros
317: * polish mandoc(1) -Tps output
318: * lots of internal clean-ups in character escapes
319: * un-break literal contexts in man(7) documents
320: * improve -Thtml output for -man
321: * add mandoc(1) -Tpdf support
322:
323: Changes in version 1.10.4, released on July 12, 2010
324:
325: * Lots of features developed during both "Summer of Code" and the
326: OpenBSD c2k10 hackathon:
327: * minimal "ds" roff(7) symbols are supported
328: * beautified SYNOPSIS section output
329: * acceptance of scope-block breakage in mdoc(7)
330: * clarify error message status
331: * many minor bug-fixes and formatting issues resolved
1.3 schwarze 332: * see also changes in 1.10.3
333:
334: Changes in version 1.10.3, June 29, 2010, NOT released
335:
336: * variable font-width and paper-size support in mandoc(1) -Tps output
337: * "Bk" mdoc(7) support
1.1 schwarze 338:
339: Changes in version 1.10.2, released on June 19, 2010
340:
341: * Small release featuring text-decoration in -Tps output,
342: a few minor relaxations of errors, and some optimisations.
343:
344: Changes in version 1.10.1, released on June 7, 2010
345:
346: * This primarily focusses on the "Bl" and "It" macros described in
347: mdoc(7). Multi-line column support is now fully compatible with groff,
348: as are implicit list entries for columns.
349: * Removed manuals(7) in favour of http://manpages.bsd.lv.
350: * The way we handle the SYNOPSIS section (see the SYNOPSIS documentation
351: in MANUAL STRUCTURE) has also been considerably simplified compared
352: to groff's method.
353: * Furthermore, the -Owidth=width output option has been added to -Tascii,
354: see mandoc(1).
355: * Lastly, initial PostScript output has been added with the -Tps option
356: to mandoc(1). It's brutally simple at the moment: fixed-font, with no
357: font decorations.
358:
359: Changes in version 1.10.0, released on May 29, 2010
360:
361: * Release consisting of the results from the m2k10 hackathon and up-merge
362: from OpenBSD. This requires a significant note of thanks to Ingo
363: Schwarze (OpenBSD) and Joerg Sonnenberger (NetBSD) for their hard work,
364: and again to Joerg for hosting m2k10. Highlights (mostly cribbed from
365: Ingo's m2k10 report) follow in no particular order:
366: * a libroff preprocessor in front of libmdoc and libman stripping out
367: roff(7) instructions;
368: * end-of-sentence (EOS) detection in free-form and macro lines;
369: * correct handling of tab-separated columnar lists in mdoc(7);
370: * improved main calling routines to optionally use mmap(3) for better
371: performance;
372: * cleaned up exiting when invoked as -Tlint or over multiple files
373: with -fign-errors;
374: * error and warning message handling re-written to be unified for
375: libroff, libmdoc, and libman;
376: * handling of badly-nested explicit-scoped macros;
377: * improved free-form text parsing in libman and libmdoc;
378: * significant GNU troff compatibility improvements in -Tascii,
379: largely in terms of spacing;
380: * a regression framework for making sure the many fragilities of GNU
381: troff aren't trampled in subsequent work;
382: * support for -Tascii breaking at hyphens encountered in free-form text;
383: * and many more minor fixes and improvements
384:
385: Changes in version 1.9.25, released on May 13, 2010
386:
387: * Fixed handling of "\*(Ba" escape.
388: * Backed out -fno-ign-chars (pointless complexity).
389: * Fixed erroneous breaking of literal lines.
390: * Fixed SYNOPSIS breaking lines before non-initial macros.
391: * Changed default section ordering.
392: * Most importantly, the framework for end-of-sentence double-spacing is
393: in place, now implemented for the "end-of-sentence, end-of-line" rule.
394: * This is a stable roll-back point before the mandoc hackathon in Rostock!
395:
396: Changes in version 1.9.24, released on May 9, 2010
397:
398: * Rolled back break-at-hyphen.
399: * -DUGLY is now the default (no feature splits!).
400: * Free-form text is not de-chunked any more: lines are passed
401: whole-sale into the front-end, including whitespace.
402: * Added mailing lists.
403:
404: Changes in version 1.9.23, released on April 7, 2010
405:
406: * mdocml has been linked to the OpenBSD build.
407: * This version incorporates many small changes, mostly from patches
408: by OpenBSD, allowing crufty manuals to slip by with warnings instead
409: of erroring-out.
410: * Some subtle semantic issues, such as punctuation scope, have also
411: been fixed.
412: * Lastly, some issues with -Thtml have been fixed, which prompted an
413: update to the online manual pages style layout.
414:
415: Changes in version 1.9.22, released on March 31, 2010
416:
417: * Adjusted merge of the significant work by Ingo Schwarze
418: in getting "Xo" blocks (block full implicit, e.g., "It"
419: for non-columnar lists) to work properly. This isn't
420: enabled by default: you must specify -DUGLY as a compiler
421: flag (see the Makefile for details).
422:
423: Changes in version 1.9.20, released on March 30, 2010
424:
425: * More efforts to get roff instructions in man(7) documents under
426: control. Note that roff instructions embedded in line-scoped,
427: next-line macros (e.g. "B") are not supported.
428: * Leading punctuation for mdoc(7) macros, such as "Fl ( ( a",
429: are now correctly handled.
430:
431: Changes in version 1.9.18, released on March 27, 2010
432:
433: * Many fixes (largely pertaining to scope)
434: and improvements (e.g., handling of apostrophe-control macros,
435: which fixes the strange "BR" seen in some macro output)
436: to handling roff instructions in man(7) documents.
437:
438: Changes in version 1.9.17, released on March 25, 2010
439:
440: * Accept perlpod(1) standard preamble.
441: * Also accept (and discard) "de", "dei", "am", "ami", and "ig"
442: roff macro blocks.
443:
444: Changes in version 1.9.16, released on March 22, 2010
445:
446: * Inspired by patches and bug reports by Ingo Schwarze,
447: allowed man(7) to accept non-printing elements to be nested
448: within next-line scopes, such as "br" within "B" or "TH",
449: which is valid roff.
450: * Longsoon architecture also noted and Makefile cleaned up.
451:
452: Changes in version 1.9.15, released on February 18, 2010
453:
454: * Moved to our new BSD.lv home.
455: * XHTML is now an acceptable output mode for mandoc(1);
456: * "Xr" made more compatible with groff;
457: * "Vt" fixed when invoked in SYNOPSIS;
458: * "\\" escape removed;
459: * end-of-line white-space detected for all lines;
460: * subtle bug fixed in list display for some modes;
461: * compatibility layer checked in for compilation in diverse
462: UNIX systems;
463: * and column lengths handled correctly.
464:
465: For older releases, see the ChangeLog files
466: in http://mdocml.bsd.lv/snapshots/ .
CVSweb