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