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