Annotation of mandoc/NEWS, Revision 1.34
1.34 ! schwarze 1: $Id: NEWS,v 1.33 2019/03/06 10:22:57 schwarze Exp $
1.1 schwarze 2:
1.22 schwarze 3: This file lists the most important changes in the mandoc.bsd.lv distribution.
1.33 schwarze 4:
1.34 ! schwarze 5: Changes in version 1.14.5, released on March 10, 2019
! 6:
1.33 schwarze 7: --- MAJOR NEW FEATURES ---
8: * apropos(1): improve POSIX compliance by accepting case-insensitive
9: extended regular expressions by default
10: * new -O tag[=term] output option (open a page at the definition of a term)
11: * tbl(7) -T html: spanning and horizontal and vertical alignment of cells
12: * tbl(7) -T html: draw lines on the edges of table cells
13: * tbl(7) -T utf8: render lines with the Unicode box drawing characters
14: * mandoc is now able to handle the manual pages of the groff package.
15: --- MINOR NEW FEATURES ---
16: * -T html: new option -O toc (table of contents)
17: * -T html: second argument to -O man to support local and remote links
18: * mdoc(7) .Bd -centered now fills the text contained in it
19: * man-ext .SY and .YS macros (synopsis block)
20: * man-ext .TQ macro (tagged paragraph without vertical space before it)
21: * tbl(7) \& explicit alignment indicator
22: * roff(7) .shift, .while, and .return requests
23: * roff(7) .char request (output glyph definition)
24: * roff(7) .nop request (no operation)
25: * roff(7) .ft request: handle the CB, CI, and CR fonts
26: * roff(7) .if c conditional (character available)
27: * roff(7) \\$@ escape sequence (insert all macro arguments, quoted)
28: * roff(7) \*(.T predefined string (interpolate output device name)
29: * roff(7) \[charNNN] escape sequence (for printable ASCII characters)
30: * roff(7) \# escape sequence (line continuation with comment)
31: --- HTML OUTPUT SYNTAX CORRECTIONS ---
32: * Render .br and \p as <br/>, not as an empty <div>.
33: * Render .Pp and .PP as <p> and automatically close it when needed.
34: * Stop writing empty list elements for non-compact .Bl -tag lists.
35: * Do not put <p> inside <a> if .UR or .MT contain .PP.
36: * Implement tooltips purely in CSS rather than abusing title= attributes.
37: --- MINOR FUNCTIONAL IMPROVEMENTS ---
38: * many improvements to the handling of fill and no-fill mode
39: * tbl(7): better column widths in the presence of horizontal spans
40: * several minor improvements to escape sequence handling
41: * several minor improvements to manual font handling
42: * portability: autodetect need for _GNU_SOURCE or _OPENBSD_SOURCE
43: * portability: autodetect whether less(1) supports the -T option
44: * large numbers of bugfixes of diverse kinds
45: --- STRUCTURAL IMPROVEMENTS ---
46: * Disentangle eqn(7) and tbl(7) from other parser header files,
47: and clean up some parser data structures.
48: * Substantially simplify error and warning message infrastructure.
49: --- THANKS TO ---
50: * John Gardner for crucial help implementing tooltips in CSS.
51: * Alexander Bluhm, Raphael Graf, Ted Unangst (OpenBSD)
52: and Daniel Sabogal (Alpine Linux) for patches.
53: * Anthony Bentley and Jason McIntyre (OpenBSD) for documentation patches,
54: suggesting new features, bug reports, and useful discussions.
55: * Kyle Evans and Baptiste Daroussin (FreeBSD) for minor patches.
56: * Pali Rohar for suggesting multiple new features and for reporting
57: several bugs and missing features.
58: * Klemens Nanni (OpenBSD) for suggesting multiple new features.
59: * Kristaps Dzonsons (bsd.lv), Marc Espie (OpenBSD), Adam Kalisz,
60: and Laura Morales for suggesting new features.
61: * Wolfram Schneider and Yuri Pankov (FreeBSD) for reporting missing features.
62: * Edward Tomasz Napierala (FreeBSD) for suggesting a feature improvement.
1.34 ! schwarze 63: * Thomas Klausner (NetBSD) and Sevan Janiyan (SmartOS)
! 64: for bug reports and release testing.
1.33 schwarze 65: * Bryan Steele, Janne Johansson, Kurt Mosiejczuk, Mike Belopuhov, Theo
66: Buehler, Todd Miller (OpenBSD), Andreas Gustafsson, Christos Zoulas,
1.34 ! schwarze 67: Robert Elz (NetBSD), Kurt Jaeger (FreeBSD), Fabio Scotoni, Kelvin
! 68: Sherlock, Mark Harris, Orestis Ioannou, Raf Czlonka, and Sean Farrell
! 69: for bug reports.
! 70: * Ulrich Spoerlein (FreeBSD), Leah Neukirchen (Void Linux),
! 71: Matej Cepl (openSUSE), and Jan Stary (MacOS X) for release testing.
1.33 schwarze 72: * Brian Callahan and Stuart Henderson (OpenBSD) for help
73: with the OpenBSD groff port.
74: * Bertrand Garrigues, Branden Robinson, Ralph Corderoy, and Werner
75: Lemberg (GNU troff) for checking groff patches.
76: * Scott Cheloha, Theo de Raadt (OpenBSD)
77: and Natanael Copa (Alpine Linux) for useful discussions.
1.28 schwarze 78:
1.32 schwarze 79: Changes in version 1.14.4, released on August 8, 2018
1.28 schwarze 80:
81: --- MAJOR NEW FEATURES ---
82: * In ASCII output, render mathematical symbols and greek letters
83: as transliterations conveying the characters' meanings rather
84: than trying to imitate their shape. Consequently, such characters
85: can now be used in portable manual pages. All the same, please
86: limit their use to contexts where they really matter, for example
87: when showing complicated mathematical formulae.
88: * First steps towards better support for small screens in HTML
89: output (responsive design): avoid most style= attributes, in
90: particular all hard-coded indentations and column widths, and
91: provide a better mandoc.css style sheet with a @media query,
92: using em units throughout, and avoiding redundancy in selectors.
93: * Better HTML output with some more fitting HTML elements, eliminating
94: needless class= attributes, and avoiding various HTML syntax errors
95: (element nesting, URL-fragment syntax, duplicate id= attributes).
96: --- MINOR NEW FEATURES ---
97: * When a man(1) argument contains a slash, imply -l like in man-db.
98: * Use TIOCGWINSZ to reduce the default -Owidth and -Oindent during
99: interactive use on terminals narrower than 79 columns.
100: * Generated PostScript files are now more than 50% smaller.
101: * Terminal rendering of eqn(7) is improved in several respects.
102: * Simplified and nicer output from the mdoc(7) .Lk macro, formatting
103: all links in-line, even long ones.
104: * roff(7) \n+ and \n- numerical register auto-increment and -decrement
105: * roff(7) .nr optional third argument (auto-increment step size)
1.29 schwarze 106: * Autodetect in ./configure whether the compiler can use -W and -static,
107: allowing to build on Solaris 10 and 11 without any configure.local.
1.28 schwarze 108: --- RELIABILITY BUGFIXES ---
109: * Only activate UTF-8 output when the user really selected UTF-8,
110: not some other multibyte character encoding.
111: * Prevent excessive .ll arguments from generating infinite output.
1.31 schwarze 112: * Fix out of bounds accesses to parse buffers that could happen when
113: using renamed or user defined macros after roff(7) conditionals.
1.28 schwarze 114: * Avoid an assertion failure in certain .Bl -column lists.
115: * Avoid a NULL pointer access on deroff() failure after '.SS ""'.
116: * Fix a segfault that could be triggered by two invalid .Dt macros.
117: * Fix two syntax errors in generated PDF files.
118: * Properly state the page size in generated PostScript files.
119: * Close a memory leak caused by missing gzclose(3).
120: * Fix misformatting of man(7) documents lacking .SH macros
121: in PostScript and PDF output.
122: * And many minor bugfixes.
123: --- THANKS TO ---
124: * Marc Espie (OpenBSD) for implementing the size reduction of
125: PostScript files, one additional patch for code simplification,
126: and two bug reports.
127: * Theo Buehler (OpenBSD) for a bugfix patch,
128: and Theo de Raadt (OpenBSD) for checking it.
129: * John Gardner for more than a dozen suggestions regarding HTML output.
130: * Mike Williams for teaching me how to use %%DocumentMedia and
131: setpagedevice in PostScript files.
132: * Werner Lemberg (groff) for feedback on mdoc(7) language changes.
133: * Colin Watson (man-db) for feedback on man-db semantics.
134: * Jason McIntyre (OpenBSD) for lots of feedback and suggestions
135: on diagnostic messages and on the documentation.
1.32 schwarze 136: * Thomas Klausner (NetBSD) for suggesting two new style messages
137: and one new feature, for two bug reports, and for release testing.
1.30 schwarze 138: * Leah Neukirchen (Void Linux) for suggesting a new style message,
1.31 schwarze 139: five bug reports, and release testing.
1.28 schwarze 140: * Anthony Bentley (OpenBSD) for reporting multiple bugs and missing
141: features.
142: * Paul Irofti (OpenBSD) and Nate Bargmann for suggesting new features.
1.32 schwarze 143: * Michael Stapelberg (Debian) for bug reports and release testing.
144: * Christian Weisgerber, Jonathan Gray, Stuart Henderson,
145: Ted Unangst (OpenBSD), Takeshi Nakayama (NetBSD),
1.28 schwarze 146: Anton Lazarov, Jakub Klinkovsky, Jan Stary, Jesper Wallin,
147: Will Backmam, and Wolfgang Mueller for bug reports.
148: * Sevan Janiyan (NetBSD) for additions to lib.in.
149: * George Brown for suggesting code simplifications.
150: * David Coppa, Igor Sobrado (OpenBSD), and Alexander Kuleshov
151: for documentation improvements.
152: * Laura Morales and Raf Czlonka for questions resulting in better
153: documentation.
1.32 schwarze 154: * Yuri Pankov (illumos) for release testing.
1.27 schwarze 155:
156: Changes in version 1.14.3, released on August 5, 2017
157:
158: --- BUG FIXES ---
159: * man(7): Do not crash with out-of-bounds read access to a constant
160: array if .sp or a blank line immediately precedes .SS or .SH.
161: * mdoc(7): Do not crash with out-of-bounds read access to a constant
162: array if .sp or a blank line precede the first .Sh macro.
163: * tbl(7): Ignore explicitly specified negative column widths rather than
164: wrapping around to huge numbers and risking memory exhaustion.
165: * man(1): No longer use names that only occur in the SYNOPSIS section.
166: Gets rid of some surprising behaviour and bogus warnings.
167: --- THANKS TO ---
168: Leah Neukirchen (Void Linux), Markus Waldeck (Debian),
169: Peter Bui (nd.edu), and Yuri Pankov (illumos) for bug reports.
1.23 schwarze 170:
1.26 schwarze 171: Changes in version 1.14.2, released on July 28, 2017
1.23 schwarze 172:
173: --- MAJOR NEW FEATURES ---
174: * New mdoc(7) -Tmarkdown output mode.
175: * For -Thtml, implement internal hyperlinks pointing to authoritative
176: definitions of various syntax elements, similar to the ctags(1)-like
177: less(1) :t internal searching in terminal mode.
178: * Provide a superset of the functionality of the former mdoclint(1)
179: utility and a new -Wstyle message level with several new messages,
180: including validity checking of .Xr cross references.
181: * tbl(7): Implement automatic line breaking inside individual table
182: cells, and several other formatting improvements.
183: * eqn(7): Complete rewrite of the lexer, resulting in several bugfixes.
184: * Continue parser unification, in particular allowing generation
185: of syntax tree nodes on the roff(7) level, allowing implementation
186: of many additional roff requests.
187: --- REMOVED FUNCTIONALITY ---
188: * Delete the manpage(1) utility. It was never enabled in any release.
189: * Delete the -Txhtml command line option. It has been an obsolete
190: alias for the -Thtml output mode for more than two years.
191: --- MINOR NEW FEATURES ---
1.25 schwarze 192: * -Tlint now puts parser messages on stdout instead of stderr,
193: making commands like "man -l -Tlint *.1" useful.
1.23 schwarze 194: * mdoc(7): Various .Lk formatting improvements.
1.24 schwarze 195: * mdoc(7) -Thtml: Better CSS for .Bl lists.
1.23 schwarze 196: * man(7): Implement the .MT/.ME block macro (mailto hyperlink).
197: * man(7): Implement the .DT macro (restore default tab positions).
198: * man(7): Improved support for manuals generated with reStructuredText
199: by partial support for the \n[an-margin] number register.
200: * man(7) -Thtml: Support deep linking to .SH and .SS headers.
201: * tbl(7): Implement the "allbox" table option.
202: * tbl(7): Implement the column spacing and the 'w' (minimum column
203: width) layout modifiers.
204: * tbl(7): Significant improvements of the manual page.
205: * eqn(7): Much improved font selection, including recognition of
206: well-known function names, and a few other formatting improvements.
207: * eqn(7) -Thtml: Use <mn> and <mo> in addition to <mi>.
208: * roff(7): Implement the .ce (centering), .mc (margin character),
209: .rj (right justify), .ta (define tab stops), .ti (temporary indent),
210: .als (macro alias), .ec and .eo (escape character control),
211: .po (page offset), and .rn (macro rename) requests.
212: * roff(7) .am: Implement appending to mdoc(7) and man(7) macros.
213: * roff(7): implement the \h (horizontol motion), \l (horizontal
214: line drawing), and \p (break output line) escape sequences,
215: and also several additional character escape sequences.
216: * roff(7): Implement the 'd' conditional (macro or string defined).
217: * man.cgi(8) now uses pledge(2), too.
1.24 schwarze 218: * regress.pl(1): simpler user interface, better summary output,
219: simpler code, and no more recursion.
1.23 schwarze 220: --- THANKS TO ---
221: * Anthony Bentley (OpenBSD) for the implementation of .MT/.ME,
222: reports of many bugs and missing features, and suggestions
223: for a number of feature and documentation improvements.
224: * Sebastien Marie (OpenBSD) for two source code patches and
225: for some useful discussions.
1.26 schwarze 226: * Florian Obser (OpenBSD) for a bugfix patch and a bug report.
1.23 schwarze 227: * Jonathan Gray (OpenBSD) for several bug reports from afl(1)
228: and several more from static analysis tools.
229: * Theo Buehler (OpenBSD) for several bug reports, most from afl(1).
230: * Jason McIntyre (OpenBSD) for many useful discussions about a
231: wide variety of topics, lots of continuous testing, a number of
232: bug reports, and some suggestions for messages and documentation.
233: * Thomas Klausner (NetBSD) for lots of help while migrating
1.26 schwarze 234: mdoclint(1) functionality to mandoc -Tlint, for suggesting
235: several useful new messages, and for release testing.
1.23 schwarze 236: * Reyk Floeter (OpenBSD) and Vsevolod Stakhov (FreeBSD) for
237: suggesting a markdown output mode.
238: * Thomas Guettler for suggesting -Thtml internal hyperlinks.
1.26 schwarze 239: * Yuri Pankov (Illumos) for inspiring new warning messages and
240: for extensive release testing.
1.24 schwarze 241: * Anton Lindqvist and TJ Townsend (both OpenBSD) and Jan Stary
242: for multiple bug reports.
1.26 schwarze 243: * Leah Neukirchen (Void Linux) for bug reports and release testing.
244: * Michael Stapelberg (Debian) for suggesting feature improvements
245: and for release testing.
246: * Martin Natano and Theo de Raadt (both OpenBSD), Andreas Voegele,
247: Gabriel Guzman, Gonzalo Tornaria, Markus Waldeck, and Raf Czlonka
248: for bug reports.
249: * Antoine Jacoutot (OpenBSD) and Steffen Nurpmeso for suggesting
250: feature improvements.
251: * Dag-Erling Smoergrav (FreeBSD) for inspiring new warning messages.
1.24 schwarze 252: * Ted Unangst and Marc Espie (OpenBSD) for providing useful ideas.
1.26 schwarze 253: * Svyatoslav Mishyn (Crux Linux) for release testing.
1.23 schwarze 254: * Carsten Kunze (Heirloom roff) for help keeping mandoc and groff
255: compatible and for committing some of my patches to groff.
1.13 schwarze 256:
1.21 schwarze 257: Changes in version 1.14.1, released on February 21, 2017
1.13 schwarze 258:
259: --- MAJOR NEW FEATURES ---
260: * apropos(1): Reimplement complete semantic search functionality
261: without the dependency on SQLite3, using only POSIX APIs.
262: This comes with a completely new mandoc.db(5) file format.
263: * man(1): Support more than one tag entry for the same search term,
264: plus some minor improvements to the less(1) :t support.
265: * -Thtml: Use real macro names for CSS classes.
266: Systematic cleanup of and many improvements to mandoc.css.
267: * -Thtml: Produce human readable HTML code by using indentation
268: and better line breaks. Improve various HTML elements,
269: and trim several useless ones.
270: * New catman(8) utility, still somewhat experimental.
1.14 schwarze 271: * Now includes a portable version of the OpenBSD mandoc regression
272: suite, see regress/regress.pl.1 for details.
1.13 schwarze 273: --- REMOVED FUNCTIONALITY ---
274: * Operating systems that don't provide mmap(3) are no longer supported.
275: * Drop support for manpath(1). Even if your system has manpath(1),
276: it is simpler to use MANPATH_DEFAULT in configure.local for
277: operating system defaults, man.conf(5) for machine-specific
278: modifications, and ${MANPATH}, -m, and -M for user preferences
279: than to bother with the complexity of manpath(1).
280: * makewhatis(8) -p: No longer warn about missing MLINKS since these
281: are no longer needed for anything.
282: --- MINOR NEW FEATURES ---
283: * mdoc(7): Warn about invalid punctuation and content below NAME.
284: * mdoc(7): Warn about .Xr lacking the second argument (section).
285: * mdoc(7): Warn about violations of the rule "new sentence, new line".
286: * roff(7): Warn about trailing whitespace at the end of comments.
1.21 schwarze 287: * mdoc(7): Improve rendering of double quotes.
1.13 schwarze 288: * mdoc(7): Always do text production in the validator, never in the
289: formatters. Cleaner, simpler, shorter, helps NetBSD apropos(1)
290: and also makes -Ttree output more useful.
1.15 schwarze 291: * -Ttree: Show metadata and some additional node flags.
292: New -Onoval output option to show the unvalidated tree.
1.13 schwarze 293: --- RELIABILITY BUGFIXES ---
294: * man(1): Make "man -l" work with standard input from a pipe or file,
295: as long as standard output is a terminal.
1.21 schwarze 296: * man(7): Fix out of bounds read access if a text node immediately
297: preceded the first .SH header.
1.13 schwarze 298: * mdoc(7): Fix out of bounds read access for .Bl without a type
299: but with a width.
300: * mdoc(7): Fix out of bounds read access for .Bl -column starting
301: with a tab character instead of a child .It macro.
302: * mdoc(7): Fix syntax tree corruption leading to segfaults caused
303: by stray block end macros in nested blocks of mismatching type.
304: * man(1): Fix NULL dereference when the first of multiple pages
305: shown was preformatted.
1.18 schwarze 306: * mdoc(7): Fix syntax tree corruption leading to NULL dereference
307: caused by partial implicit macros inside .Bl -column table cells.
1.13 schwarze 308: * mdoc(7): Fix syntax tree corruption leading to NULL dereference
309: for macro sequences like .Bl .Bl .It Bo .El .It.
1.15 schwarze 310: * mdoc(7): Fix syntax tree corruption leading to NULL dereference
1.13 schwarze 311: caused by .Ta following a nested .Bl -column breaking another block.
1.16 schwarze 312: * mdoc(7): Fix syntax tree corruption sometimes leading to NULL
1.17 schwarze 313: dereference caused by indirectly broken .Nd or .Nm blocks.
1.13 schwarze 314: * mdoc(7) -Thtml: Fix a NULL dereference for .Bl -column with 0 columns.
1.17 schwarze 315: * mdoc(7): Fix NULL dereference in some specific cases of a
316: block-end macro calling another block-end macro.
1.13 schwarze 317: * mdoc(7): Fix NULL dereference if the only child of the head
318: of the first .Sh was an empty in-line macro.
1.19 schwarze 319: * eqn(7): Fix NULL dereference in the terminal formatter
320: for empty matrices and empty square roots.
1.13 schwarze 321: * mdoc(7): Fix an assertion failure for a .Bd without a type that
322: breaks another block.
1.20 schwarze 323: * mdoc(7): Fix an assertion failure that happened for some .Bl -column
324: lists containing a column width of "-4n", "-3n", or "-2n".
1.13 schwarze 325: * mdoc(7): Fix an assertion failure caused by .Bl -column without .It
326: but containing eqn(7) or tbl(7) code.
327: * roff(7): Fix an assertion failure caused by \z\[u00FF] with -Tps/-Tpdf.
328: * roff(7): Fix an assertion failures caused by whitespace inside \o''
329: (overstrike) sequences.
330: * -Thtml: Fix an assertion failure caused by -Oman or -Oincludes of
331: excessive length.
332: --- PORTABILITY IMPROVEMENTS ---
333: * man(1): Do not mix stdio narrow and wide stream orientation
334: on stdout, which could cause output corruption on glibc.
335: * mandoc(1): Autodetect a suitable locale for -Tutf8 mode.
1.21 schwarze 336: * ./configure: Autodetect whether PATH_MAX and O_DIRECTORY are defined.
337: * ./configure: Autodetect if nanosleep(3) needs -lrt.
338: * ./configure: Provide an ${LN} configuration variable.
339: * ./configure: Put compiler arguments that may contain -l at the end.
1.13 schwarze 340: --- MINOR BUGFIXES ---
341: * mdoc(7): Fix SYNOPSIS output if the first child of .Nm is a macro.
342: * mdoc(7) -Thtml: Improve formatting of .Bl -tag with short tags.
343: * man(7) -Thtml: Preserve whitespace in .nf (nofill) mode.
344: * mandoc(1): Error out on invalid output options on the command line.
345: --- STRUCTURAL CHANGES, no functional change ---
346: * Redesign part of the mandoc_html(3) interfaces, making them much
347: easier to use and reducing the amount of code by a few hundred lines.
348: --- THANKS TO ---
349: * Michael Stapelberg (Debian) for designing the new mandocd(8)
1.21 schwarze 350: and parts of the new catman(8), for release testing, and for a
351: number of patches and bug reports.
1.13 schwarze 352: * Baptiste Daroussin (FreeBSD) for profiling the new makewhatis(8)
353: implementation and suggesting an algorithmic improvement which
354: more than doubled performance, and for a few bug reports.
355: * Ed Maste (FreeBSD) for an important patch improving reproducibility
356: of builds in makewhatis(8), and for a few bug reports.
1.21 schwarze 357: * Theo Buehler (OpenBSD) for almost twenty important bug reports,
1.13 schwarze 358: most of them found by systematic afl(1) fuzzing.
359: * Benny Lofgren, David Dahlberg, and in particular Vadim Zhukov
360: for crucial help in getting .Bl -tag CSS formatting fixed.
361: * Svyatoslav Mishyn (Crux Linux) for an initial version of the
1.21 schwarze 362: patch to autodetect a suitable locale for -Tutf8 mode
363: and for release testing.
1.13 schwarze 364: * Jason McIntyre (OpenBSD) for multiple useful discussions
365: and a number of bug reports.
1.21 schwarze 366: * Sevan Janiyan (NetBSD) for extensive release testing and multiple
367: bug reports.
368: * Thomas Klausner and Christos Zoulas (NetBSD), Yuri Pankov (illumos),
369: and Leah Neukirchen (Void Linux) for release testing and bug reports.
370: * Ulrich Spoerlein (FreeBSD) for release testing.
1.13 schwarze 371: * Alexander Bluhm, Andrew Fresh, Antoine Jacoutot, Antony Bentley,
372: Christian Weisgerber, Jonathan Gray, Marc Espie, Martijn van Duren,
373: Stuart Henderson, Ted Unangst, Theo de Raadt (OpenBSD), Abhinav
1.21 schwarze 374: Upadhyay, Kamil Rytarowski (NetBSD), Aaron M. Ucko, Bdale Garbee,
375: Reiner Herrmann, Shane Kerr (Debian), Daniel Sabogal (Alpine Linux),
1.13 schwarze 376: Carsten Kunze (Heirloom roff), Kristaps Dzonsons (bsd.lv),
377: Anton Lindqvist, Jan Stary, Jeremy A. Mates, Mark Patruck,
378: Pavan Maddamsetti, Sean Levy <attila@stalphonsos.com>, and
379: Tiago Silva for bug reports.
380: * Brent Cook, Marc Espie, Philip Guenther, Todd Miller (OpenBSD)
381: and Markus Waldeck for useful discussions.
382: * And as usual, OpenCSW for providing me with a Solaris 9/10/11
383: testing environment.
1.11 schwarze 384:
1.12 schwarze 385: Changes in version 1.13.4, released on July 14, 2016
1.11 schwarze 386:
387: --- MAJOR NEW FEATURES ---
388: * man.conf(5): Design and implement a simpler configuration file format.
389: * man(1): Leverage less(1) -T and :t in a way resembling ctags(1)
390: to jump to the definitions of various terms inside manual pages.
391: * soelim(1): New implementation by Baptiste Daroussin.
1.12 schwarze 392: * privilege limitation: Use OpenBSD pledge(2) or OS X sandbox_init(3)
393: when available.
394: * man.cgi(8): Support short URIs like http://man.openbsd.org/mdoc .
1.11 schwarze 395: * mandoc.css: Use one unified stylesheet rather than three different ones.
396: --- MAJOR FUNCTIONALLY RELEVANT BUGFIXES ---
397: * mdoc(7): Fix multiple aspects of SYNOPSIS .Nm formatting.
398: * man(1): Fix process group handling, avoiding unclean shutdowns.
399: --- PORTABILITY IMPROVEMENTS ---
400: * Correctly use the ohash(3) compatibility implementation
401: even when building without SQLite support.
402: * Add compat glue for building on Solaris 9 and 10.
403: * Let ./configure select a supported RE syntax for word boundaries.
1.12 schwarze 404: * Support LDFLAGS, to be used for example for hardening options.
405: * Avoid mixing putchar(3) and putwchar(3) on the same file descriptor,
406: it resulted in output corruption on some platforms.
1.11 schwarze 407: * Avoid reusing va_lists, use va_copy(3) for better portability.
408: * Do not hardcode the path to the more(1) program.
409: --- MINOR NEW FEATURES ---
410: * roff(7): Implement \n(.$ (number of macro arguments).
411: * roff(7): Fully implement \z (do not advance cursor).
412: * roff(7): Implement the `r' conditional (register exists).
413: * roff(7): Implement \\$* (interpolate all arguments).
414: * roff(7): Parse and ignore \, and \/ (italic corrections).
415: * When there is no -m, no -M, no MANPATH and no /etc/man.conf,
416: fall back to /usr/share/man:/usr/X11R6/man:/usr/local/man.
417: * man(1): Give manuals in purely numerical sections priority over
418: manuals of the same name in sections with an alphabetical suffix.
419: * man.cgi(8): Support "header.html" and "footer.html".
420: * man.cgi(8): Set the "autofocus" attribute on the query text box.
421: * man.cgi(8): Simplify the search form, drop two useless buttons.
1.12 schwarze 422: * man.cgi(8): Delete the pseudo-manpath "mandoc", assume that
423: apropos(1) and man.cgi(8) are installed in the default manpath.
1.11 schwarze 424: --- RELIABILITY BUGFIXES ---
425: * mdoc(7): Avoid a use after free and an assertion failure when nodes
426: are deleted during validation.
427: * mdoc(7): Avoid a NULL pointer access when .Bd has no arguments.
428: * mdoc(7): Avoid a NULL pointer access triggered by mismatching end macros.
429: * mdoc(7): Avoid an assertion when .Fo has no argument.
430: * mdoc(7): Avoid an assertion when .Ta<tab> occurs in .Bl -column.
431: * mdoc(7): Avoid an assertion when a body gets broken and has a tail.
432: * roff(7): Avoid an assertion caused by blanks inside \o.
1.12 schwarze 433: * roff(7): Make .so links to gziped manuals work without mandoc.db(5).
1.11 schwarze 434: * tbl(7): Avoid a use after free when the last line of a layout is empty.
435: * eqn(7): Avoid an infinite loop caused by recursive "define".
436: * makewhatis(8): Avoid a segfault caused by unusual directory structures.
437: * Fix handling of leading, trailing, and double colons in MANPATH and -m.
438: --- MINOR BUGFIXES ---
439: * mdoc(7): Put arguments to end macros of broken partial explicit blocks
440: inside the breaking block.
441: * mdoc(7): Let .Dv force normal font.
442: * mdoc(7): Make trailing whitespace significant in .Bl -tag widths.
443: * mdoc(7): Fix macro interpretation around tabs in .Bl -column.
444: * man(7): Use the default width for .RS without arguments.
445: * man(7): On a new RS nesting level, the saved width starts from
446: the default width, not from the saved width of the previous level.
447: * man(7): Allow .PD in next-line scope.
448: * man(7): Improve handling of empty .HP.
449: * man(7): Improve formatting of .br and .sp inside .HP.
450: * man(7): Do not mistreat empty arguments to font alternating
451: macros as vertical spacing requests.
452: * man(7): Allow fill mode changes in tagged paragraph next-line scope.
453: * man(7): Fix minor bugs in block rewinding and simplify the related code.
454: * man(7): Add missing line breaks before subsection headers.
455: * man(7): Give section and subsection headers hanging indentation.
456: * man(7): Make trailing whitespace significant in .TP widths.
457: * roff(7): Don't allow breaking the output line after hyphens
458: that immediately follow escape sequences.
459: * roff(7): Ignore blank characters at the beginning of conditional blocks.
460: * roff(7): Escape breakable hyphens only after handling input line traps.
461: * roff(7): Reject \[uD800] to \[uDFFF] (surrogates) in the parser.
462: * tbl(7): Allow more than one data field after T} on the same input line.
463: * terminal output: Apply bold and italic to non-ASCII Unicode codepoints.
464: * terminal output: Improve rounding rules for horizontal scaling widths.
465: * HTML output: Render ASCII_NBRSP as " ", not "-".
466: * man(1): Do not match the first part of a name if it continues with a dot.
467: * man(1): Keep working even if the current directory is unusable.
468: * man(1): Better error message when $PAGER is invalid.
469: * makewhatis(8): Improve handling of .Va and .Vt macros.
470: * apropos(1): Print "nothing appropriate" to stderr when appropriate.
471: * apropos(1): Abort with a useful error message when elementary
472: database operations like preparing queries or binding variables fail.
473: --- STRUCTURAL CHANGES, no functional change ---
474: * mdoc(7) and man(7): Unified data structures struct roff_node etc.
475: * mdoc(7) and man(7): Unified node handling library in roff.c.
476: * mdoc(7) and man(7): Seperate validation phase from parsing.
1.12 schwarze 477: * roff(7): Major character table cleanup.
1.11 schwarze 478: * Link with libz rather than forking gunzip(1).
479: --- THANKS TO ---
1.12 schwarze 480: * Baptiste Daroussin (FreeBSD) for the new soelim(1)
481: and for release testing.
1.11 schwarze 482: * Anthony Bentley (OpenBSD) for unifying mandoc.css, two nice
483: patches for man.cgi(8), some documentation patches, some bug
484: reports, and various useful discussions.
485: * Todd Miller (OpenBSD) for lots of help with process group and
486: signal handling, a few patches, some bug reports and some useful
487: discussions.
488: * Jonathan Gray (OpenBSD) for yet more testing with afl(1)
489: again resulting in more than half a dozen important bug reports.
1.12 schwarze 490: * Svyatoslav Mishyn (Crux Linux) for some patches, several bug
491: reports, and extensive release testing.
1.15 schwarze 492: * Leah Neukirchen (Void Linux) for a number of compatibility
1.12 schwarze 493: patches and suggestions and several bug reports.
1.11 schwarze 494: * Christos Zoulas (NetBSD) for a bug fix patch and some useful
495: suggestions for cleanup.
496: * Florian Obser (OpenBSD) for a bugfix patch and some bug reports.
1.12 schwarze 497: * Sevan Janiyan for help with Solaris compatibility and release
498: testing on many platforms.
499: * Jan Holzhueter and OpenCSW in general for help with Solaris
500: compatibility, and for providing me with a Solaris 9/10/11 testing
501: environment.
1.11 schwarze 502: * Michael McConville (OpenBSD) for some simple cleanup patches.
1.12 schwarze 503: * Thomas Klausner (NetBSD) for some bug reports and release testing.
1.11 schwarze 504: * Christian Weisgerber, Dmitrij Czarkoff, Igor Sobrado,
1.12 schwarze 505: Ken Westerback, Marc Espie, Mike Belopuhov, Rafael Neves,
506: Ted Unangst, Tim van der Molen, Theo Buehler, Theo de Raadt
507: (OpenBSD), Kurt Jaeger, Dag Erling Smoergrav (FreeBSD),
508: Joerg Sonnenberger (NetBSD), Carsten Kunze (Heirloom troff),
509: Daniel Levai, Fabian Raetz, Jan Stary, Jean-Yves Migeon,
1.11 schwarze 510: Lorenzo Beretta, Markus Waldeck, Maxim Belooussov, Michael Reed,
511: Peter Bray, and Serguey Parkhomovsky for bug reports and feature
512: suggestions.
513: * Alexander Hall, Andrew Fresh, Antoine Jacoutot, Doug Hogan,
514: Jason McIntyre, Jasper Lievisse Adriaanse, Kent Spillner,
515: Nicholas Marriott, Peter Hessler, Sebastien Marie, Stefan Sperling,
516: and Theo de Raadt (OpenBSD) for helpful discussions and feedback.
1.9 schwarze 517:
518: Changes in version 1.13.3, released on March 13, 2015
519:
520: --- MAJOR NEW FEATURES ---
521: * When a manual is missing from an outdated database, let man(1)
522: show it anyway, using a KISS file system lookup as a fallback.
523: * Use this to always provide man(1), even without database support.
524: * Fatal errors no longer exist. If a file can be opened, mandoc
525: will produce some output; at worst, the output may be almost empty.
526: * New -Wunsupp message level.
527: --- POTENTIONALLY SECURITY RELEVANT BUGFIXES ---
528: * Fix a potential write buffer overrun on incomplete string conditionals.
1.22 schwarze 529: http://mandoc.bsd.lv/cgi-bin/cvsweb/roff.c#rev1.241
1.9 schwarze 530: * Fix a potential write buffer overrun on backslash at EOF in a conditional.
1.22 schwarze 531: http://mandoc.bsd.lv/cgi-bin/cvsweb/roff.c#rev1.247
1.9 schwarze 532: * Fix a use after free sometimes hit when validation deletes a block.
1.22 schwarze 533: http://mandoc.bsd.lv/cgi-bin/cvsweb/mdoc_macro.c#rev1.180
1.9 schwarze 534: --- MAJOR FUNCTIONALLY RELEVANT BUGFIXES ---
535: * Let man(1) show manuals for the current architecture by default,
536: and support the MACHINE environment variable.
537: * Fix the man(1) and apropos(1) -m option, it didn't work at all.
538: * Do not spawn a pager when there is no output.
539: * In makewhatis(8), fix detection of hardlinked manuals on platforms
540: having padding in struct inodev (typically 64bit platforms).
541: --- PORTABILITY IMPROVEMENTS ---
542: * Ignore O_CLOEXEC when the operating system doesn't provide it.
543: * Avoid forward reference to enum type which violates ISO C99.
544: * Support homebrew-style linking on Mac OS X.
545: --- MINOR NEW FEATURES ---
546: * lookup: Accept digit+letter and "n" as section names in man(1),
547: and consistently handle digit+letter in file name extensions.
548: * lookup: Speed up -s/-S by using the "mlinks" rather than the "keys" table.
549: * output: Insert horizontal lines between formatted manual pages.
550: * input: New stricter and more resilient UTF-8 parser.
551: * mdoc(7): Refactor block rewinding for simpler and more robust parsing.
552: * man(7): Use the -Ios option when .TH has less than four arguments.
553: * tbl(7): Implement the "center" option.
554: * tbl(7): New option and format parsers, improved in many respects.
555: * roff(7): Basic implementation of the \o escape sequence (overstrike),
556: and improved rendering of overstrikes in PostScript and PDF output.
557: * Message improvements, in particular for, but not restricted to,
558: eqn(7), tbl(7), and wrong numbers of arguments in mdoc(7) and man(7),
559: in various cases also improving output generated by invalid input.
560: * Delete the -V option. It serves no purpose but keeps confusing people.
561: * gmdiff: Minimal support for Heirloom roff.
562: --- RELIABILITY BUGFIXES ---
563: * tbl(7): Fix a read buffer overrun on 'f' at EOL in a layout.
564: * roff(7): Fix a read buffer overrun on incomplete numerical conditions.
565: * mdoc(7): Fix a NULL pointer access on .Nd followed by an explicit block.
566: * mdoc(7): Fix a NULL pointer access on .It Xo without .Xc.
567: * mdoc(7): Fix a NULL pointer access on .Eo without a tail.
568: * mdoc(7): Fix a NULL pointer access in the validation of empty .St macros.
569: * man(7)/tbl(7): Fix a NULL pointer access on .TS right after .TP.
570: * tbl(7): Fix a NULL pointer access on layout lines without any cells.
571: * eqn(7): Fix NULL pointer accesses in the terminal formatter.
572: * roff(7): Fix a NULL pointer access on trailing \s-/\s+ without an argument.
573: * gz: Fix a potential NULL pointer access after waitpid() failure.
574: * roff(7): Don't let the modulo operator divide by zero.
575: * input: Fix an assertion failure on certain invalid UTF-8 input.
576: * terminal output: Allow arbitrary depth of the font stack (assertion fix).
577: * mdoc(7): Fix assertion failures and endless loops on invalid block closing.
578: * mdoc(7): Fix an assertion failure on .Bl .Sm not followed by .It.
579: * mdoc(7): Fix an assertion failure on .Bl -column ... .El .Ta.
580: * tbl(7): Fix assertion failures by macros inside table data,
581: but do not throw away the macro arguments.
582: * Prevent certain kinds of unreasonable input from producing excessive
583: output, in one case caused by unsigned integer underflow.
584: * Fix a potential memory leak in makewhatis(8) on very long filenames.
585: --- MINOR BUGFIXES ---
586: * mdoc(7): Fix parsing of badly nested blocks with multiple identical blocks.
587: * mdoc(7): Support negative indentations for displays and lists.
588: * mdoc(7): Don't mistreat negative .sp arguments as large positive ones.
589: * mdoc(7): Some spacing fixes for .Eo/.Ec.
590: * man(7): Support negative horizontal widths.
591: * man(7): Do not print out invalid .IP arguments.
592: * man(7): Correctly handle scaling units after .PD.
593: * man(7): Support .RE with an argument.
594: * man(7): Fix restoring indentation after .RS with large negative arguments.
595: * tbl(7): Prevent tables from breaking the filling of preceding text.
596: * tbl(7): Fix vertical spacing at the beginning of tables.
597: * tbl(7): Parser and formatter fixes for line drawing and font modifiers.
598: * tbl(7): Correct handling of blank data lines.
599: * eqn(7): Add sometimes missing whitespace before equation output.
600: * roff(7): Fix vertical scaling, most of it was wrong.
601: * roff(7): Slightly improve \w width measurements.
602: * roff(7): Accept the historic aliases \s10 to \s39 for \s(10 to \s(39.
603: * roff(7): Correctly escape quotes when expanding macro arguments.
604: * roff(7): Correctly handle scaling units in numerical expressions,
605: and some other improvements to the parsing of numerical expressions.
606: * roff(7): Three minor fixes with respect to evaluation of conditionals.
607: * roff(7): Let .it accept numerical expressions, not just constants.
608: * mandoc_char(7): Correct some character names and renderings.
1.10 schwarze 609: * If earlier files set a non-zero exit status, never reset it to zero.
1.9 schwarze 610: --- THANKS TO ---
611: * Jonathan Gray (OpenBSD) for yet more testing with afl (the American
612: Fuzzy Lop security fuzzer), again resulting in many bug reports.
613: * Theo de Raadt (OpenBSD) for suggesting the main new feature (man(1) file
614: system lookup) and for reporting an important bug (pager without output).
615: * Theo Buehler for an important bug report (-s/-S slowness)
616: and for proposing a nice new feature (lines between pages).
617: * Jason McIntyre for an important bug report (hardlink detection)
618: and multiple documentation patches.
619: * Pascal Stumpf (OpenBSD) and Alessandro de Laurenzis for
620: important bug reports (architecture and man -m, respectively).
621: * Thomas Klausner (NetBSD) for proposing a new feature (man(7) -Ios),
622: a bug report, and release testing.
623: * Anthony Bentley, Daniel Dickman, Ted Unangst (OpenBSD) and
624: Kristaps Dzonsons (bsd.lv) for source code patches and bug reports.
625: * Christian Weisgerber (OpenBSD) for more than half a dozen bug reports.
626: * Carsten Kunze (Heirloom troff) for bug reports and release testing.
627: * Antoine Jacoutot (OpenBSD) for release testing.
628: * Alexis Hildebrandt (Homebrew), Baptiste Daroussin (FreeBSD),
629: Jonathan Perkin (SmartOS), Pedro Giffuni (FreeBSD), Svyatoslav
630: Mishyn (Crux Linux), Ulrich Spoerlein (FreeBSD), Jan Stary, Patrick
631: Keshishian, Sebastien Marie, and Steffen Nurpmeso for bug reports.
1.7 schwarze 632:
1.8 schwarze 633: Changes in version 1.13.2, released on December 13, 2014
1.7 schwarze 634:
635: --- MAJOR NEW FEATURES ---
636: * Include an implementation of man(1), the manual page viewer.
637: * Unified set of command line option, each one supported by all
638: command names, including new options -a (format all), -c (no
639: pager), -h (synopsis only), and -w (list filenames).
640: * Support the MANPAGER and PAGER environment variables.
641: * Support gzip'ed manuals by the whole toolset, even as .so targets.
642: * Support UTF-8 and Latin-1 input by the whole toolset, delete preconv(1).
643: * Switch the default output mode from -Tascii to -Tlocale.
644: * Improve -Tascii output for Unicode escape sequences.
645: * Let the -Thtml output mode produce polyglot HTML5.
646: * Many improvements for eqn(7), in particular in-line equations,
647: MathML output in -Thtml mode, and much improved terminal formatting.
648: --- PORTABILITY IMPROVEMENTS ---
649: * Change the build sequence to the usual ./configure; make; make install.
650: * Support ./configure.local for build customizations.
651: * Autodetect wchar, sqlite3, and manpath support.
652: * Provide a fallback version of fts(3) for systems lacking it.
653: * Support choosing alternative binary and manual names.
654: --- MINOR NEW FEATURES ---
655: * Rudimentary implementation of the e, x, and z tbl(7) layout
656: modifiers to equalize, maximize, and ignore the width of columns.
657: * Implement font modifiers in tbl(7) layouts.
658: * Allow comma-separated options in the tbl(7) options line.
659: * Parse and ignore the .pl (page length) roff(7) request.
660: * Implement .An -[no]split for the mdoc(7) -Thtml output mode.
661: * Support bold italic font in PostScript and PDF output.
662: * Warn about commas in function arguments and parentheses in function names.
663: * Warn about botched .Xr ordering and punctuation below SEE ALSO.
664: * Warn about AUTHORS sections without .An macros.
665: * Warn about attempts to call non-callable macros.
666: * New developer documentation manual page mandoc_headers(3).
667: --- BUGFIXES ---
668: * Fix read buffer overrun sometimes triggered by trailing whitespace.
669: * Fix read buffer overrun triggered by certain invalid \H sequences.
670: * Fix NULL pointer access triggered by .Bl without any arguments.
671: * Fix NULL pointer access triggered by .It Nm Fo without .Fc.
672: * Fix NULL pointer access triggered by .Sh Xo .Sh without .Xc.
673: * Fix NULL pointer access triggered by missing .Nm.
674: * Fix an assertion triggered by .It right after .El.
675: * Fix an assertion triggered by .Ec without preceding .Eo.
676: * Fix an assertion triggered by .Sm or .Db with multiple arguments.
677: * Fix assertion failures triggered by very large width arguments.
678: * Fix a division by zero in the roff(7) parser.
679: * Prevent negative arguments to .ll from causing integer underflow.
680: * Correctly autodetect source format even when .Dd is preceded by .ll.
681: * Multiple fixes with respect to .Bd and .Bl -offset and -width.
682: * Many bugfixes with respect to scaling units.
683: * Multiple fixes with respect to delimiter handling by in-line macros.
684: * Multiple fixes with respect to .Pf.
685: * Make \c work properly in no-fill mode.
686: * Stricter syntax checking of Unicode character names.
687: --- THANKS TO ---
688: * Kristaps Dzonsons for rewriting the eqn(7) parser, implementing
689: HTML5 and MathML output, and various other code contributions.
690: * Jonathan Gray (OpenBSD) for extensive testing with afl (the
691: American Fuzzy Lop security fuzzer) resulting in many bug reports.
692: * Anthony Bentley (OpenBSD), Baptiste Daroussin (FreeBSD), Daniel
693: Dickman, Doug Hogan, Jason McIntyre, Theo de Raadt (OpenBSD),
694: and Martin Natano for source code patches.
695: * Carsten Kunze (Heirloom troff), Daniel Levai (Slackware),
696: Garrett D'Amore (illumos), Giovanni Becchis, Matthew Dempsky,
697: Stuart Henderson, Ted Unangst, Todd Miller (OpenBSD), Thomas
698: Klausner (NetBSD), Ulrich Spoerlein (FreeBSD), Justin Haynes,
699: Marcus Merighi, Sebastien Marie, Steffen Nurpmeso and Theo Buehler
700: for bug reports.
1.5 schwarze 701:
702: Changes in version 1.13.1, released on August 10, 2014
703:
704: --- MAJOR NEW FEATURES ---
705: * A complete apropos(1)/makewhatis(8)/man.cgi(8) suite
706: based on SQLite3 is now included.
707: * The roff(7) parser now provides an almost complete implementation
708: of numerical expressions.
709: * Warning and error messages have been improved in many ways.
710: Almost all fatal errors were downgraded to normal errors and some
711: even to warnings. Almost all messages now mention the macro where
712: the issue is detected and many indicate the workaround employed.
713: The mandoc(1) manual now includes a list explaining all messages.
714: --- MINOR NEW FEATURES ---
715: * The roff(7) parser now supports the .ami (append to macro with
716: indirectly specified name), .as (append to user-defined
717: string), .dei (define macro with indirectly specified name),
718: .ll (line length), and .rr (remove register) requests.
719: * The roff(7) parser now supports string comparison and numerical
720: conditionals in the .if and .ie requests.
721: * The roff parser now fully supports the \B (validate numerical
722: expression) and partially supports the \w (measure text width)
723: escape sequences.
724: * The terminal formatter now supports the \: (optional line break)
725: escape sequence.
726: * The roff parser now supports expansion of user-defined strings
727: involving indirect references.
728: * The roff(7) parser now handles some pre-defined read-only
729: number registers that occur in the pod2man(1) preamble.
730: * For backward compatibility, the mdoc(7) parser and formatters
731: now support the obsolete macros .En, .Es, .Fr, and .Ot.
732: * The mdoc(7) formatter non partially supports .Bd -centered.
733: * tbl(7) now handles leading and trailing vertical lines.
734: * The build system now provides fallback versions of strcasestr(3)
735: and strsep(3) for systems lacking them.
736: * The mdoc(7) manual now explains how various standards
737: supported by the .St macro are related to each other.
738: --- BUGFIXES ---
739: * In the roff(7) parser, several bugs were fixed with respect
740: to closing conditional blocks on macro lines.
741: * Parsing of roff(7) identifiers and escape sequences was improved
742: in multiple respects.
743: * In the mdoc(7) parser, the handling of defective document
744: prologues was improved in multiple ways.
745: * The mdoc(7) parser no longer skips content before the first section
746: header, and it no longer deletes non-.% content from .Rs blocks.
747: * In the mdoc(7) parser, a crash was fixed related to weird .Sh headers.
748: * In the mdoc(7) parser, handling of .Sm with missing or invalid
749: arguments was corrected.
750: * In the mdoc(7) parser, trailing punctuation at the end of partial
751: implicit macros no longer triggers end-of-sentence spacing.
752: * In the terminal formatter, two crashes were fixed: one triggered by
753: excessive indentation and another by excessively long .Nm arguments.
754: * In the terminal formatter, a floating point rounding bug was
755: fixed that sometimes caused an off-by-one error in indentation.
756: * In the UTF-8 formatter, rendering of accents, breakable hyphens,
757: and non-breakable spaces was corrected.
758: * In the HTML formatter, encoding of special characters was
759: corrected in multiple respects.
760: * In the mdoc(7) formatter, rendering of .Ex and .Rv was
761: improved for various edge cases.
762: * In the mdoc(7) formatter, handling of empty .Bl -inset item
763: heads was improved.
764: * In the man(7) formatter, some bugs were fixed with respect
765: to same-line detection in the context of .TP and .nf macros,
766: and the indentation of .IP and .TP blocks was improved.
767: * The mandoc(3) library no longer prints to stderr.
768: --- THANKS TO ---
769: Abhinav Upadhyay (NetBSD), Andreas Voegele, Anthony Bentley (OpenBSD),
770: Christian Weisgerber (OpenBSD), Havard Eidnes (NetBSD), Jan Stary,
771: Jason McIntyre (OpenBSD), Jeremie Courreges-Anglas (OpenBSD),
772: Joerg Sonnenberger (NetBSD), Juan Francisco Cantero Hurtado (OpenBSD),
773: Marc Espie (OpenBSD), Matthias Scheler (NetBSD), Pascal Stumpf (OpenBSD),
774: Paul Onyschuk (Alpine Linux), Sebastien Marie, Steffen Nurpmeso,
775: Stuart Henderson (OpenBSD), Ted Unangst (OpenBSD), Theo de Raadt (OpenBSD),
776: Thomas Klausner (NetBSD), and Ulrich Spoerlein (FreeBSD)
777: for reporting bugs and missing features.
1.4 schwarze 778:
779: Changes in version 1.12.3, released on December 31, 2013
780:
781: * In the mdoc(7) SYNOPSIS, line breaks and hanging indentation
782: now work correctly for .Fo/.Fa/.Fc and .Fn blocks.
783: Thanks to Franco Fichtner for doing part of the work.
784: * The mdoc(7) .Bk macro got some addititonal bugfixes.
785: * In mdoc(7) macro arguments, double quotes can now be quoted
786: by doubling them, just like in man(7).
787: Thanks to Tsugutomo ENAMI for the patch.
788: * At the end of man(7) macro lines, end-of-sentence spacing
789: now works. Thanks to Franco Fichtner for the patch.
790: * For backward compatibility, the man(7) parser now supports the
791: man-ext .UR/.UE (uniform resource identifier) block macros.
792: * The man(7) parser now handles closing blocks that are not open
793: more gracefully.
794: * The man(7) parser now ignores blank lines right after .SH and .SS.
795: * In the man(7) formatter, reset indentation when leaving a block,
796: not just when entering the next one.
797: * The roff(7) .nr request now supports incrementing and decrementing
798: number registers and stops parsing the number right before the
799: first non-digit character.
800: * The roff(7) parser now supports the alternative escape sequence
801: syntax \C'uXXXX' for Unicode characters.
802: * The roff(7) parser now parses and ignores the .fam (font family)
803: and .hw (hyphenation points) requests and the \d and \u escape
804: sequences.
805: * The roff(7) manual got a new ESCAPE SEQUENCE REFERENCE.
1.1 schwarze 806:
1.2 schwarze 807: Changes in version 1.12.2, released on Oktober 5, 2013
1.1 schwarze 808:
809: * The mdoc(7) to man(7) converter, to be called as mandoc -Tman,
810: is now fully functional.
811: * The mandoc(1) utility now supports the -Ios (default operating system)
812: input option, and the -Tutf8 output mode now actually works.
813: * The mandocdb(8) utility no longer truncates existing databases when
814: starting to build new ones, but only replaces them when the build
815: actually succeeds.
816: * The man(7) parser now supports the PD macro (paragraph distance),
817: and (for GNU man-ext compatibility only) EX (example block) and EE
818: (example end). Plus several bugfixes regarding indentation, line
819: breaks, and vertical spacing, and regarding RS following TP.
820: * The roff(7) parser now supports the \f(BI (bold+italic) font escape,
821: the \z (zero cursor advance) escape and the cc (change control
822: character) and it (input line trap) requests. Plus bugfixes regarding
823: the \t (tab) escape, nested escape sequences, and conditional requests.
824: * In mdoc(7), several bugs were fixed related to UTF-8 output of quoting
825: enclosures, delimiter handling, list indentation and horizontal and
826: vertical spacing, formatting of the Lk, %U, and %C macros, plus some
827: bugfixes related to the handling of syntax errors like badly nested
828: font blocks, stray Ta macros outside column lists, unterminated It Xo
829: blocks, and non-text children of Nm blocks.
830: * In tbl(7), the width of horizontal spans and the vertical spacing
831: around tables was corrected, and in man(7) files, a crash was fixed
832: that was triggered by some particular unclosed T{ macros.
833: * For mandoc developers, we now provide a tbl(3) library manual and
834: gmdiff, a very small, very simplistic groff-versus-mandoc output
835: comparison tool.
1.2 schwarze 836: * Provide this NEWS file.
1.1 schwarze 837:
838: Changes in version 1.12.1, released on March 23, 2012
839:
840: * Significant work on apropos(1) and mandocdb(8). These tools are now
841: much more robust. A whatis(1) implementation is now handled as an
842: apropos(1) mode. These tools are also able to minimally handle
843: pre-formatted pages, that is, those already formatted by another
844: utility such as GNU troff.
845: * The man.cgi(7) script is also now available for wider testing.
846: It interfaces with mandocdb(8) manuals cached by catman(8).
847: HTML output is generated on-the-fly by libmandoc or internal
848: methods to convert pre-formatted pages.
849: * The mailing list archive for the discuss and tech lists are being
850: hosted by Gmane at gmane.comp.tools.mdocml.user and
851: gmane.comp.tools.mdocml.devel, respectively.
852:
853: Changes in version 1.12.0, released on October 8, 2011
854:
855: * This version features a new, work-in-progress mandoc(1) output mode:
856: -Tman. This mode allows a system maintainer to distribute man(7)
857: media for older systems that may not natively support mdoc(7), such
858: as old Solaris systems.
859: * The -Ofragment option was added to mandoc(1)'s -Thtml and -Txhtml modes.
860: * While adding features, an apropos(1) utility has been merged from the
861: mandoc-tools sandbox. This interfaces with mandocdb(8) for semantic
862: search of manual content. apropos(1) is different from the traditional
863: apropos primarily in allowing keyword search (such as for functions,
864: utilities, etc.) and regular expressions. Note that the calling
865: syntax for apropos is likely to change as it settles down.
866: * In documentation news, the mdoc(7) and man(7) manuals have been
867: made considerably more readable by adding MACRO OVERVIEW sections, by
868: moving the gory details of the LANGUAGE SYNTAX to the roff(7) manual,
869: and by moving the very technical MACRO SYNTAX sections down to the
870: bottom of the page.
871: * Furthermore, for tbl(7), the -Tascii mode horizontal spacing of tables
872: was rewritten completely. It is now compatible with groff(1), both
873: with and without frames and rulers.
874: * Nesting of indented blocks is now supported in man(7), and several
875: bugs were fixed regarding indentation and alignment.
876: * The page headers in mdoc(7) are now nicer for very long titles.
877:
878: Changes in version 1.11.7, released on September 2, 2011
879:
880: * Added demandoc(1) utility for stripping away macros and escapes.
881: This replaces the historical deroff(1) utility.
882: * Also improved the mdoc(7) and man(7) manuals.
883:
884: Changes in version 1.11.6, released on August 16, 2011
885:
886: * Handling of tr macro in roff(7) implemented. This makes Perl
887: documentation much more readable. Hyphenation is also now enabled in
888: man(7) format documents. Many other general improvements have been
889: implemented.
890:
891: Changes in version 1.11.5, released on July 24, 2011
892:
893: * Significant eqn(7) improvements. mdocml can now parse arbitrary eqn
894: input (although few GNU extensions are accepted, nor is mixing
895: low-level roff with eqn). See the eqn(7) manual for details.
896: For the time being, equations are rendered as simple in-line text.
897: The equation parser satisfies the language specified in the
898: Second Edition User's Guide:
899: http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps
900:
901: Changes in version 1.11.4, released on July 12, 2011
902:
903: * Bug-fixes and clean-ups across all systems, especially in mandocdb(8)
904: and the man(7) parser. This release was significantly assisted by
905: participants in OpenBSD's c2k11. Thanks!
906:
907: Changes in version 1.11.3, released on May 26, 2011
908:
909: * Introduce locale-encoding of output with the -Tlocale output option and
910: Unicode escaped-character input. See mandoc(1) and mandoc_char(7),
911: respectively, for details. This allows for non-ASCII characters (e.g.,
912: \[u5000]) to be rendered in the locale's encoding, if said environment
913: supports wide-character encoding (if it does not, -Tascii is used
914: instead). Locale support can be turned off at compile time by removing
915: -DUSE_WCHAR in the Makefile, in which case -Tlocale is always a synonym
916: for -Tascii.
917: * Furthermore, multibyte-encoded documents, such as those in UTF-8, may
918: be on-the-fly recoded into mandoc(1) input by using the newly-added
919: preconv(1) utility. Note: in the future, this feature may be
920: integrated into mandoc(1).
921:
922: Changes in version 1.11.2, released on May 12, 2011
923:
924: * Corrected some installation issues in version 1.11.1.
925: * Further migration to libmandoc.
926: * Initial public release (this utility is very much under development)
927: of mandocdb(8). This utility produces keyword databases of manual
928: content, which features semantic querying of manual content.
929:
930: Changes in version 1.11.1, released on April 4, 2011
931:
932: * The earlier libroff, libmdoc, and libman soup have been merged into
933: a single library, libmandoc, which manages all aspects of parsing
934: real manuals, from line-handling to tbl(7) parsing.
935: * As usual, many general fixes and improvements have also occurred.
936: In particular, a great deal of redundancy and superfluous code has
937: been removed with the merging of the backend libraries.
1.3 schwarze 938: * see also the changes in 1.10.10
939:
940: Changes in version 1.10.10, March 20, 2011, NOT released
941:
942: * Initial eqn(7) functionality is in place. For the time being,
943: this is limited to the recognition of equation blocks;
944: future version of mdocml will expand upon this framework.
1.1 schwarze 945:
946: Changes in version 1.10.9, released on January 7, 2011
947:
948: * Many back-end fixes have been implemented: argument handling (quoting),
949: man(7) improvements, error/warning classes, and many more.
950: * Initial tbl(7) functionality (see the "TS", "TE", and "T&" macros in
951: the roff(7) manual) has been merged from tbl.bsd.lv. Output is still
952: minimal, especially for -Thtml and -Txhtml, but manages to at least
953: display data. This means that mandoc(1) now has built-in support
954: for two troff preprocessors via libroff: soelim(1) and tbl(1).
955:
956: Changes in version 1.10.8, released on December 24, 2010
957:
1.3 schwarze 958: * Overhauled the -Thtml and -Txhtml output modes. They now display
1.1 schwarze 959: readable output in arbitrary browsers, including text-based ones like
960: lynx(1). See HTML and XHTML manuals in the DOCUMENTATION section
961: for examples. Attention: available style-sheet classes have been
962: considerably changed! See the example.style.css file for details.
963: Lastly, libmdoc and libman have been cleaned up and reduced in size
964: and complexity.
1.3 schwarze 965: * see also the changes in 1.10.7
966:
967: Changes in version 1.10.7, December 6, 2010, NOT released
968:
969: Significant improvements merged from OpenBSD downstream, including:
970: * many new roff(7) components,
971: * in-line implementation of troff's soelim(1),
972: * broken-block handling,
973: * overhauled error classifications, and
974: * cleaned up handling of error conditions.
1.1 schwarze 975:
976: Changes in version 1.10.6, released on September 27, 2010
977:
978: * Calling conventions for mandoc(1) have changed: -W improved and -f
979: deprecated.
980: * Non-ASCII characters are also now uniformly discarded.
981: * Lots of documentation improvements.
982: * Many incremental fixes accomodating for groff's more interesting
983: productions.
984: * Lastly, pod2man(1) preambles are now fully accepted after some
985: considerable roff(7) and special character support.
986:
987: Changes in version 1.10.5, released on July 27, 2010
988:
989: * Primarily a bug-fix and polish release, but including -Tpdf support
990: in mandoc(1) by way of "Summer of Code". Highlights:
991: * fix "Sm" and "Bd" handling
992: * fix end-of-sentence handling for embedded sentences
993: * polish man(7) documentation
994: * document all mdoc(7) macros
995: * polish mandoc(1) -Tps output
996: * lots of internal clean-ups in character escapes
997: * un-break literal contexts in man(7) documents
998: * improve -Thtml output for -man
999: * add mandoc(1) -Tpdf support
1000:
1001: Changes in version 1.10.4, released on July 12, 2010
1002:
1003: * Lots of features developed during both "Summer of Code" and the
1004: OpenBSD c2k10 hackathon:
1005: * minimal "ds" roff(7) symbols are supported
1006: * beautified SYNOPSIS section output
1007: * acceptance of scope-block breakage in mdoc(7)
1008: * clarify error message status
1009: * many minor bug-fixes and formatting issues resolved
1.3 schwarze 1010: * see also changes in 1.10.3
1011:
1012: Changes in version 1.10.3, June 29, 2010, NOT released
1013:
1014: * variable font-width and paper-size support in mandoc(1) -Tps output
1015: * "Bk" mdoc(7) support
1.1 schwarze 1016:
1017: Changes in version 1.10.2, released on June 19, 2010
1018:
1019: * Small release featuring text-decoration in -Tps output,
1020: a few minor relaxations of errors, and some optimisations.
1021:
1022: Changes in version 1.10.1, released on June 7, 2010
1023:
1024: * This primarily focusses on the "Bl" and "It" macros described in
1025: mdoc(7). Multi-line column support is now fully compatible with groff,
1026: as are implicit list entries for columns.
1027: * Removed manuals(7) in favour of http://manpages.bsd.lv.
1028: * The way we handle the SYNOPSIS section (see the SYNOPSIS documentation
1029: in MANUAL STRUCTURE) has also been considerably simplified compared
1030: to groff's method.
1031: * Furthermore, the -Owidth=width output option has been added to -Tascii,
1032: see mandoc(1).
1033: * Lastly, initial PostScript output has been added with the -Tps option
1034: to mandoc(1). It's brutally simple at the moment: fixed-font, with no
1035: font decorations.
1036:
1037: Changes in version 1.10.0, released on May 29, 2010
1038:
1039: * Release consisting of the results from the m2k10 hackathon and up-merge
1040: from OpenBSD. This requires a significant note of thanks to Ingo
1041: Schwarze (OpenBSD) and Joerg Sonnenberger (NetBSD) for their hard work,
1042: and again to Joerg for hosting m2k10. Highlights (mostly cribbed from
1043: Ingo's m2k10 report) follow in no particular order:
1044: * a libroff preprocessor in front of libmdoc and libman stripping out
1045: roff(7) instructions;
1046: * end-of-sentence (EOS) detection in free-form and macro lines;
1047: * correct handling of tab-separated columnar lists in mdoc(7);
1048: * improved main calling routines to optionally use mmap(3) for better
1049: performance;
1050: * cleaned up exiting when invoked as -Tlint or over multiple files
1051: with -fign-errors;
1052: * error and warning message handling re-written to be unified for
1053: libroff, libmdoc, and libman;
1054: * handling of badly-nested explicit-scoped macros;
1055: * improved free-form text parsing in libman and libmdoc;
1056: * significant GNU troff compatibility improvements in -Tascii,
1057: largely in terms of spacing;
1058: * a regression framework for making sure the many fragilities of GNU
1059: troff aren't trampled in subsequent work;
1060: * support for -Tascii breaking at hyphens encountered in free-form text;
1061: * and many more minor fixes and improvements
1062:
1063: Changes in version 1.9.25, released on May 13, 2010
1064:
1065: * Fixed handling of "\*(Ba" escape.
1066: * Backed out -fno-ign-chars (pointless complexity).
1067: * Fixed erroneous breaking of literal lines.
1068: * Fixed SYNOPSIS breaking lines before non-initial macros.
1069: * Changed default section ordering.
1070: * Most importantly, the framework for end-of-sentence double-spacing is
1071: in place, now implemented for the "end-of-sentence, end-of-line" rule.
1072: * This is a stable roll-back point before the mandoc hackathon in Rostock!
1073:
1074: Changes in version 1.9.24, released on May 9, 2010
1075:
1076: * Rolled back break-at-hyphen.
1077: * -DUGLY is now the default (no feature splits!).
1078: * Free-form text is not de-chunked any more: lines are passed
1079: whole-sale into the front-end, including whitespace.
1080: * Added mailing lists.
1081:
1082: Changes in version 1.9.23, released on April 7, 2010
1083:
1084: * mdocml has been linked to the OpenBSD build.
1085: * This version incorporates many small changes, mostly from patches
1086: by OpenBSD, allowing crufty manuals to slip by with warnings instead
1087: of erroring-out.
1088: * Some subtle semantic issues, such as punctuation scope, have also
1089: been fixed.
1090: * Lastly, some issues with -Thtml have been fixed, which prompted an
1091: update to the online manual pages style layout.
1092:
1093: Changes in version 1.9.22, released on March 31, 2010
1094:
1095: * Adjusted merge of the significant work by Ingo Schwarze
1096: in getting "Xo" blocks (block full implicit, e.g., "It"
1097: for non-columnar lists) to work properly. This isn't
1098: enabled by default: you must specify -DUGLY as a compiler
1099: flag (see the Makefile for details).
1100:
1101: Changes in version 1.9.20, released on March 30, 2010
1102:
1103: * More efforts to get roff instructions in man(7) documents under
1104: control. Note that roff instructions embedded in line-scoped,
1105: next-line macros (e.g. "B") are not supported.
1106: * Leading punctuation for mdoc(7) macros, such as "Fl ( ( a",
1107: are now correctly handled.
1108:
1109: Changes in version 1.9.18, released on March 27, 2010
1110:
1111: * Many fixes (largely pertaining to scope)
1112: and improvements (e.g., handling of apostrophe-control macros,
1113: which fixes the strange "BR" seen in some macro output)
1114: to handling roff instructions in man(7) documents.
1115:
1116: Changes in version 1.9.17, released on March 25, 2010
1117:
1118: * Accept perlpod(1) standard preamble.
1119: * Also accept (and discard) "de", "dei", "am", "ami", and "ig"
1120: roff macro blocks.
1121:
1122: Changes in version 1.9.16, released on March 22, 2010
1123:
1124: * Inspired by patches and bug reports by Ingo Schwarze,
1125: allowed man(7) to accept non-printing elements to be nested
1126: within next-line scopes, such as "br" within "B" or "TH",
1127: which is valid roff.
1128: * Longsoon architecture also noted and Makefile cleaned up.
1129:
1130: Changes in version 1.9.15, released on February 18, 2010
1131:
1132: * Moved to our new BSD.lv home.
1133: * XHTML is now an acceptable output mode for mandoc(1);
1134: * "Xr" made more compatible with groff;
1135: * "Vt" fixed when invoked in SYNOPSIS;
1136: * "\\" escape removed;
1137: * end-of-line white-space detected for all lines;
1138: * subtle bug fixed in list display for some modes;
1139: * compatibility layer checked in for compilation in diverse
1140: UNIX systems;
1141: * and column lengths handled correctly.
1142:
1143: For older releases, see the ChangeLog files
1.22 schwarze 1144: in http://mandoc.bsd.lv/snapshots/ .
CVSweb