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