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