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