xref: /netbsd-src/external/bsd/mdocml/dist/NEWS (revision 544c191c349c1704c9d5e679d12ec15cff579663)
1*544c191cSchristosId: NEWS,v 1.34 2019/03/10 09:32:00 schwarze Exp
270f041f9Sjoerg
3c9bcef03SchristosThis file lists the most important changes in the mandoc.bsd.lv distribution.
4c9bcef03Schristos
5*544c191cSchristosChanges in version 1.14.5, released on March 10, 2019
6*544c191cSchristos
7*544c191cSchristos    --- MAJOR NEW FEATURES ---
8*544c191cSchristos * apropos(1): improve POSIX compliance by accepting case-insensitive
9*544c191cSchristos   extended regular expressions by default
10*544c191cSchristos * new -O tag[=term] output option (open a page at the definition of a term)
11*544c191cSchristos * tbl(7) -T html: spanning and horizontal and vertical alignment of cells
12*544c191cSchristos * tbl(7) -T html: draw lines on the edges of table cells
13*544c191cSchristos * tbl(7) -T utf8: render lines with the Unicode box drawing characters
14*544c191cSchristos * mandoc is now able to handle the manual pages of the groff package.
15*544c191cSchristos    --- MINOR NEW FEATURES ---
16*544c191cSchristos * -T html: new option -O toc (table of contents)
17*544c191cSchristos * -T html: second argument to -O man to support local and remote links
18*544c191cSchristos * mdoc(7) .Bd -centered now fills the text contained in it
19*544c191cSchristos * man-ext .SY and .YS macros (synopsis block)
20*544c191cSchristos * man-ext .TQ macro (tagged paragraph without vertical space before it)
21*544c191cSchristos * tbl(7) \& explicit alignment indicator
22*544c191cSchristos * roff(7) .shift, .while, and .return requests
23*544c191cSchristos * roff(7) .char request (output glyph definition)
24*544c191cSchristos * roff(7) .nop request (no operation)
25*544c191cSchristos * roff(7) .ft request: handle the CB, CI, and CR fonts
26*544c191cSchristos * roff(7) .if c conditional (character available)
27*544c191cSchristos * roff(7) \\$@ escape sequence (insert all macro arguments, quoted)
28*544c191cSchristos * roff(7) \*(.T predefined string (interpolate output device name)
29*544c191cSchristos * roff(7) \[charNNN] escape sequence (for printable ASCII characters)
30*544c191cSchristos * roff(7) \# escape sequence (line continuation with comment)
31*544c191cSchristos    --- HTML OUTPUT SYNTAX CORRECTIONS ---
32*544c191cSchristos * Render .br and \p as <br/>, not as an empty <div>.
33*544c191cSchristos * Render .Pp and .PP as <p> and automatically close it when needed.
34*544c191cSchristos * Stop writing empty list elements for non-compact .Bl -tag lists.
35*544c191cSchristos * Do not put <p> inside <a> if .UR or .MT contain .PP.
36*544c191cSchristos * Implement tooltips purely in CSS rather than abusing title= attributes.
37*544c191cSchristos    --- MINOR FUNCTIONAL IMPROVEMENTS ---
38*544c191cSchristos * many improvements to the handling of fill and no-fill mode
39*544c191cSchristos * tbl(7): better column widths in the presence of horizontal spans
40*544c191cSchristos * several minor improvements to escape sequence handling
41*544c191cSchristos * several minor improvements to manual font handling
42*544c191cSchristos * portability: autodetect need for _GNU_SOURCE or _OPENBSD_SOURCE
43*544c191cSchristos * portability: autodetect whether less(1) supports the -T option
44*544c191cSchristos * large numbers of bugfixes of diverse kinds
45*544c191cSchristos    --- STRUCTURAL IMPROVEMENTS ---
46*544c191cSchristos * Disentangle eqn(7) and tbl(7) from other parser header files,
47*544c191cSchristos   and clean up some parser data structures.
48*544c191cSchristos * Substantially simplify error and warning message infrastructure.
49*544c191cSchristos    --- THANKS TO ---
50*544c191cSchristos * John Gardner for crucial help implementing tooltips in CSS.
51*544c191cSchristos * Alexander Bluhm, Raphael Graf, Ted Unangst (OpenBSD)
52*544c191cSchristos   and Daniel Sabogal (Alpine Linux) for patches.
53*544c191cSchristos * Anthony Bentley and Jason McIntyre (OpenBSD) for documentation patches,
54*544c191cSchristos   suggesting new features, bug reports, and useful discussions.
55*544c191cSchristos * Kyle Evans and Baptiste Daroussin (FreeBSD) for minor patches.
56*544c191cSchristos * Pali Rohar for suggesting multiple new features and for reporting
57*544c191cSchristos   several bugs and missing features.
58*544c191cSchristos * Klemens Nanni (OpenBSD) for suggesting multiple new features.
59*544c191cSchristos * Kristaps Dzonsons (bsd.lv), Marc Espie (OpenBSD), Adam Kalisz,
60*544c191cSchristos   and Laura Morales for suggesting new features.
61*544c191cSchristos * Wolfram Schneider and Yuri Pankov (FreeBSD) for reporting missing features.
62*544c191cSchristos * Edward Tomasz Napierala (FreeBSD) for suggesting a feature improvement.
63*544c191cSchristos * Thomas Klausner (NetBSD) and Sevan Janiyan (SmartOS)
64*544c191cSchristos   for bug reports and release testing.
65*544c191cSchristos * Bryan Steele, Janne Johansson, Kurt Mosiejczuk, Mike Belopuhov, Theo
66*544c191cSchristos   Buehler, Todd Miller (OpenBSD), Andreas Gustafsson, Christos Zoulas,
67*544c191cSchristos   Robert Elz (NetBSD), Kurt Jaeger (FreeBSD), Fabio Scotoni, Kelvin
68*544c191cSchristos   Sherlock, Mark Harris, Orestis Ioannou, Raf Czlonka, and Sean Farrell
69*544c191cSchristos   for bug reports.
70*544c191cSchristos * Ulrich Spoerlein (FreeBSD), Leah Neukirchen (Void Linux),
71*544c191cSchristos   Matej Cepl (openSUSE), and Jan Stary (MacOS X) for release testing.
72*544c191cSchristos * Brian Callahan and Stuart Henderson (OpenBSD) for help
73*544c191cSchristos   with the OpenBSD groff port.
74*544c191cSchristos * Bertrand Garrigues, Branden Robinson, Ralph Corderoy, and Werner
75*544c191cSchristos   Lemberg (GNU troff) for checking groff patches.
76*544c191cSchristos * Scott Cheloha, Theo de Raadt (OpenBSD)
77*544c191cSchristos   and Natanael Copa (Alpine Linux) for useful discussions.
78*544c191cSchristos
79c9bcef03SchristosChanges in version 1.14.4, released on August 8, 2018
80c9bcef03Schristos
81c9bcef03Schristos    --- MAJOR NEW FEATURES ---
82c9bcef03Schristos * In ASCII output, render mathematical symbols and greek letters
83c9bcef03Schristos   as transliterations conveying the characters' meanings rather
84c9bcef03Schristos   than trying to imitate their shape.  Consequently, such characters
85c9bcef03Schristos   can now be used in portable manual pages.  All the same, please
86c9bcef03Schristos   limit their use to contexts where they really matter, for example
87c9bcef03Schristos   when showing complicated mathematical formulae.
88c9bcef03Schristos * First steps towards better support for small screens in HTML
89c9bcef03Schristos   output (responsive design): avoid most style= attributes, in
90c9bcef03Schristos   particular all hard-coded indentations and column widths, and
91c9bcef03Schristos   provide a better mandoc.css style sheet with a @media query,
92c9bcef03Schristos   using em units throughout, and avoiding redundancy in selectors.
93c9bcef03Schristos * Better HTML output with some more fitting HTML elements, eliminating
94c9bcef03Schristos   needless class= attributes, and avoiding various HTML syntax errors
95c9bcef03Schristos   (element nesting, URL-fragment syntax, duplicate id= attributes).
96c9bcef03Schristos    --- MINOR NEW FEATURES ---
97c9bcef03Schristos * When a man(1) argument contains a slash, imply -l like in man-db.
98c9bcef03Schristos * Use TIOCGWINSZ to reduce the default -Owidth and -Oindent during
99c9bcef03Schristos   interactive use on terminals narrower than 79 columns.
100c9bcef03Schristos * Generated PostScript files are now more than 50% smaller.
101c9bcef03Schristos * Terminal rendering of eqn(7) is improved in several respects.
102c9bcef03Schristos * Simplified and nicer output from the mdoc(7) .Lk macro, formatting
103c9bcef03Schristos   all links in-line, even long ones.
104c9bcef03Schristos * roff(7) \n+ and \n- numerical register auto-increment and -decrement
105c9bcef03Schristos * roff(7) .nr optional third argument (auto-increment step size)
106c9bcef03Schristos * Autodetect in ./configure whether the compiler can use -W and -static,
107c9bcef03Schristos   allowing to build on Solaris 10 and 11 without any configure.local.
108c9bcef03Schristos    --- RELIABILITY BUGFIXES ---
109c9bcef03Schristos * Only activate UTF-8 output when the user really selected UTF-8,
110c9bcef03Schristos   not some other multibyte character encoding.
111c9bcef03Schristos * Prevent excessive .ll arguments from generating infinite output.
112c9bcef03Schristos * Fix out of bounds accesses to parse buffers that could happen when
113c9bcef03Schristos   using renamed or user defined macros after roff(7) conditionals.
114c9bcef03Schristos * Avoid an assertion failure in certain .Bl -column lists.
115c9bcef03Schristos * Avoid a NULL pointer access on deroff() failure after '.SS ""'.
116c9bcef03Schristos * Fix a segfault that could be triggered by two invalid .Dt macros.
117c9bcef03Schristos * Fix two syntax errors in generated PDF files.
118c9bcef03Schristos * Properly state the page size in generated PostScript files.
119c9bcef03Schristos * Close a memory leak caused by missing gzclose(3).
120c9bcef03Schristos * Fix misformatting of man(7) documents lacking .SH macros
121c9bcef03Schristos   in PostScript and PDF output.
122c9bcef03Schristos * And many minor bugfixes.
123c9bcef03Schristos    --- THANKS TO ---
124c9bcef03Schristos * Marc Espie (OpenBSD) for implementing the size reduction of
125c9bcef03Schristos   PostScript files, one additional patch for code simplification,
126c9bcef03Schristos   and two bug reports.
127c9bcef03Schristos * Theo Buehler (OpenBSD) for a bugfix patch,
128c9bcef03Schristos   and Theo de Raadt (OpenBSD) for checking it.
129c9bcef03Schristos * John Gardner for more than a dozen suggestions regarding HTML output.
130c9bcef03Schristos * Mike Williams for teaching me how to use %%DocumentMedia and
131c9bcef03Schristos   setpagedevice in PostScript files.
132c9bcef03Schristos * Werner Lemberg (groff) for feedback on mdoc(7) language changes.
133c9bcef03Schristos * Colin Watson (man-db) for feedback on man-db semantics.
134c9bcef03Schristos * Jason McIntyre (OpenBSD) for lots of feedback and suggestions
135c9bcef03Schristos   on diagnostic messages and on the documentation.
136c9bcef03Schristos * Thomas Klausner (NetBSD) for suggesting two new style messages
137c9bcef03Schristos   and one new feature, for two bug reports, and for release testing.
138c9bcef03Schristos * Leah Neukirchen (Void Linux) for suggesting a new style message,
139c9bcef03Schristos   five bug reports, and release testing.
140c9bcef03Schristos * Anthony Bentley (OpenBSD) for reporting multiple bugs and missing
141c9bcef03Schristos   features.
142c9bcef03Schristos * Paul Irofti (OpenBSD) and Nate Bargmann for suggesting new features.
143c9bcef03Schristos * Michael Stapelberg (Debian) for bug reports and release testing.
144c9bcef03Schristos * Christian Weisgerber, Jonathan Gray, Stuart Henderson,
145c9bcef03Schristos   Ted Unangst (OpenBSD), Takeshi Nakayama (NetBSD),
146c9bcef03Schristos   Anton Lazarov, Jakub Klinkovsky, Jan Stary, Jesper Wallin,
147c9bcef03Schristos   Will Backmam, and Wolfgang Mueller for bug reports.
148c9bcef03Schristos * Sevan Janiyan (NetBSD) for additions to lib.in.
149c9bcef03Schristos * George Brown for suggesting code simplifications.
150c9bcef03Schristos * David Coppa, Igor Sobrado (OpenBSD), and Alexander Kuleshov
151c9bcef03Schristos   for documentation improvements.
152c9bcef03Schristos * Laura Morales and Raf Czlonka for questions resulting in better
153c9bcef03Schristos   documentation.
154c9bcef03Schristos * Yuri Pankov (illumos) for release testing.
155c9bcef03Schristos
156c9bcef03SchristosChanges in version 1.14.3, released on August 5, 2017
157c9bcef03Schristos
158c9bcef03Schristos    --- BUG FIXES ---
159c9bcef03Schristos * man(7): Do not crash with out-of-bounds read access to a constant
160c9bcef03Schristos   array if .sp or a blank line immediately precedes .SS or .SH.
161c9bcef03Schristos * mdoc(7): Do not crash with out-of-bounds read access to a constant
162c9bcef03Schristos   array if .sp or a blank line precede the first .Sh macro.
163c9bcef03Schristos * tbl(7): Ignore explicitly specified negative column widths rather than
164c9bcef03Schristos   wrapping around to huge numbers and risking memory exhaustion.
165c9bcef03Schristos * man(1): No longer use names that only occur in the SYNOPSIS section.
166c9bcef03Schristos   Gets rid of some surprising behaviour and bogus warnings.
167c9bcef03Schristos    --- THANKS TO ---
168c9bcef03Schristos   Leah Neukirchen (Void Linux), Markus Waldeck (Debian),
169c9bcef03Schristos   Peter Bui (nd.edu), and Yuri Pankov (illumos) for bug reports.
170c9bcef03Schristos
171c9bcef03SchristosChanges in version 1.14.2, released on July 28, 2017
172c9bcef03Schristos
173c9bcef03Schristos    --- MAJOR NEW FEATURES ---
174c9bcef03Schristos * New mdoc(7) -Tmarkdown output mode.
175c9bcef03Schristos * For -Thtml, implement internal hyperlinks pointing to authoritative
176c9bcef03Schristos   definitions of various syntax elements, similar to the ctags(1)-like
177c9bcef03Schristos   less(1) :t internal searching in terminal mode.
178c9bcef03Schristos * Provide a superset of the functionality of the former mdoclint(1)
179c9bcef03Schristos   utility and a new -Wstyle message level with several new messages,
180c9bcef03Schristos   including validity checking of .Xr cross references.
181c9bcef03Schristos * tbl(7): Implement automatic line breaking inside individual table
182c9bcef03Schristos   cells, and several other formatting improvements.
183c9bcef03Schristos * eqn(7): Complete rewrite of the lexer, resulting in several bugfixes.
184c9bcef03Schristos * Continue parser unification, in particular allowing generation
185c9bcef03Schristos   of syntax tree nodes on the roff(7) level, allowing implementation
186c9bcef03Schristos   of many additional roff requests.
187c9bcef03Schristos    --- REMOVED FUNCTIONALITY ---
188c9bcef03Schristos * Delete the manpage(1) utility.  It was never enabled in any release.
189c9bcef03Schristos * Delete the -Txhtml command line option.  It has been an obsolete
190c9bcef03Schristos   alias for the -Thtml output mode for more than two years.
191c9bcef03Schristos    --- MINOR NEW FEATURES ---
192c9bcef03Schristos * -Tlint now puts parser messages on stdout instead of stderr,
193c9bcef03Schristos   making commands like "man -l -Tlint *.1" useful.
194c9bcef03Schristos * mdoc(7): Various .Lk formatting improvements.
195c9bcef03Schristos * mdoc(7) -Thtml: Better CSS for .Bl lists.
196c9bcef03Schristos * man(7): Implement the .MT/.ME block macro (mailto hyperlink).
197c9bcef03Schristos * man(7): Implement the .DT macro (restore default tab positions).
198c9bcef03Schristos * man(7): Improved support for manuals generated with reStructuredText
199c9bcef03Schristos   by partial support for the \n[an-margin] number register.
200c9bcef03Schristos * man(7) -Thtml: Support deep linking to .SH and .SS headers.
201c9bcef03Schristos * tbl(7): Implement the "allbox" table option.
202c9bcef03Schristos * tbl(7): Implement the column spacing and the 'w' (minimum column
203c9bcef03Schristos   width) layout modifiers.
204c9bcef03Schristos * tbl(7): Significant improvements of the manual page.
205c9bcef03Schristos * eqn(7): Much improved font selection, including recognition of
206c9bcef03Schristos   well-known function names, and a few other formatting improvements.
207c9bcef03Schristos * eqn(7) -Thtml: Use <mn> and <mo> in addition to <mi>.
208c9bcef03Schristos * roff(7): Implement the .ce (centering), .mc (margin character),
209c9bcef03Schristos   .rj (right justify), .ta (define tab stops), .ti (temporary indent),
210c9bcef03Schristos   .als (macro alias), .ec and .eo (escape character control),
211c9bcef03Schristos   .po (page offset), and .rn (macro rename) requests.
212c9bcef03Schristos * roff(7) .am: Implement appending to mdoc(7) and man(7) macros.
213c9bcef03Schristos * roff(7): implement the \h (horizontol motion), \l (horizontal
214c9bcef03Schristos   line drawing), and \p (break output line) escape sequences,
215c9bcef03Schristos   and also several additional character escape sequences.
216c9bcef03Schristos * roff(7): Implement the 'd' conditional (macro or string defined).
217c9bcef03Schristos * man.cgi(8) now uses pledge(2), too.
218c9bcef03Schristos * regress.pl(1): simpler user interface, better summary output,
219c9bcef03Schristos   simpler code, and no more recursion.
220c9bcef03Schristos    --- THANKS TO ---
221c9bcef03Schristos * Anthony Bentley (OpenBSD) for the implementation of .MT/.ME,
222c9bcef03Schristos   reports of many bugs and missing features, and suggestions
223c9bcef03Schristos   for a number of feature and documentation improvements.
224c9bcef03Schristos * Sebastien Marie (OpenBSD) for two source code patches and
225c9bcef03Schristos   for some useful discussions.
226c9bcef03Schristos * Florian Obser (OpenBSD) for a bugfix patch and a bug report.
227c9bcef03Schristos * Jonathan Gray (OpenBSD) for several bug reports from afl(1)
228c9bcef03Schristos   and several more from static analysis tools.
229c9bcef03Schristos * Theo Buehler (OpenBSD) for several bug reports, most from afl(1).
230c9bcef03Schristos * Jason McIntyre (OpenBSD) for many useful discussions about a
231c9bcef03Schristos   wide variety of topics, lots of continuous testing, a number of
232c9bcef03Schristos   bug reports, and some suggestions for messages and documentation.
233c9bcef03Schristos * Thomas Klausner (NetBSD) for lots of help while migrating
234c9bcef03Schristos   mdoclint(1) functionality to mandoc -Tlint, for suggesting
235c9bcef03Schristos   several useful new messages, and for release testing.
236c9bcef03Schristos * Reyk Floeter (OpenBSD) and Vsevolod Stakhov (FreeBSD) for
237c9bcef03Schristos   suggesting a markdown output mode.
238c9bcef03Schristos * Thomas Guettler for suggesting -Thtml internal hyperlinks.
239c9bcef03Schristos * Yuri Pankov (Illumos) for inspiring new warning messages and
240c9bcef03Schristos   for extensive release testing.
241c9bcef03Schristos * Anton Lindqvist and TJ Townsend (both OpenBSD) and Jan Stary
242c9bcef03Schristos   for multiple bug reports.
243c9bcef03Schristos * Leah Neukirchen (Void Linux) for bug reports and release testing.
244c9bcef03Schristos * Michael Stapelberg (Debian) for suggesting feature improvements
245c9bcef03Schristos   and for release testing.
246c9bcef03Schristos * Martin Natano and Theo de Raadt (both OpenBSD), Andreas Voegele,
247c9bcef03Schristos   Gabriel Guzman, Gonzalo Tornaria, Markus Waldeck, and Raf Czlonka
248c9bcef03Schristos   for bug reports.
249c9bcef03Schristos * Antoine Jacoutot (OpenBSD) and Steffen Nurpmeso for suggesting
250c9bcef03Schristos   feature improvements.
251c9bcef03Schristos * Dag-Erling Smoergrav (FreeBSD) for inspiring new warning messages.
252c9bcef03Schristos * Ted Unangst and Marc Espie (OpenBSD) for providing useful ideas.
253c9bcef03Schristos * Svyatoslav Mishyn (Crux Linux) for release testing.
254c9bcef03Schristos * Carsten Kunze (Heirloom roff) for help keeping mandoc and groff
255c9bcef03Schristos   compatible and for committing some of my patches to groff.
25670f041f9Sjoerg
2579508192eSchristosChanges in version 1.14.1, released on February 21, 2017
2589508192eSchristos
2599508192eSchristos    --- MAJOR NEW FEATURES ---
2609508192eSchristos * apropos(1): Reimplement complete semantic search functionality
2619508192eSchristos   without the dependency on SQLite3, using only POSIX APIs.
2629508192eSchristos   This comes with a completely new mandoc.db(5) file format.
2639508192eSchristos * man(1): Support more than one tag entry for the same search term,
2649508192eSchristos   plus some minor improvements to the less(1) :t support.
2659508192eSchristos * -Thtml: Use real macro names for CSS classes.
2669508192eSchristos   Systematic cleanup of and many improvements to mandoc.css.
2679508192eSchristos * -Thtml: Produce human readable HTML code by using indentation
2689508192eSchristos   and better line breaks.  Improve various HTML elements,
2699508192eSchristos   and trim several useless ones.
2709508192eSchristos * New catman(8) utility, still somewhat experimental.
2719508192eSchristos * Now includes a portable version of the OpenBSD mandoc regression
2729508192eSchristos   suite, see regress/regress.pl.1 for details.
2739508192eSchristos    --- REMOVED FUNCTIONALITY ---
2749508192eSchristos * Operating systems that don't provide mmap(3) are no longer supported.
2759508192eSchristos * Drop support for manpath(1).  Even if your system has manpath(1),
2769508192eSchristos   it is simpler to use MANPATH_DEFAULT in configure.local for
2779508192eSchristos   operating system defaults, man.conf(5) for machine-specific
2789508192eSchristos   modifications, and ${MANPATH}, -m, and -M for user preferences
2799508192eSchristos   than to bother with the complexity of manpath(1).
2809508192eSchristos * makewhatis(8) -p: No longer warn about missing MLINKS since these
2819508192eSchristos   are no longer needed for anything.
2829508192eSchristos    --- MINOR NEW FEATURES ---
2839508192eSchristos * mdoc(7): Warn about invalid punctuation and content below NAME.
2849508192eSchristos * mdoc(7): Warn about .Xr lacking the second argument (section).
2859508192eSchristos * mdoc(7): Warn about violations of the rule "new sentence, new line".
2869508192eSchristos * roff(7): Warn about trailing whitespace at the end of comments.
2879508192eSchristos * mdoc(7): Improve rendering of double quotes.
2889508192eSchristos * mdoc(7): Always do text production in the validator, never in the
2899508192eSchristos   formatters.  Cleaner, simpler, shorter, helps NetBSD apropos(1)
2909508192eSchristos   and also makes -Ttree output more useful.
2919508192eSchristos * -Ttree: Show metadata and some additional node flags.
2929508192eSchristos   New -Onoval output option to show the unvalidated tree.
2939508192eSchristos    --- RELIABILITY BUGFIXES ---
2949508192eSchristos * man(1): Make "man -l" work with standard input from a pipe or file,
2959508192eSchristos   as long as standard output is a terminal.
2969508192eSchristos * man(7): Fix out of bounds read access if a text node immediately
2979508192eSchristos   preceded the first .SH header.
2989508192eSchristos * mdoc(7): Fix out of bounds read access for .Bl without a type
2999508192eSchristos   but with a width.
3009508192eSchristos * mdoc(7): Fix out of bounds read access for .Bl -column starting
3019508192eSchristos   with a tab character instead of a child .It macro.
3029508192eSchristos * mdoc(7): Fix syntax tree corruption leading to segfaults caused
3039508192eSchristos   by stray block end macros in nested blocks of mismatching type.
3049508192eSchristos * man(1): Fix NULL dereference when the first of multiple pages
3059508192eSchristos   shown was preformatted.
3069508192eSchristos * mdoc(7): Fix syntax tree corruption leading to NULL dereference
3079508192eSchristos   caused by partial implicit macros inside .Bl -column table cells.
3089508192eSchristos * mdoc(7): Fix syntax tree corruption leading to NULL dereference
3099508192eSchristos   for macro sequences like .Bl .Bl .It Bo .El .It.
3109508192eSchristos * mdoc(7): Fix syntax tree corruption leading to NULL dereference
3119508192eSchristos   caused by .Ta following a nested .Bl -column breaking another block.
3129508192eSchristos * mdoc(7): Fix syntax tree corruption sometimes leading to NULL
3139508192eSchristos   dereference caused by indirectly broken .Nd or .Nm blocks.
3149508192eSchristos * mdoc(7) -Thtml: Fix a NULL dereference for .Bl -column with 0 columns.
3159508192eSchristos * mdoc(7): Fix NULL dereference in some specific cases of a
3169508192eSchristos   block-end macro calling another block-end macro.
3179508192eSchristos * mdoc(7): Fix NULL dereference if the only child of the head
3189508192eSchristos   of the first .Sh was an empty in-line macro.
3199508192eSchristos * eqn(7): Fix NULL dereference in the terminal formatter
3209508192eSchristos   for empty matrices and empty square roots.
3219508192eSchristos * mdoc(7): Fix an assertion failure for a .Bd without a type that
3229508192eSchristos   breaks another block.
3239508192eSchristos * mdoc(7): Fix an assertion failure that happened for some .Bl -column
3249508192eSchristos   lists containing a column width of "-4n", "-3n", or "-2n".
3259508192eSchristos * mdoc(7): Fix an assertion failure caused by .Bl -column without .It
3269508192eSchristos   but containing eqn(7) or tbl(7) code.
3279508192eSchristos * roff(7): Fix an assertion failure caused by \z\[u00FF] with -Tps/-Tpdf.
3289508192eSchristos * roff(7): Fix an assertion failures caused by whitespace inside \o''
3299508192eSchristos   (overstrike) sequences.
3309508192eSchristos * -Thtml: Fix an assertion failure caused by -Oman or -Oincludes of
3319508192eSchristos   excessive length.
3329508192eSchristos    --- PORTABILITY IMPROVEMENTS ---
3339508192eSchristos * man(1): Do not mix stdio narrow and wide stream orientation
3349508192eSchristos   on stdout, which could cause output corruption on glibc.
3359508192eSchristos * mandoc(1): Autodetect a suitable locale for -Tutf8 mode.
3369508192eSchristos * ./configure: Autodetect whether PATH_MAX and O_DIRECTORY are defined.
3379508192eSchristos * ./configure: Autodetect if nanosleep(3) needs -lrt.
3389508192eSchristos * ./configure: Provide an ${LN} configuration variable.
3399508192eSchristos * ./configure: Put compiler arguments that may contain -l at the end.
3409508192eSchristos    --- MINOR BUGFIXES ---
3419508192eSchristos * mdoc(7): Fix SYNOPSIS output if the first child of .Nm is a macro.
3429508192eSchristos * mdoc(7) -Thtml: Improve formatting of .Bl -tag with short tags.
3439508192eSchristos * man(7) -Thtml: Preserve whitespace in .nf (nofill) mode.
3449508192eSchristos * mandoc(1): Error out on invalid output options on the command line.
3459508192eSchristos    --- STRUCTURAL CHANGES, no functional change ---
3469508192eSchristos * Redesign part of the mandoc_html(3) interfaces, making them much
3479508192eSchristos   easier to use and reducing the amount of code by a few hundred lines.
3489508192eSchristos    --- THANKS TO ---
3499508192eSchristos * Michael Stapelberg (Debian) for designing the new mandocd(8)
3509508192eSchristos   and parts of the new catman(8), for release testing, and for a
3519508192eSchristos   number of patches and bug reports.
3529508192eSchristos * Baptiste Daroussin (FreeBSD) for profiling the new makewhatis(8)
3539508192eSchristos   implementation and suggesting an algorithmic improvement which
3549508192eSchristos   more than doubled performance, and for a few bug reports.
3559508192eSchristos * Ed Maste (FreeBSD) for an important patch improving reproducibility
3569508192eSchristos   of builds in makewhatis(8), and for a few bug reports.
3579508192eSchristos * Theo Buehler (OpenBSD) for almost twenty important bug reports,
3589508192eSchristos   most of them found by systematic afl(1) fuzzing.
3599508192eSchristos * Benny Lofgren, David Dahlberg, and in particular Vadim Zhukov
3609508192eSchristos   for crucial help in getting .Bl -tag CSS formatting fixed.
3619508192eSchristos * Svyatoslav Mishyn (Crux Linux) for an initial version of the
3629508192eSchristos   patch to autodetect a suitable locale for -Tutf8 mode
3639508192eSchristos   and for release testing.
3649508192eSchristos * Jason McIntyre (OpenBSD) for multiple useful discussions
3659508192eSchristos   and a number of bug reports.
3669508192eSchristos * Sevan Janiyan (NetBSD) for extensive release testing and multiple
3679508192eSchristos   bug reports.
3689508192eSchristos * Thomas Klausner and Christos Zoulas (NetBSD), Yuri Pankov (illumos),
3699508192eSchristos   and Leah Neukirchen (Void Linux) for release testing and bug reports.
3709508192eSchristos * Ulrich Spoerlein (FreeBSD) for release testing.
3719508192eSchristos * Alexander Bluhm, Andrew Fresh, Antoine Jacoutot, Antony Bentley,
3729508192eSchristos   Christian Weisgerber, Jonathan Gray, Marc Espie, Martijn van Duren,
3739508192eSchristos   Stuart Henderson, Ted Unangst, Theo de Raadt (OpenBSD), Abhinav
3749508192eSchristos   Upadhyay, Kamil Rytarowski (NetBSD), Aaron M. Ucko, Bdale Garbee,
3759508192eSchristos   Reiner Herrmann, Shane Kerr (Debian), Daniel Sabogal (Alpine Linux),
3769508192eSchristos   Carsten Kunze (Heirloom roff), Kristaps Dzonsons (bsd.lv),
3779508192eSchristos   Anton Lindqvist, Jan Stary, Jeremy A. Mates, Mark Patruck,
3789508192eSchristos   Pavan Maddamsetti, Sean Levy <attila@stalphonsos.com>, and
3799508192eSchristos   Tiago Silva for bug reports.
3809508192eSchristos * Brent Cook, Marc Espie, Philip Guenther, Todd Miller (OpenBSD)
3819508192eSchristos   and Markus Waldeck for useful discussions.
3829508192eSchristos * And as usual, OpenCSW for providing me with a Solaris 9/10/11
3839508192eSchristos   testing environment.
3849508192eSchristos
3859ff1f2acSchristosChanges in version 1.13.4, released on July 14, 2016
3869ff1f2acSchristos
3879ff1f2acSchristos    --- MAJOR NEW FEATURES ---
3889ff1f2acSchristos * man.conf(5): Design and implement a simpler configuration file format.
3899ff1f2acSchristos * man(1): Leverage less(1) -T and :t in a way resembling ctags(1)
3909ff1f2acSchristos   to jump to the definitions of various terms inside manual pages.
3919ff1f2acSchristos * soelim(1): New implementation by Baptiste Daroussin.
3929ff1f2acSchristos * privilege limitation: Use OpenBSD pledge(2) or OS X sandbox_init(3)
3939ff1f2acSchristos   when available.
3949ff1f2acSchristos * man.cgi(8): Support short URIs like http://man.openbsd.org/mdoc .
3959ff1f2acSchristos * mandoc.css: Use one unified stylesheet rather than three different ones.
3969ff1f2acSchristos    --- MAJOR FUNCTIONALLY RELEVANT BUGFIXES ---
3979ff1f2acSchristos * mdoc(7): Fix multiple aspects of SYNOPSIS .Nm formatting.
3989ff1f2acSchristos * man(1): Fix process group handling, avoiding unclean shutdowns.
3999ff1f2acSchristos    --- PORTABILITY IMPROVEMENTS ---
4009ff1f2acSchristos * Correctly use the ohash(3) compatibility implementation
4019ff1f2acSchristos   even when building without SQLite support.
4029ff1f2acSchristos * Add compat glue for building on Solaris 9 and 10.
4039ff1f2acSchristos * Let ./configure select a supported RE syntax for word boundaries.
4049ff1f2acSchristos * Support LDFLAGS, to be used for example for hardening options.
4059ff1f2acSchristos * Avoid mixing putchar(3) and putwchar(3) on the same file descriptor,
4069ff1f2acSchristos   it resulted in output corruption on some platforms.
4079ff1f2acSchristos * Avoid reusing va_lists, use va_copy(3) for better portability.
4089ff1f2acSchristos * Do not hardcode the path to the more(1) program.
4099ff1f2acSchristos    --- MINOR NEW FEATURES ---
4109ff1f2acSchristos * roff(7): Implement \n(.$ (number of macro arguments).
4119ff1f2acSchristos * roff(7): Fully implement \z (do not advance cursor).
4129ff1f2acSchristos * roff(7): Implement the `r'  conditional (register exists).
4139ff1f2acSchristos * roff(7): Implement \\$* (interpolate all arguments).
4149ff1f2acSchristos * roff(7): Parse and ignore \, and \/ (italic corrections).
4159ff1f2acSchristos * When there is no -m, no -M, no MANPATH and no /etc/man.conf,
4169ff1f2acSchristos   fall back to /usr/share/man:/usr/X11R6/man:/usr/local/man.
4179ff1f2acSchristos * man(1): Give manuals in purely numerical sections priority over
4189ff1f2acSchristos   manuals of the same name in sections with an alphabetical suffix.
4199ff1f2acSchristos * man.cgi(8): Support "header.html" and "footer.html".
4209ff1f2acSchristos * man.cgi(8): Set the "autofocus" attribute on the query text box.
4219ff1f2acSchristos * man.cgi(8): Simplify the search form, drop two useless buttons.
4229ff1f2acSchristos * man.cgi(8): Delete the pseudo-manpath "mandoc", assume that
4239ff1f2acSchristos   apropos(1) and man.cgi(8) are installed in the default manpath.
4249ff1f2acSchristos    --- RELIABILITY BUGFIXES ---
4259ff1f2acSchristos * mdoc(7): Avoid a use after free and an assertion failure when nodes
4269ff1f2acSchristos   are deleted during validation.
4279ff1f2acSchristos * mdoc(7): Avoid a NULL pointer access when .Bd has no arguments.
4289ff1f2acSchristos * mdoc(7): Avoid a NULL pointer access triggered by mismatching end macros.
4299ff1f2acSchristos * mdoc(7): Avoid an assertion when .Fo has no argument.
4309ff1f2acSchristos * mdoc(7): Avoid an assertion when .Ta<tab> occurs in .Bl -column.
4319ff1f2acSchristos * mdoc(7): Avoid an assertion when a body gets broken and has a tail.
4329ff1f2acSchristos * roff(7): Avoid an assertion caused by blanks inside \o.
4339ff1f2acSchristos * roff(7): Make .so links to gziped manuals work without mandoc.db(5).
4349ff1f2acSchristos * tbl(7): Avoid a use after free when the last line of a layout is empty.
4359ff1f2acSchristos * eqn(7): Avoid an infinite loop caused by recursive "define".
4369ff1f2acSchristos * makewhatis(8): Avoid a segfault caused by unusual directory structures.
4379ff1f2acSchristos * Fix handling of leading, trailing, and double colons in MANPATH and -m.
4389ff1f2acSchristos    --- MINOR BUGFIXES ---
4399ff1f2acSchristos * mdoc(7): Put arguments to end macros of broken partial explicit blocks
4409ff1f2acSchristos   inside the breaking block.
4419ff1f2acSchristos * mdoc(7): Let .Dv force normal font.
4429ff1f2acSchristos * mdoc(7): Make trailing whitespace significant in .Bl -tag widths.
4439ff1f2acSchristos * mdoc(7): Fix macro interpretation around tabs in .Bl -column.
4449ff1f2acSchristos * man(7): Use the default width for .RS without arguments.
4459ff1f2acSchristos * man(7): On a new RS nesting level, the saved width starts from
4469ff1f2acSchristos   the default width, not from the saved width of the previous level.
4479ff1f2acSchristos * man(7): Allow .PD in next-line scope.
4489ff1f2acSchristos * man(7): Improve handling of empty .HP.
4499ff1f2acSchristos * man(7): Improve formatting of .br and .sp inside .HP.
4509ff1f2acSchristos * man(7): Do not mistreat empty arguments to font alternating
4519ff1f2acSchristos   macros as vertical spacing requests.
4529ff1f2acSchristos * man(7): Allow fill mode changes in tagged paragraph next-line scope.
4539ff1f2acSchristos * man(7): Fix minor bugs in block rewinding and simplify the related code.
4549ff1f2acSchristos * man(7): Add missing line breaks before subsection headers.
4559ff1f2acSchristos * man(7): Give section and subsection headers hanging indentation.
4569ff1f2acSchristos * man(7): Make trailing whitespace significant in .TP widths.
4579ff1f2acSchristos * roff(7): Don't allow breaking the output line after hyphens
4589ff1f2acSchristos   that immediately follow escape sequences.
4599ff1f2acSchristos * roff(7): Ignore blank characters at the beginning of conditional blocks.
4609ff1f2acSchristos * roff(7): Escape breakable hyphens only after handling input line traps.
4619ff1f2acSchristos * roff(7): Reject \[uD800] to \[uDFFF] (surrogates) in the parser.
4629ff1f2acSchristos * tbl(7): Allow more than one data field after T} on the same input line.
4639ff1f2acSchristos * terminal output: Apply bold and italic to non-ASCII Unicode codepoints.
4649ff1f2acSchristos * terminal output: Improve rounding rules for horizontal scaling widths.
4659ff1f2acSchristos * HTML output: Render ASCII_NBRSP as "&nbsp;", not "-".
4669ff1f2acSchristos * man(1): Do not match the first part of a name if it continues with a dot.
4679ff1f2acSchristos * man(1): Keep working even if the current directory is unusable.
4689ff1f2acSchristos * man(1): Better error message when $PAGER is invalid.
4699ff1f2acSchristos * makewhatis(8): Improve handling of .Va and .Vt macros.
4709ff1f2acSchristos * apropos(1): Print "nothing appropriate" to stderr when appropriate.
4719ff1f2acSchristos * apropos(1): Abort with a useful error message when elementary
4729ff1f2acSchristos   database operations like preparing queries or binding variables fail.
4739ff1f2acSchristos    --- STRUCTURAL CHANGES, no functional change ---
4749ff1f2acSchristos * mdoc(7) and man(7): Unified data structures struct roff_node etc.
4759ff1f2acSchristos * mdoc(7) and man(7): Unified node handling library in roff.c.
4769ff1f2acSchristos * mdoc(7) and man(7): Seperate validation phase from parsing.
4779ff1f2acSchristos * roff(7): Major character table cleanup.
4789ff1f2acSchristos * Link with libz rather than forking gunzip(1).
4799ff1f2acSchristos    --- THANKS TO ---
4809ff1f2acSchristos * Baptiste Daroussin (FreeBSD) for the new soelim(1)
4819ff1f2acSchristos   and for release testing.
4829ff1f2acSchristos * Anthony Bentley (OpenBSD) for unifying mandoc.css, two nice
4839ff1f2acSchristos   patches for man.cgi(8), some documentation patches, some bug
4849ff1f2acSchristos   reports, and various useful discussions.
4859ff1f2acSchristos * Todd Miller (OpenBSD) for lots of help with process group and
4869ff1f2acSchristos   signal handling, a few patches, some bug reports and some useful
4879ff1f2acSchristos   discussions.
4889ff1f2acSchristos * Jonathan Gray (OpenBSD) for yet more testing with afl(1)
4899ff1f2acSchristos   again resulting in more than half a dozen important bug reports.
4909ff1f2acSchristos * Svyatoslav Mishyn (Crux Linux) for some patches, several bug
4919ff1f2acSchristos   reports, and extensive release testing.
4929508192eSchristos * Leah Neukirchen (Void Linux) for a number of compatibility
4939ff1f2acSchristos   patches and suggestions and several bug reports.
4949ff1f2acSchristos * Christos Zoulas (NetBSD) for a bug fix patch and some useful
4959ff1f2acSchristos   suggestions for cleanup.
4969ff1f2acSchristos * Florian Obser (OpenBSD) for a bugfix patch and some bug reports.
4979ff1f2acSchristos * Sevan Janiyan for help with Solaris compatibility and release
4989ff1f2acSchristos   testing on many platforms.
4999ff1f2acSchristos * Jan Holzhueter and OpenCSW in general for help with Solaris
5009ff1f2acSchristos   compatibility, and for providing me with a Solaris 9/10/11 testing
5019ff1f2acSchristos   environment.
5029ff1f2acSchristos * Michael McConville (OpenBSD) for some simple cleanup patches.
5039ff1f2acSchristos * Thomas Klausner (NetBSD) for some bug reports and release testing.
5049ff1f2acSchristos * Christian Weisgerber, Dmitrij Czarkoff, Igor Sobrado,
5059ff1f2acSchristos   Ken Westerback, Marc Espie, Mike Belopuhov, Rafael Neves,
5069ff1f2acSchristos   Ted Unangst, Tim van der Molen, Theo Buehler, Theo de Raadt
5079ff1f2acSchristos   (OpenBSD), Kurt Jaeger, Dag Erling Smoergrav (FreeBSD),
5089ff1f2acSchristos   Joerg Sonnenberger (NetBSD), Carsten Kunze (Heirloom troff),
5099ff1f2acSchristos   Daniel Levai, Fabian Raetz, Jan Stary, Jean-Yves Migeon,
5109ff1f2acSchristos   Lorenzo Beretta, Markus Waldeck, Maxim Belooussov, Michael Reed,
5119ff1f2acSchristos   Peter Bray, and Serguey Parkhomovsky for bug reports and feature
5129ff1f2acSchristos   suggestions.
5139ff1f2acSchristos * Alexander Hall, Andrew Fresh, Antoine Jacoutot, Doug Hogan,
5149ff1f2acSchristos   Jason McIntyre, Jasper Lievisse Adriaanse, Kent Spillner,
5159ff1f2acSchristos   Nicholas Marriott, Peter Hessler, Sebastien Marie, Stefan Sperling,
5169ff1f2acSchristos   and Theo de Raadt (OpenBSD) for helpful discussions and feedback.
5179ff1f2acSchristos
518fec65c98SchristosChanges in version 1.13.3, released on March 13, 2015
519fec65c98Schristos
520fec65c98Schristos    --- MAJOR NEW FEATURES ---
521fec65c98Schristos * When a manual is missing from an outdated database, let man(1)
522fec65c98Schristos   show it anyway, using a KISS file system lookup as a fallback.
523fec65c98Schristos * Use this to always provide man(1), even without database support.
524fec65c98Schristos * Fatal errors no longer exist.  If a file can be opened, mandoc
525fec65c98Schristos   will produce some output; at worst, the output may be almost empty.
526fec65c98Schristos * New -Wunsupp message level.
527fec65c98Schristos    --- POTENTIONALLY SECURITY RELEVANT BUGFIXES ---
528fec65c98Schristos * Fix a potential write buffer overrun on incomplete string conditionals.
529c9bcef03Schristos   http://mandoc.bsd.lv/cgi-bin/cvsweb/roff.c#rev1.241
530fec65c98Schristos * Fix a potential write buffer overrun on backslash at EOF in a conditional.
531c9bcef03Schristos   http://mandoc.bsd.lv/cgi-bin/cvsweb/roff.c#rev1.247
532fec65c98Schristos * Fix a use after free sometimes hit when validation deletes a block.
533c9bcef03Schristos   http://mandoc.bsd.lv/cgi-bin/cvsweb/mdoc_macro.c#rev1.180
534fec65c98Schristos    --- MAJOR FUNCTIONALLY RELEVANT BUGFIXES ---
535fec65c98Schristos * Let man(1) show manuals for the current architecture by default,
536fec65c98Schristos   and support the MACHINE environment variable.
537fec65c98Schristos * Fix the man(1) and apropos(1) -m option, it didn't work at all.
538fec65c98Schristos * Do not spawn a pager when there is no output.
539fec65c98Schristos * In makewhatis(8), fix detection of hardlinked manuals on platforms
540fec65c98Schristos   having padding in struct inodev (typically 64bit platforms).
541fec65c98Schristos    --- PORTABILITY IMPROVEMENTS ---
542fec65c98Schristos * Ignore O_CLOEXEC when the operating system doesn't provide it.
543fec65c98Schristos * Avoid forward reference to enum type which violates ISO C99.
544fec65c98Schristos * Support homebrew-style linking on Mac OS X.
545fec65c98Schristos    --- MINOR NEW FEATURES ---
546fec65c98Schristos * lookup: Accept digit+letter and "n" as section names in man(1),
547fec65c98Schristos   and consistently handle digit+letter in file name extensions.
548fec65c98Schristos * lookup: Speed up -s/-S by using the "mlinks" rather than the "keys" table.
549fec65c98Schristos * output: Insert horizontal lines between formatted manual pages.
550fec65c98Schristos * input: New stricter and more resilient UTF-8 parser.
551fec65c98Schristos * mdoc(7): Refactor block rewinding for simpler and more robust parsing.
552fec65c98Schristos * man(7): Use the -Ios option when .TH has less than four arguments.
553fec65c98Schristos * tbl(7): Implement the "center" option.
554fec65c98Schristos * tbl(7): New option and format parsers, improved in many respects.
555fec65c98Schristos * roff(7): Basic implementation of the \o escape sequence (overstrike),
556fec65c98Schristos   and improved rendering of overstrikes in PostScript and PDF output.
557fec65c98Schristos * Message improvements, in particular for, but not restricted to,
558fec65c98Schristos   eqn(7), tbl(7), and wrong numbers of arguments in mdoc(7) and man(7),
559fec65c98Schristos   in various cases also improving output generated by invalid input.
560fec65c98Schristos * Delete the -V option.  It serves no purpose but keeps confusing people.
561fec65c98Schristos * gmdiff: Minimal support for Heirloom roff.
562fec65c98Schristos    --- RELIABILITY BUGFIXES ---
563fec65c98Schristos * tbl(7): Fix a read buffer overrun on 'f' at EOL in a layout.
564fec65c98Schristos * roff(7): Fix a read buffer overrun on incomplete numerical conditions.
565fec65c98Schristos * mdoc(7): Fix a NULL pointer access on .Nd followed by an explicit block.
566fec65c98Schristos * mdoc(7): Fix a NULL pointer access on .It Xo without .Xc.
567fec65c98Schristos * mdoc(7): Fix a NULL pointer access on .Eo without a tail.
568fec65c98Schristos * mdoc(7): Fix a NULL pointer access in the validation of empty .St macros.
569fec65c98Schristos * man(7)/tbl(7): Fix a NULL pointer access on .TS right after .TP.
570fec65c98Schristos * tbl(7): Fix a NULL pointer access on layout lines without any cells.
571fec65c98Schristos * eqn(7): Fix NULL pointer accesses in the terminal formatter.
572fec65c98Schristos * roff(7): Fix a NULL pointer access on trailing \s-/\s+ without an argument.
573fec65c98Schristos * gz: Fix a potential NULL pointer access after waitpid() failure.
574fec65c98Schristos * roff(7): Don't let the modulo operator divide by zero.
575fec65c98Schristos * input: Fix an assertion failure on certain invalid UTF-8 input.
576fec65c98Schristos * terminal output: Allow arbitrary depth of the font stack (assertion fix).
577fec65c98Schristos * mdoc(7): Fix assertion failures and endless loops on invalid block closing.
578fec65c98Schristos * mdoc(7): Fix an assertion failure on .Bl .Sm not followed by .It.
579fec65c98Schristos * mdoc(7): Fix an assertion failure on .Bl -column ... .El .Ta.
580fec65c98Schristos * tbl(7): Fix assertion failures by macros inside table data,
581fec65c98Schristos   but do not throw away the macro arguments.
582fec65c98Schristos * Prevent certain kinds of unreasonable input from producing excessive
583fec65c98Schristos   output, in one case caused by unsigned integer underflow.
584fec65c98Schristos * Fix a potential memory leak in makewhatis(8) on very long filenames.
585fec65c98Schristos    --- MINOR BUGFIXES ---
586fec65c98Schristos * mdoc(7): Fix parsing of badly nested blocks with multiple identical blocks.
587fec65c98Schristos * mdoc(7): Support negative indentations for displays and lists.
588fec65c98Schristos * mdoc(7): Don't mistreat negative .sp arguments as large positive ones.
589fec65c98Schristos * mdoc(7): Some spacing fixes for .Eo/.Ec.
590fec65c98Schristos * man(7): Support negative horizontal widths.
591fec65c98Schristos * man(7): Do not print out invalid .IP arguments.
592fec65c98Schristos * man(7): Correctly handle scaling units after .PD.
593fec65c98Schristos * man(7): Support .RE with an argument.
594fec65c98Schristos * man(7): Fix restoring indentation after .RS with large negative arguments.
595fec65c98Schristos * tbl(7): Prevent tables from breaking the filling of preceding text.
596fec65c98Schristos * tbl(7): Fix vertical spacing at the beginning of tables.
597fec65c98Schristos * tbl(7): Parser and formatter fixes for line drawing and font modifiers.
598fec65c98Schristos * tbl(7): Correct handling of blank data lines.
599fec65c98Schristos * eqn(7): Add sometimes missing whitespace before equation output.
600fec65c98Schristos * roff(7): Fix vertical scaling, most of it was wrong.
601fec65c98Schristos * roff(7): Slightly improve \w width measurements.
602fec65c98Schristos * roff(7): Accept the historic aliases \s10 to \s39 for \s(10 to \s(39.
603fec65c98Schristos * roff(7): Correctly escape quotes when expanding macro arguments.
604fec65c98Schristos * roff(7): Correctly handle scaling units in numerical expressions,
605fec65c98Schristos   and some other improvements to the parsing of numerical expressions.
606fec65c98Schristos * roff(7): Three minor fixes with respect to evaluation of conditionals.
607fec65c98Schristos * roff(7): Let .it accept numerical expressions, not just constants.
608fec65c98Schristos * mandoc_char(7): Correct some character names and renderings.
6099ff1f2acSchristos * If earlier files set a non-zero exit status, never reset it to zero.
610fec65c98Schristos    --- THANKS TO ---
611fec65c98Schristos * Jonathan Gray (OpenBSD) for yet more testing with afl (the American
612fec65c98Schristos   Fuzzy Lop security fuzzer), again resulting in many bug reports.
613fec65c98Schristos * Theo de Raadt (OpenBSD) for suggesting the main new feature (man(1) file
614fec65c98Schristos   system lookup) and for reporting an important bug (pager without output).
615fec65c98Schristos * Theo Buehler for an important bug report (-s/-S slowness)
616fec65c98Schristos   and for proposing a nice new feature (lines between pages).
617fec65c98Schristos * Jason McIntyre for an important bug report (hardlink detection)
618fec65c98Schristos   and multiple documentation patches.
619fec65c98Schristos * Pascal Stumpf (OpenBSD) and Alessandro de Laurenzis for
620fec65c98Schristos   important bug reports (architecture and man -m, respectively).
621fec65c98Schristos * Thomas Klausner (NetBSD) for proposing a new feature (man(7) -Ios),
622fec65c98Schristos   a bug report, and release testing.
623fec65c98Schristos * Anthony Bentley, Daniel Dickman, Ted Unangst (OpenBSD) and
624fec65c98Schristos   Kristaps Dzonsons (bsd.lv) for source code patches and bug reports.
625fec65c98Schristos * Christian Weisgerber (OpenBSD) for more than half a dozen bug reports.
626fec65c98Schristos * Carsten Kunze (Heirloom troff) for bug reports and release testing.
627fec65c98Schristos * Antoine Jacoutot (OpenBSD) for release testing.
628fec65c98Schristos * Alexis Hildebrandt (Homebrew), Baptiste Daroussin (FreeBSD),
629fec65c98Schristos   Jonathan Perkin (SmartOS), Pedro Giffuni (FreeBSD), Svyatoslav
630fec65c98Schristos   Mishyn (Crux Linux), Ulrich Spoerlein (FreeBSD), Jan Stary, Patrick
631fec65c98Schristos   Keshishian, Sebastien Marie, and Steffen Nurpmeso for bug reports.
632fec65c98Schristos
633fec65c98SchristosChanges in version 1.13.2, released on December 13, 2014
634fec65c98Schristos
635fec65c98Schristos    --- MAJOR NEW FEATURES ---
636fec65c98Schristos * Include an implementation of man(1), the manual page viewer.
637fec65c98Schristos * Unified set of command line option, each one supported by all
638fec65c98Schristos   command names, including new options -a (format all), -c (no
639fec65c98Schristos   pager), -h (synopsis only), and -w (list filenames).
640fec65c98Schristos * Support the MANPAGER and PAGER environment variables.
641fec65c98Schristos * Support gzip'ed manuals by the whole toolset, even as .so targets.
642fec65c98Schristos * Support UTF-8 and Latin-1 input by the whole toolset, delete preconv(1).
643fec65c98Schristos * Switch the default output mode from -Tascii to -Tlocale.
644fec65c98Schristos * Improve -Tascii output for Unicode escape sequences.
645fec65c98Schristos * Let the -Thtml output mode produce polyglot HTML5.
646fec65c98Schristos * Many improvements for eqn(7), in particular in-line equations,
647fec65c98Schristos   MathML output in -Thtml mode, and much improved terminal formatting.
648fec65c98Schristos    --- PORTABILITY IMPROVEMENTS ---
649fec65c98Schristos * Change the build sequence to the usual ./configure; make; make install.
650fec65c98Schristos * Support ./configure.local for build customizations.
651fec65c98Schristos * Autodetect wchar, sqlite3, and manpath support.
652fec65c98Schristos * Provide a fallback version of fts(3) for systems lacking it.
653fec65c98Schristos * Support choosing alternative binary and manual names.
654fec65c98Schristos    --- MINOR NEW FEATURES ---
655fec65c98Schristos * Rudimentary implementation of the e, x, and z tbl(7) layout
656fec65c98Schristos   modifiers to equalize, maximize, and ignore the width of columns.
657fec65c98Schristos * Implement font modifiers in tbl(7) layouts.
658fec65c98Schristos * Allow comma-separated options in the tbl(7) options line.
659fec65c98Schristos * Parse and ignore the .pl (page length) roff(7) request.
660fec65c98Schristos * Implement .An -[no]split for the mdoc(7) -Thtml output mode.
661fec65c98Schristos * Support bold italic font in PostScript and PDF output.
662fec65c98Schristos * Warn about commas in function arguments and parentheses in function names.
663fec65c98Schristos * Warn about botched .Xr ordering and punctuation below SEE ALSO.
664fec65c98Schristos * Warn about AUTHORS sections without .An macros.
665fec65c98Schristos * Warn about attempts to call non-callable macros.
666fec65c98Schristos * New developer documentation manual page mandoc_headers(3).
667fec65c98Schristos    --- BUGFIXES ---
668fec65c98Schristos * Fix read buffer overrun sometimes triggered by trailing whitespace.
669fec65c98Schristos * Fix read buffer overrun triggered by certain invalid \H sequences.
670fec65c98Schristos * Fix NULL pointer access triggered by .Bl without any arguments.
671fec65c98Schristos * Fix NULL pointer access triggered by .It Nm Fo without .Fc.
672fec65c98Schristos * Fix NULL pointer access triggered by .Sh Xo .Sh without .Xc.
673fec65c98Schristos * Fix NULL pointer access triggered by missing .Nm.
674fec65c98Schristos * Fix an assertion triggered by .It right after .El.
675fec65c98Schristos * Fix an assertion triggered by .Ec without preceding .Eo.
676fec65c98Schristos * Fix an assertion triggered by .Sm or .Db with multiple arguments.
677fec65c98Schristos * Fix assertion failures triggered by very large width arguments.
678fec65c98Schristos * Fix a division by zero in the roff(7) parser.
679fec65c98Schristos * Prevent negative arguments to .ll from causing integer underflow.
680fec65c98Schristos * Correctly autodetect source format even when .Dd is preceded by .ll.
681fec65c98Schristos * Multiple fixes with respect to .Bd and .Bl -offset and -width.
682fec65c98Schristos * Many bugfixes with respect to scaling units.
683fec65c98Schristos * Multiple fixes with respect to delimiter handling by in-line macros.
684fec65c98Schristos * Multiple fixes with respect to .Pf.
685fec65c98Schristos * Make \c work properly in no-fill mode.
686fec65c98Schristos * Stricter syntax checking of Unicode character names.
687fec65c98Schristos    --- THANKS TO ---
688fec65c98Schristos * Kristaps Dzonsons for rewriting the eqn(7) parser, implementing
689fec65c98Schristos   HTML5 and MathML output, and various other code contributions.
690fec65c98Schristos * Jonathan Gray (OpenBSD) for extensive testing with afl (the
691fec65c98Schristos   American Fuzzy Lop security fuzzer) resulting in many bug reports.
692fec65c98Schristos * Anthony Bentley (OpenBSD), Baptiste Daroussin (FreeBSD), Daniel
693fec65c98Schristos   Dickman, Doug Hogan, Jason McIntyre, Theo de Raadt (OpenBSD),
694fec65c98Schristos   and Martin Natano for source code patches.
695fec65c98Schristos * Carsten Kunze (Heirloom troff), Daniel Levai (Slackware),
696fec65c98Schristos   Garrett D'Amore (illumos), Giovanni Becchis, Matthew Dempsky,
697fec65c98Schristos   Stuart Henderson, Ted Unangst, Todd Miller (OpenBSD), Thomas
698fec65c98Schristos   Klausner (NetBSD), Ulrich Spoerlein (FreeBSD), Justin Haynes,
699fec65c98Schristos   Marcus Merighi, Sebastien Marie, Steffen Nurpmeso and Theo Buehler
700fec65c98Schristos   for bug reports.
701fec65c98Schristos
702fec65c98SchristosChanges in version 1.13.1, released on August 10, 2014
703fec65c98Schristos
704fec65c98Schristos    --- MAJOR NEW FEATURES ---
705fec65c98Schristos * A complete apropos(1)/makewhatis(8)/man.cgi(8) suite
706fec65c98Schristos   based on SQLite3 is now included.
707fec65c98Schristos * The roff(7) parser now provides an almost complete implementation
708fec65c98Schristos   of numerical expressions.
709fec65c98Schristos * Warning and error messages have been improved in many ways.
710fec65c98Schristos   Almost all fatal errors were downgraded to normal errors and some
711fec65c98Schristos   even to warnings.  Almost all messages now mention the macro where
712fec65c98Schristos   the issue is detected and many indicate the workaround employed.
713fec65c98Schristos   The mandoc(1) manual now includes a list explaining all messages.
714fec65c98Schristos    --- MINOR NEW FEATURES ---
715fec65c98Schristos * The roff(7) parser now supports the .ami (append to macro with
716fec65c98Schristos   indirectly specified name), .as (append to user-defined
717fec65c98Schristos   string), .dei (define macro with indirectly specified name),
718fec65c98Schristos   .ll (line length), and .rr (remove register) requests.
719fec65c98Schristos * The roff(7) parser now supports string comparison and numerical
720fec65c98Schristos   conditionals in the .if and .ie requests.
721fec65c98Schristos * The roff parser now fully supports the \B (validate numerical
722fec65c98Schristos   expression) and partially supports the \w (measure text width)
723fec65c98Schristos   escape sequences.
724fec65c98Schristos * The terminal formatter now supports the \: (optional line break)
725fec65c98Schristos   escape sequence.
726fec65c98Schristos * The roff parser now supports expansion of user-defined strings
727fec65c98Schristos   involving indirect references.
728fec65c98Schristos * The roff(7) parser now handles some pre-defined read-only
729fec65c98Schristos   number registers that occur in the pod2man(1) preamble.
730fec65c98Schristos * For backward compatibility, the mdoc(7) parser and formatters
731fec65c98Schristos   now support the obsolete macros .En, .Es, .Fr, and .Ot.
732fec65c98Schristos * The mdoc(7) formatter non partially supports .Bd -centered.
733fec65c98Schristos * tbl(7) now handles leading and trailing vertical lines.
734fec65c98Schristos * The build system now provides fallback versions of strcasestr(3)
735fec65c98Schristos   and strsep(3) for systems lacking them.
736fec65c98Schristos * The mdoc(7) manual now explains how various standards
737fec65c98Schristos   supported by the .St macro are related to each other.
738fec65c98Schristos    --- BUGFIXES ---
739fec65c98Schristos * In the roff(7) parser, several bugs were fixed with respect
740fec65c98Schristos   to closing conditional blocks on macro lines.
741fec65c98Schristos * Parsing of roff(7) identifiers and escape sequences was improved
742fec65c98Schristos   in multiple respects.
743fec65c98Schristos * In the mdoc(7) parser, the handling of defective document
744fec65c98Schristos   prologues was improved in multiple ways.
745fec65c98Schristos * The mdoc(7) parser no longer skips content before the first section
746fec65c98Schristos   header, and it no longer deletes non-.% content from .Rs blocks.
747fec65c98Schristos * In the mdoc(7) parser, a crash was fixed related to weird .Sh headers.
748fec65c98Schristos * In the mdoc(7) parser, handling of .Sm with missing or invalid
749fec65c98Schristos   arguments was corrected.
750fec65c98Schristos * In the mdoc(7) parser, trailing punctuation at the end of partial
751fec65c98Schristos   implicit macros no longer triggers end-of-sentence spacing.
752fec65c98Schristos * In the terminal formatter, two crashes were fixed: one triggered by
753fec65c98Schristos   excessive indentation and another by excessively long .Nm arguments.
754fec65c98Schristos * In the terminal formatter, a floating point rounding bug was
755fec65c98Schristos   fixed that sometimes caused an off-by-one error in indentation.
756fec65c98Schristos * In the UTF-8 formatter, rendering of accents, breakable hyphens,
757fec65c98Schristos   and non-breakable spaces was corrected.
758fec65c98Schristos * In the HTML formatter, encoding of special characters was
759fec65c98Schristos   corrected in multiple respects.
760fec65c98Schristos * In the mdoc(7) formatter, rendering of .Ex and .Rv was
761fec65c98Schristos   improved for various edge cases.
762fec65c98Schristos * In the mdoc(7) formatter, handling of empty .Bl -inset item
763fec65c98Schristos   heads was improved.
764fec65c98Schristos * In the man(7) formatter, some bugs were fixed with respect
765fec65c98Schristos   to same-line detection in the context of .TP and .nf macros,
766fec65c98Schristos   and the indentation of .IP and .TP blocks was improved.
767fec65c98Schristos * The mandoc(3) library no longer prints to stderr.
768fec65c98Schristos    --- THANKS TO ---
769fec65c98Schristos   Abhinav Upadhyay (NetBSD), Andreas Voegele, Anthony Bentley (OpenBSD),
770fec65c98Schristos   Christian Weisgerber (OpenBSD), Havard Eidnes (NetBSD), Jan Stary,
771fec65c98Schristos   Jason McIntyre (OpenBSD), Jeremie Courreges-Anglas (OpenBSD),
772fec65c98Schristos   Joerg Sonnenberger (NetBSD), Juan Francisco Cantero Hurtado (OpenBSD),
773fec65c98Schristos   Marc Espie (OpenBSD), Matthias Scheler (NetBSD), Pascal Stumpf (OpenBSD),
774fec65c98Schristos   Paul Onyschuk (Alpine Linux), Sebastien Marie, Steffen Nurpmeso,
775fec65c98Schristos   Stuart Henderson (OpenBSD), Ted Unangst (OpenBSD), Theo de Raadt (OpenBSD),
776fec65c98Schristos   Thomas Klausner (NetBSD), and Ulrich Spoerlein (FreeBSD)
777fec65c98Schristos   for reporting bugs and missing features.
778fec65c98Schristos
77970f041f9SjoergChanges in version 1.12.3, released on December 31, 2013
78070f041f9Sjoerg
78170f041f9Sjoerg * In the mdoc(7) SYNOPSIS, line breaks and hanging indentation
78270f041f9Sjoerg   now work correctly for .Fo/.Fa/.Fc and .Fn blocks.
78370f041f9Sjoerg   Thanks to Franco Fichtner for doing part of the work.
78470f041f9Sjoerg * The mdoc(7) .Bk macro got some addititonal bugfixes.
78570f041f9Sjoerg * In mdoc(7) macro arguments, double quotes can now be quoted
78670f041f9Sjoerg   by doubling them, just like in man(7).
78770f041f9Sjoerg   Thanks to Tsugutomo ENAMI for the patch.
78870f041f9Sjoerg * At the end of man(7) macro lines, end-of-sentence spacing
78970f041f9Sjoerg   now works.  Thanks to Franco Fichtner for the patch.
79070f041f9Sjoerg * For backward compatibility, the man(7) parser now supports the
79170f041f9Sjoerg   man-ext .UR/.UE (uniform resource identifier) block macros.
79270f041f9Sjoerg * The man(7) parser now handles closing blocks that are not open
79370f041f9Sjoerg   more gracefully.
79470f041f9Sjoerg * The man(7) parser now ignores blank lines right after .SH and .SS.
79570f041f9Sjoerg * In the man(7) formatter, reset indentation when leaving a block,
79670f041f9Sjoerg   not just when entering the next one.
79770f041f9Sjoerg * The roff(7) .nr request now supports incrementing and decrementing
79870f041f9Sjoerg   number registers and stops parsing the number right before the
79970f041f9Sjoerg   first non-digit character.
80070f041f9Sjoerg * The roff(7) parser now supports the alternative escape sequence
80170f041f9Sjoerg   syntax \C'uXXXX' for Unicode characters.
80270f041f9Sjoerg * The roff(7) parser now parses and ignores the .fam (font family)
80370f041f9Sjoerg   and .hw (hyphenation points) requests and the \d and \u escape
80470f041f9Sjoerg   sequences.
80570f041f9Sjoerg * The roff(7) manual got a new ESCAPE SEQUENCE REFERENCE.
80670f041f9Sjoerg
80770f041f9SjoergChanges in version 1.12.2, released on Oktober 5, 2013
80870f041f9Sjoerg
80970f041f9Sjoerg * The mdoc(7) to man(7) converter, to be called as mandoc -Tman,
81070f041f9Sjoerg   is now fully functional.
81170f041f9Sjoerg * The mandoc(1) utility now supports the -Ios (default operating system)
81270f041f9Sjoerg   input option, and the -Tutf8 output mode now actually works.
81370f041f9Sjoerg * The mandocdb(8) utility no longer truncates existing databases when
81470f041f9Sjoerg   starting to build new ones, but only replaces them when the build
81570f041f9Sjoerg   actually succeeds.
81670f041f9Sjoerg * The man(7) parser now supports the PD macro (paragraph distance),
81770f041f9Sjoerg   and (for GNU man-ext compatibility only) EX (example block) and EE
81870f041f9Sjoerg   (example end).  Plus several bugfixes regarding indentation, line
81970f041f9Sjoerg   breaks, and vertical spacing, and regarding RS following TP.
82070f041f9Sjoerg * The roff(7) parser now supports the \f(BI (bold+italic) font escape,
82170f041f9Sjoerg   the \z (zero cursor advance) escape and the cc (change control
82270f041f9Sjoerg   character) and it (input line trap) requests. Plus bugfixes regarding
82370f041f9Sjoerg   the \t (tab) escape, nested escape sequences, and conditional requests.
82470f041f9Sjoerg * In mdoc(7), several bugs were fixed related to UTF-8 output of quoting
82570f041f9Sjoerg   enclosures, delimiter handling, list indentation and horizontal and
82670f041f9Sjoerg   vertical spacing, formatting of the Lk, %U, and %C macros, plus some
82770f041f9Sjoerg   bugfixes related to the handling of syntax errors like badly nested
82870f041f9Sjoerg   font blocks, stray Ta macros outside column lists, unterminated It Xo
82970f041f9Sjoerg   blocks, and non-text children of Nm blocks.
83070f041f9Sjoerg * In tbl(7), the width of horizontal spans and the vertical spacing
83170f041f9Sjoerg   around tables was corrected, and in man(7) files, a crash was fixed
83270f041f9Sjoerg   that was triggered by some particular unclosed T{ macros.
83370f041f9Sjoerg * For mandoc developers, we now provide a tbl(3) library manual and
83470f041f9Sjoerg   gmdiff, a very small, very simplistic groff-versus-mandoc output
83570f041f9Sjoerg   comparison tool.
83670f041f9Sjoerg * Provide this NEWS file.
83770f041f9Sjoerg
83870f041f9SjoergChanges in version 1.12.1, released on March 23, 2012
83970f041f9Sjoerg
84070f041f9Sjoerg * Significant work on apropos(1) and mandocdb(8). These tools are now
84170f041f9Sjoerg   much more robust.  A whatis(1) implementation is now handled as an
84270f041f9Sjoerg   apropos(1) mode.  These tools are also able to minimally handle
84370f041f9Sjoerg   pre-formatted pages, that is, those already formatted by another
84470f041f9Sjoerg   utility such as GNU troff.
84570f041f9Sjoerg * The man.cgi(7) script is also now available for wider testing.
84670f041f9Sjoerg   It interfaces with mandocdb(8) manuals cached by catman(8).
84770f041f9Sjoerg   HTML output is generated on-the-fly by libmandoc or internal
84870f041f9Sjoerg   methods to convert pre-formatted pages.
84970f041f9Sjoerg * The mailing list archive for the discuss and tech lists are being
85070f041f9Sjoerg   hosted by Gmane at gmane.comp.tools.mdocml.user and
85170f041f9Sjoerg   gmane.comp.tools.mdocml.devel, respectively.
85270f041f9Sjoerg
85370f041f9SjoergChanges in version 1.12.0, released on October 8, 2011
85470f041f9Sjoerg
85570f041f9Sjoerg * This version features a new, work-in-progress mandoc(1) output mode:
85670f041f9Sjoerg   -Tman.  This mode allows a system maintainer to distribute man(7)
85770f041f9Sjoerg   media for older systems that may not natively support mdoc(7), such
85870f041f9Sjoerg   as old Solaris systems.
85970f041f9Sjoerg * The -Ofragment option was added to mandoc(1)'s -Thtml and -Txhtml modes.
86070f041f9Sjoerg * While adding features, an apropos(1) utility has been merged from the
86170f041f9Sjoerg   mandoc-tools sandbox.  This interfaces with mandocdb(8) for semantic
86270f041f9Sjoerg   search of manual content.  apropos(1) is different from the traditional
86370f041f9Sjoerg   apropos primarily in allowing keyword search (such as for functions,
86470f041f9Sjoerg   utilities, etc.) and regular expressions.  Note that the calling
86570f041f9Sjoerg   syntax for apropos is likely to change as it settles down.
86670f041f9Sjoerg * In documentation news, the mdoc(7) and man(7) manuals have been
86770f041f9Sjoerg   made considerably more readable by adding MACRO OVERVIEW sections, by
86870f041f9Sjoerg   moving the gory details of the LANGUAGE SYNTAX to the roff(7) manual,
86970f041f9Sjoerg   and by moving the very technical MACRO SYNTAX sections down to the
87070f041f9Sjoerg   bottom of the page.
87170f041f9Sjoerg * Furthermore, for tbl(7), the -Tascii mode horizontal spacing of tables
87270f041f9Sjoerg   was rewritten completely.  It is now compatible with groff(1), both
87370f041f9Sjoerg   with and without frames and rulers.
87470f041f9Sjoerg * Nesting of indented blocks is now supported in man(7), and several
87570f041f9Sjoerg   bugs were fixed regarding indentation and alignment.
87670f041f9Sjoerg * The page headers in mdoc(7) are now nicer for very long titles.
87770f041f9Sjoerg
87870f041f9SjoergChanges in version 1.11.7, released on September 2, 2011
87970f041f9Sjoerg
88070f041f9Sjoerg * Added demandoc(1) utility for stripping away macros and escapes.
88170f041f9Sjoerg   This replaces the historical deroff(1) utility.
88270f041f9Sjoerg * Also improved the mdoc(7) and man(7) manuals.
88370f041f9Sjoerg
88470f041f9SjoergChanges in version 1.11.6, released on August 16, 2011
88570f041f9Sjoerg
88670f041f9Sjoerg * Handling of tr macro in roff(7) implemented.  This makes Perl
88770f041f9Sjoerg   documentation much more readable.  Hyphenation is also now enabled in
88870f041f9Sjoerg   man(7) format documents.  Many other general improvements have been
88970f041f9Sjoerg   implemented.
89070f041f9Sjoerg
89170f041f9SjoergChanges in version 1.11.5, released on July 24, 2011
89270f041f9Sjoerg
89370f041f9Sjoerg * Significant eqn(7) improvements.  mdocml can now parse arbitrary eqn
89470f041f9Sjoerg   input (although few GNU extensions are accepted, nor is mixing
89570f041f9Sjoerg   low-level roff with eqn).  See the eqn(7) manual for details.
89670f041f9Sjoerg   For the time being, equations are rendered as simple in-line text.
89770f041f9Sjoerg   The equation parser satisfies the language specified in the
89870f041f9Sjoerg   Second Edition User's Guide:
89970f041f9Sjoerg   http://www.kohala.com/start/troff/v7man/eqn/eqn2e.ps
90070f041f9Sjoerg
90170f041f9SjoergChanges in version 1.11.4, released on July 12, 2011
90270f041f9Sjoerg
90370f041f9Sjoerg * Bug-fixes and clean-ups across all systems, especially in mandocdb(8)
90470f041f9Sjoerg   and the man(7) parser.  This release was significantly assisted by
90570f041f9Sjoerg   participants in OpenBSD's c2k11.  Thanks!
90670f041f9Sjoerg
90770f041f9SjoergChanges in version 1.11.3, released on May 26, 2011
90870f041f9Sjoerg
90970f041f9Sjoerg * Introduce locale-encoding of output with the -Tlocale output option and
91070f041f9Sjoerg   Unicode escaped-character input.  See mandoc(1) and mandoc_char(7),
91170f041f9Sjoerg   respectively, for details.  This allows for non-ASCII characters (e.g.,
91270f041f9Sjoerg   \[u5000]) to be rendered in the locale's encoding, if said environment
91370f041f9Sjoerg   supports wide-character encoding (if it does not, -Tascii is used
91470f041f9Sjoerg   instead).  Locale support can be turned off at compile time by removing
91570f041f9Sjoerg   -DUSE_WCHAR in the Makefile, in which case -Tlocale is always a synonym
91670f041f9Sjoerg   for -Tascii.
91770f041f9Sjoerg * Furthermore, multibyte-encoded documents, such as those in UTF-8, may
91870f041f9Sjoerg   be on-the-fly recoded into mandoc(1) input by using the newly-added
91970f041f9Sjoerg   preconv(1) utility.  Note: in the future, this feature may be
92070f041f9Sjoerg   integrated into mandoc(1).
92170f041f9Sjoerg
92270f041f9SjoergChanges in version 1.11.2, released on May 12, 2011
92370f041f9Sjoerg
92470f041f9Sjoerg * Corrected some installation issues in version 1.11.1.
92570f041f9Sjoerg * Further migration to libmandoc.
92670f041f9Sjoerg * Initial public release (this utility is very much under development)
92770f041f9Sjoerg   of mandocdb(8).  This utility produces keyword databases of manual
92870f041f9Sjoerg   content, which features semantic querying of manual content.
92970f041f9Sjoerg
93070f041f9SjoergChanges in version 1.11.1, released on April 4, 2011
93170f041f9Sjoerg
93270f041f9Sjoerg * The earlier libroff, libmdoc, and libman soup have been merged into
93370f041f9Sjoerg   a single library, libmandoc, which manages all aspects of parsing
93470f041f9Sjoerg   real manuals, from line-handling to tbl(7) parsing.
93570f041f9Sjoerg * As usual, many general fixes and improvements have also occurred.
93670f041f9Sjoerg   In particular, a great deal of redundancy and superfluous code has
93770f041f9Sjoerg   been removed with the merging of the backend libraries.
93870f041f9Sjoerg * see also the changes in 1.10.10
93970f041f9Sjoerg
94070f041f9SjoergChanges in version 1.10.10, March 20, 2011, NOT released
94170f041f9Sjoerg
94270f041f9Sjoerg * Initial eqn(7) functionality is in place.  For the time being,
94370f041f9Sjoerg   this is limited to the recognition of equation blocks;
94470f041f9Sjoerg   future version of mdocml will expand upon this framework.
94570f041f9Sjoerg
94670f041f9SjoergChanges in version 1.10.9, released on January 7, 2011
94770f041f9Sjoerg
94870f041f9Sjoerg * Many back-end fixes have been implemented: argument handling (quoting),
94970f041f9Sjoerg   man(7) improvements, error/warning classes, and many more.
95070f041f9Sjoerg * Initial tbl(7) functionality (see the "TS", "TE", and "T&" macros in
95170f041f9Sjoerg   the roff(7) manual) has been merged from tbl.bsd.lv.  Output is still
95270f041f9Sjoerg   minimal, especially for -Thtml and -Txhtml, but manages to at least
95370f041f9Sjoerg   display data.  This means that mandoc(1) now has built-in support
95470f041f9Sjoerg   for two troff preprocessors via libroff: soelim(1) and tbl(1).
95570f041f9Sjoerg
95670f041f9SjoergChanges in version 1.10.8, released on December 24, 2010
95770f041f9Sjoerg
95870f041f9Sjoerg * Overhauled the -Thtml and -Txhtml output modes.  They now display
95970f041f9Sjoerg   readable output in arbitrary browsers, including text-based ones like
96070f041f9Sjoerg   lynx(1).  See HTML and XHTML manuals in the DOCUMENTATION section
96170f041f9Sjoerg   for examples.  Attention: available style-sheet classes have been
96270f041f9Sjoerg   considerably changed!  See the example.style.css file for details.
96370f041f9Sjoerg   Lastly, libmdoc and libman have been cleaned up and reduced in size
96470f041f9Sjoerg   and complexity.
96570f041f9Sjoerg * see also the changes in 1.10.7
96670f041f9Sjoerg
96770f041f9SjoergChanges in version 1.10.7, December 6, 2010, NOT released
96870f041f9Sjoerg
96970f041f9Sjoerg Significant improvements merged from OpenBSD downstream, including:
97070f041f9Sjoerg * many new roff(7) components,
97170f041f9Sjoerg * in-line implementation of troff's soelim(1),
97270f041f9Sjoerg * broken-block handling,
97370f041f9Sjoerg * overhauled error classifications, and
97470f041f9Sjoerg * cleaned up handling of error conditions.
97570f041f9Sjoerg
97670f041f9SjoergChanges in version 1.10.6, released on September 27, 2010
97770f041f9Sjoerg
97870f041f9Sjoerg * Calling conventions for mandoc(1) have changed: -W improved and -f
97970f041f9Sjoerg   deprecated.
98070f041f9Sjoerg * Non-ASCII characters are also now uniformly discarded.
98170f041f9Sjoerg * Lots of documentation improvements.
98270f041f9Sjoerg * Many incremental fixes accomodating for groff's more interesting
98370f041f9Sjoerg   productions.
98470f041f9Sjoerg * Lastly, pod2man(1) preambles are now fully accepted after some
98570f041f9Sjoerg   considerable roff(7) and special character support.
98670f041f9Sjoerg
98770f041f9SjoergChanges in version 1.10.5, released on July 27, 2010
98870f041f9Sjoerg
98970f041f9Sjoerg * Primarily a bug-fix and polish release, but including -Tpdf support
99070f041f9Sjoerg   in mandoc(1) by way of "Summer of Code".  Highlights:
99170f041f9Sjoerg * fix "Sm" and "Bd" handling
99270f041f9Sjoerg * fix end-of-sentence handling for embedded sentences
99370f041f9Sjoerg * polish man(7) documentation
99470f041f9Sjoerg * document all mdoc(7) macros
99570f041f9Sjoerg * polish mandoc(1) -Tps output
99670f041f9Sjoerg * lots of internal clean-ups in character escapes
99770f041f9Sjoerg * un-break literal contexts in man(7) documents
99870f041f9Sjoerg * improve -Thtml output for -man
99970f041f9Sjoerg * add mandoc(1) -Tpdf support
100070f041f9Sjoerg
100170f041f9SjoergChanges in version 1.10.4, released on July 12, 2010
100270f041f9Sjoerg
100370f041f9Sjoerg * Lots of features developed during both "Summer of Code" and the
100470f041f9Sjoerg   OpenBSD c2k10 hackathon:
100570f041f9Sjoerg * minimal "ds" roff(7) symbols are supported
100670f041f9Sjoerg * beautified SYNOPSIS section output
100770f041f9Sjoerg * acceptance of scope-block breakage in mdoc(7)
100870f041f9Sjoerg * clarify error message status
100970f041f9Sjoerg * many minor bug-fixes and formatting issues resolved
101070f041f9Sjoerg * see also changes in 1.10.3
101170f041f9Sjoerg
101270f041f9SjoergChanges in version 1.10.3, June 29, 2010, NOT released
101370f041f9Sjoerg
101470f041f9Sjoerg * variable font-width and paper-size support in mandoc(1) -Tps output
101570f041f9Sjoerg * "Bk" mdoc(7) support
101670f041f9Sjoerg
101770f041f9SjoergChanges in version 1.10.2, released on June 19, 2010
101870f041f9Sjoerg
101970f041f9Sjoerg * Small release featuring text-decoration in -Tps output,
102070f041f9Sjoerg   a few minor relaxations of errors, and some optimisations.
102170f041f9Sjoerg
102270f041f9SjoergChanges in version 1.10.1, released on June 7, 2010
102370f041f9Sjoerg
102470f041f9Sjoerg * This primarily focusses on the "Bl" and "It" macros described in
102570f041f9Sjoerg   mdoc(7).  Multi-line column support is now fully compatible with groff,
102670f041f9Sjoerg   as are implicit list entries for columns.
102770f041f9Sjoerg * Removed manuals(7) in favour of http://manpages.bsd.lv.
102870f041f9Sjoerg * The way we handle the SYNOPSIS section (see the SYNOPSIS documentation
102970f041f9Sjoerg   in MANUAL STRUCTURE) has also been considerably simplified compared
103070f041f9Sjoerg   to groff's method.
103170f041f9Sjoerg * Furthermore, the -Owidth=width output option has been added to -Tascii,
103270f041f9Sjoerg   see mandoc(1).
103370f041f9Sjoerg * Lastly, initial PostScript output has been added with the -Tps option
103470f041f9Sjoerg   to mandoc(1).  It's brutally simple at the moment: fixed-font, with no
103570f041f9Sjoerg   font decorations.
103670f041f9Sjoerg
103770f041f9SjoergChanges in version 1.10.0, released on May 29, 2010
103870f041f9Sjoerg
103970f041f9Sjoerg * Release consisting of the results from the m2k10 hackathon and up-merge
104070f041f9Sjoerg   from OpenBSD.  This requires a significant note of thanks to Ingo
104170f041f9Sjoerg   Schwarze (OpenBSD) and Joerg Sonnenberger (NetBSD) for their hard work,
104270f041f9Sjoerg   and again to Joerg for hosting m2k10.  Highlights (mostly cribbed from
104370f041f9Sjoerg   Ingo's m2k10 report) follow in no particular order:
104470f041f9Sjoerg * a libroff preprocessor in front of libmdoc and libman stripping out
104570f041f9Sjoerg   roff(7) instructions;
104670f041f9Sjoerg * end-of-sentence (EOS) detection in free-form and macro lines;
104770f041f9Sjoerg * correct handling of tab-separated columnar lists in mdoc(7);
104870f041f9Sjoerg * improved main calling routines to optionally use mmap(3) for better
104970f041f9Sjoerg   performance;
105070f041f9Sjoerg * cleaned up exiting when invoked as -Tlint or over multiple files
105170f041f9Sjoerg   with -fign-errors;
105270f041f9Sjoerg * error and warning message handling re-written to be unified for
105370f041f9Sjoerg   libroff, libmdoc, and libman;
105470f041f9Sjoerg * handling of badly-nested explicit-scoped macros;
105570f041f9Sjoerg * improved free-form text parsing in libman and libmdoc;
105670f041f9Sjoerg * significant GNU troff compatibility improvements in -Tascii,
105770f041f9Sjoerg   largely in terms of spacing;
105870f041f9Sjoerg * a regression framework for making sure the many fragilities of GNU
105970f041f9Sjoerg   troff aren't trampled in subsequent work;
106070f041f9Sjoerg * support for -Tascii breaking at hyphens encountered in free-form text;
106170f041f9Sjoerg * and many more minor fixes and improvements
106270f041f9Sjoerg
106370f041f9SjoergChanges in version 1.9.25, released on May 13, 2010
106470f041f9Sjoerg
106570f041f9Sjoerg * Fixed handling of "\*(Ba" escape.
106670f041f9Sjoerg * Backed out -fno-ign-chars (pointless complexity).
106770f041f9Sjoerg * Fixed erroneous breaking of literal lines.
106870f041f9Sjoerg * Fixed SYNOPSIS breaking lines before non-initial macros.
106970f041f9Sjoerg * Changed default section ordering.
107070f041f9Sjoerg * Most importantly, the framework for end-of-sentence double-spacing is
107170f041f9Sjoerg   in place, now implemented for the "end-of-sentence, end-of-line" rule.
107270f041f9Sjoerg * This is a stable roll-back point before the mandoc hackathon in Rostock!
107370f041f9Sjoerg
107470f041f9SjoergChanges in version 1.9.24, released on May 9, 2010
107570f041f9Sjoerg
107670f041f9Sjoerg * Rolled back break-at-hyphen.
107770f041f9Sjoerg * -DUGLY is now the default (no feature splits!).
107870f041f9Sjoerg * Free-form text is not de-chunked any more: lines are passed
107970f041f9Sjoerg   whole-sale into the front-end, including whitespace.
108070f041f9Sjoerg * Added mailing lists.
108170f041f9Sjoerg
108270f041f9SjoergChanges in version 1.9.23, released on April 7, 2010
108370f041f9Sjoerg
108470f041f9Sjoerg * mdocml has been linked to the OpenBSD build.
108570f041f9Sjoerg * This version incorporates many small changes, mostly from patches
108670f041f9Sjoerg   by OpenBSD, allowing crufty manuals to slip by with warnings instead
108770f041f9Sjoerg   of erroring-out.
108870f041f9Sjoerg * Some subtle semantic issues, such as punctuation scope, have also
108970f041f9Sjoerg   been fixed.
109070f041f9Sjoerg * Lastly, some issues with -Thtml have been fixed, which prompted an
109170f041f9Sjoerg   update to the online manual pages style layout.
109270f041f9Sjoerg
109370f041f9SjoergChanges in version 1.9.22, released on March 31, 2010
109470f041f9Sjoerg
109570f041f9Sjoerg * Adjusted merge of the significant work by Ingo Schwarze
109670f041f9Sjoerg   in getting "Xo" blocks (block full implicit, e.g., "It"
109770f041f9Sjoerg   for non-columnar lists) to work properly.  This isn't
109870f041f9Sjoerg   enabled by default: you must specify -DUGLY as a compiler
109970f041f9Sjoerg   flag (see the Makefile for details).
110070f041f9Sjoerg
110170f041f9SjoergChanges in version 1.9.20, released on March 30, 2010
110270f041f9Sjoerg
110370f041f9Sjoerg * More efforts to get roff instructions in man(7) documents under
110470f041f9Sjoerg   control.  Note that roff instructions embedded in line-scoped,
110570f041f9Sjoerg   next-line macros (e.g. "B") are not supported.
110670f041f9Sjoerg * Leading punctuation for mdoc(7) macros, such as "Fl ( ( a",
110770f041f9Sjoerg   are now correctly handled.
110870f041f9Sjoerg
110970f041f9SjoergChanges in version 1.9.18, released on March 27, 2010
111070f041f9Sjoerg
111170f041f9Sjoerg * Many fixes (largely pertaining to scope)
111270f041f9Sjoerg   and improvements (e.g., handling of apostrophe-control macros,
111370f041f9Sjoerg   which fixes the strange "BR" seen in some macro output)
111470f041f9Sjoerg   to handling roff instructions in man(7) documents.
111570f041f9Sjoerg
111670f041f9SjoergChanges in version 1.9.17, released on March 25, 2010
111770f041f9Sjoerg
111870f041f9Sjoerg * Accept perlpod(1) standard preamble.
111970f041f9Sjoerg * Also accept (and discard) "de", "dei", "am", "ami", and "ig"
112070f041f9Sjoerg   roff macro blocks.
112170f041f9Sjoerg
112270f041f9SjoergChanges in version 1.9.16, released on March 22, 2010
112370f041f9Sjoerg
112470f041f9Sjoerg * Inspired by patches and bug reports by Ingo Schwarze,
112570f041f9Sjoerg   allowed man(7) to accept non-printing elements to be nested
112670f041f9Sjoerg   within next-line scopes, such as "br" within "B" or "TH",
112770f041f9Sjoerg   which is valid roff.
112870f041f9Sjoerg * Longsoon architecture also noted and Makefile cleaned up.
112970f041f9Sjoerg
113070f041f9SjoergChanges in version 1.9.15, released on February 18, 2010
113170f041f9Sjoerg
113270f041f9Sjoerg * Moved to our new BSD.lv home.
113370f041f9Sjoerg * XHTML is now an acceptable output mode for mandoc(1);
113470f041f9Sjoerg * "Xr" made more compatible with groff;
113570f041f9Sjoerg * "Vt" fixed when invoked in SYNOPSIS;
113670f041f9Sjoerg * "\\" escape removed;
113770f041f9Sjoerg * end-of-line white-space detected for all lines;
113870f041f9Sjoerg * subtle bug fixed in list display for some modes;
113970f041f9Sjoerg * compatibility layer checked in for compilation in diverse
114070f041f9Sjoerg   UNIX systems;
114170f041f9Sjoerg * and column lengths handled correctly.
114270f041f9Sjoerg
114370f041f9SjoergFor older releases, see the ChangeLog files
1144c9bcef03Schristosin http://mandoc.bsd.lv/snapshots/ .
1145