xref: /netbsd-src/external/bsd/mdocml/dist/TODO (revision 04028aa9310ca9c619eca5cf58ddf1e58624d1d7)
1************************************************************************
2* Official mandoc TODO.
3* $Id: TODO,v 1.1.1.3 2015/12/17 21:58:48 christos Exp $
4************************************************************************
5
6Many issues are annotated for difficulty as follows:
7
8 - loc = locality of the issue
9    *    single file issue, affects file only, or very few
10    **   single module issue, affects several files of one module
11    ***  cross-module issue, significantly impacts multiple modules
12         and may require substantial changes to internal interfaces
13 - exist = difficulty of the existing code in this area
14    *    affected code is straightforward and easy to read and change
15    **   affected code is somewhat complex, but once you understand
16         the design, not particularly difficult to understand
17    ***  affected code uses a special, exceptionally tricky design
18 - algo = difficulty of the new algorithm to be written
19    *    the required logic and code is straightforward
20    **   the required logic is somewhat complex and needs a careful design
21    ***  the required logic is exceptionally tricky,
22         maybe an approach to solve that is not even known yet
23 - size = the amount of code to be written or changed
24    *    a small number of lines (at most 100, usually much less)
25    **   a considerable amount of code (several dozen to a few hundred)
26    ***  a large amount of code (many hundreds, maybe thousands)
27 - imp = importance of the issue
28    *    mostly for completeness
29    **   would be nice to have
30    ***  issue causes considerable inconvenience
31
32Obviously, as the issues have not been solved yet, these annotations
33are mere guesses, and some may be wrong.
34
35************************************************************************
36* crashes
37************************************************************************
38
39- The abort() in bufcat(), html.c, can be triggered via buffmt_includes()
40  by running -Thtml -Oincludes on a file containing a long .In argument.
41  Fixing this will probably require reworking the whole bufcat() concept.
42  loc **  exist *  algo *  size **  imp **
43
44************************************************************************
45* missing features
46************************************************************************
47
48--- missing roff features ----------------------------------------------
49
50- .ad (adjust margins)
51  .ad l -- adjust left margin only (flush left)
52  .ad r -- adjust right margin only (flush right)
53  .ad c -- center text on line
54  .ad b -- adjust both margins (alias: .ad n)
55  .na   -- temporarily disable adjustment without changing the mode
56  .ad   -- re-enable adjustment without changing the mode
57  Adjustment mode is ignored while in no-fill mode (.nf).
58  loc ***  exist ***  algo **  size **  imp **  (parser reorg would help)
59
60- .fc (field control)
61  found by naddy@ in xloadimage(1)
62  loc **  exist ***  algo *  size *  imp *
63
64- .nr third argument (auto-increment step size, requires \n+)
65  found by bentley@ in sbcl(1)  Mon, 9 Dec 2013 18:36:57 -0700
66  loc *  exist *  algo *  size *  imp **
67
68- .ns (no-space mode) occurs in xine-config(1)
69  reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
70  loc ***  exist ***  algo ***  size **  imp *
71
72- .ta (tab settings)
73  #1 most important issue naddy@ Mon, 16 Feb 2015 20:59:17 +0100
74  ircbug(1) gnats(1) reported by brad@  Sat, 15 Jan 2011 15:50:51 -0500
75  also Tcl_NewStringObj(3) via wiz@  Wed, 5 Mar 2014 22:27:43 +0100
76  also posix2time(3) Carsten Kunze  Mon, 1 Dec 2014 13:03:10 +0100
77  loc **  exist ***  algo **  size **  imp ***
78
79- .ti (temporary indent)
80  found by naddy@ in xloadimage(1) [devel/libvstr] vstr(3)
81  found by bentley@ in nmh(1)  Mon, 23 Apr 2012 13:38:28 -0600
82  loc **  exist **  algo **  size *  imp ** (parser reorg helps a lot)
83
84- .while and .shift
85  found by jca@ in ratpoison(1)  Sun, 30 Jun 2013 12:01:09 +0200
86  loc *  exist **  algo **  size **  imp **
87
88- \h horizontal move
89  #2 most important issue naddy@  Mon, 16 Feb 2015 20:59:17 +0100
90  found in cclive(1) nasm(1) bogofilter(1) asciidoc/DocBook output
91  bentley@ on discuss@  Sat, 21 Sep 2013 22:29:34 -0600
92  naddy@  Thu, 4 Dec 2014 16:26:41 +0100
93  loc **  exist **  algo **  size *  imp *** (parser reorg helps a lot)
94
95- \n+ and \n- numerical register increment and decrement
96  found by bentley@ in sbcl(1)  Mon, 9 Dec 2013 18:36:57 -0700
97  loc *  exist *  algo *  size *  imp **
98
99- \n(.$ macro argument count number register; ocserv(8) by autogen
100  found by sthen@  Thu, 19 Feb 2015 22:03:01 +0000
101  loc *  exist **  algo *  size *  imp **
102
103- \w'' improve width measurements
104  would not be very useful without an expression parser, see below
105  needed for Tcl_NewStringObj(3) via wiz@  Wed, 5 Mar 2014 22:27:43 +0100
106  loc **  exist ***  algo ***  size *  imp ***
107
108- using undefined strings or macros defines them to be empty
109  wl@  Mon, 14 Nov 2011 14:37:01 +0000
110  loc *  exist *  algo *  size *  imp *
111
112--- missing mdoc features ----------------------------------------------
113
114- .Bl -column .Xo support is missing
115  ultimate goal:
116  restore .Xr and .Dv to
117  lib/libc/compat-43/sigvec.3
118  lib/libc/gen/signal.3
119  lib/libc/sys/sigaction.2
120  loc *  exist ***  algo ***  size *  imp **
121
122- edge case: decide how to deal with blk_full bad nesting, e.g.
123  .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
124  from jmc@  Wed, 14 Jul 2010 18:10:32 +0100
125  loc *  exist ***  algo ***  size **  imp **
126
127- .Bd -centered implies -filled, not -unfilled, which is not
128  easy to implement; it requires code similar to .ce, which
129  we don't have either.
130  Besides, groff has bug causing text right *before* .Bd -centered
131  to be centered as well.
132  loc ***  exist ***  algo **  size **  imp **  (parser reorg would help)
133
134- .Bd -filled should not be the same as .Bd -ragged, but align both
135  the left and right margin.  In groff, it is implemented in terms
136  of .ad b, which we don't have either.  Found in cksum(1).
137  loc ***  exist ***  algo **  size **  imp **  (parser reorg would help)
138
139- implement blank `Bl -column', such as
140  .Bl -column
141  .It foo Ta bar
142  .El
143  loc *  exist ***  algo ***  size *  imp *
144
145- explicitly disallow nested `Bl -column', which would clobber internal
146  flags defined for struct mdoc_macro
147  loc *  exist *  algo *  size *  imp **
148
149- In .Bl -column .It, the end of the line probably has to be regarded
150  as an implicit .Ta, if there could be one, see the following mildly
151  ugly code from login.conf(5):
152    .Bl -column minpasswordlen program xetcxmotd
153    .It path Ta path Ta value of Dv _PATH_DEFPATH
154    .br
155    Default search path.
156  reported by Michal Mazurek <akfaew at jasminek dot net>
157  via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
158  loc *  exist ***  algo **  size *  imp **
159
160- inside `.Bl -column' phrases, punctuation is handled like normal
161  text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
162
163- inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
164  is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
165  but should give "ab ."
166
167- check whether it is correct that `D1' uses INDENT+1;
168  does it need its own constant?
169  loc *  exist **  algo **  size *  imp **
170
171- prohibit `Nm' from having non-text HEAD children
172  (e.g., NetBSD mDNSShared/dns-sd.1)
173  (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
174
175- support translated section names
176  e.g. x11/scrotwm scrotwm_es.1:21:2: error: NAME section must be first
177  that one uses NOMBRE because it is spanish...
178  deraadt tends to think that section-dependent macro behaviour
179  is a bad idea in the first place, so this may be irrelevant
180  loc **  exist **  algo **  size *  imp **
181
182- When there is free text in the SYNOPSIS and that free text contains
183  the .Nm macro, groff somehow understands to treat the .Nm as an in-line
184  macro, while mandoc treats it as a block macro and breaks the line.
185  No idea how the logic for distinguishing in-line and block instances
186  should be, needs investigation.
187  uqs@  Thu, 2 Jun 2011 11:03:51 +0200
188  uqs@  Thu, 2 Jun 2011 11:33:35 +0200
189  loc *  exist **  algo ***  size *  imp **
190
191--- missing man features -----------------------------------------------
192
193- -T[x]html doesn't stipulate non-collapsing spaces in literal mode
194
195--- missing tbl features -----------------------------------------------
196
197- look at the POSIX manuals in the books/man-pages-posix port,
198  they use some unsupported tbl(7) features.
199  loc *  exist **  algo **  size **  imp ***
200
201- use Unicode U+2500 to U+256C for table borders
202  in tbl(7) -Tutf-8 output
203  suggested by bentley@  Tue, 14 Oct 2014 04:10:55 -0600
204  loc *  exist **  algo *  size *  imp **
205
206- allow standalone `.' to be interpreted as an end-of-layout
207  delimiter instead of being thrown away as a no-op roff line
208  reported by Yuri Pankov, Wed 18 May 2011 11:34:59 CEST
209  loc **  exist **  algo **  size *  imp **
210
211--- missing eqn features -----------------------------------------------
212
213- The "size" keyword is parsed, but ignored by the formatter.
214  loc *  exist *  algo *  size *  imp *
215
216- The spacing characters `~', `^', and tab are currently ignored,
217  see User's Guide (Second Edition) page 2 section 4.
218  loc *  exist *  algo **  size *  imp **
219
220- Mark and lineup are parsed and ignored,
221  see User's Guide (Second Edition) page 5 section 15.
222  loc **  exist **  algo **  size **  imp **
223
224--- missing misc features ----------------------------------------------
225
226- italic correction (\/) in PostScript mode
227  Werner LEMBERG on groff at gnu dot org  Sun, 10 Nov 2013 12:47:46
228  loc **  exist **  algo *  size *  imp *
229
230- When makewhatis(8) encounters a FATAL parse error,
231  it silently treats the file as formatted, which makes no sense
232  at all for paths like man1/foo.1 - and which also contradicts
233  what the manual says at the end of the description.
234  The end result will be ENOENT for file names returned
235  by mansearch() in manpage.file.
236  loc *  exist *  algo *  size *  imp **
237
238- makewhatis(8) for preformatted pages:
239  parse the section number from the header line
240  and compare to the section number from the directory name
241  loc *  exist *  algo *  size *  imp **
242
243- Does makewhatis(8) detect missing NAME sections, missing names,
244  and missing descriptions in all the file formats?
245  loc *  exist *  algo *  size *  imp ***
246
247- clean up escape sequence handling, creating three classes:
248  (1) fully implemented, or parsed and ignored without loss of content
249  (2) unimplemented, potentially causing loss of content
250      or serious mangling of formatting (e.g. \n) -> ERROR
251      see textproc/mgdiff(1) for nice examples
252  (3) undefined, just output the character -> perhaps WARNING
253  loc ***  exist **  algo **  size **  imp *** (parser reorg helps)
254
255- kettenis wants base roff, ms, and me  Fri, 1 Jan 2010 22:13:15 +0100 (CET)
256  loc **  exist **  algo **  size ***  imp *
257
258--- compatibility checks -----------------------------------------------
259
260- write a configure check for [[:<:]] support and provide some
261  fallback for whatis(1) when it doesn't work;
262  Svyatoslav Mishyn  Wed, 17 Dec 2014 11:07:10 +0200
263
264- is .Bk implemented correctly in modern groff?
265  sobrado@  Tue, 19 Apr 2011 22:12:55 +0200
266
267- compare output to Heirloom roff, Solaris roff, and
268  http://repo.or.cz/w/neatroff.git  http://litcave.rudi.ir/
269
270- look at AT&T DWB http://www2.research.att.com/sw/download
271  Carsten Kunze <carsten dot kunze at arcor dot de> has patches
272  Mon, 4 Aug 2014 17:01:28 +0200
273
274- look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
275  These are a weird mixture of man(7) and custom autogenerated low-level
276  roff stuff.  Figure out to what extent we can cope.
277  For details, see http://docutils.sourceforge.net/rst.html
278  noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
279  reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
280
281- look at pages generated from ronn(1) github.com/rtomayko/ronn
282  (based on markdown)
283
284- look at pages generated from Texinfo source by yat2m, e.g. security/gnupg
285  First impression is not that bad.
286
287- look at pages generated by pandoc; see
288  https://github.com/jgm/pandoc/blob/master/src/Text/Pandoc/Writers/Man.hs
289  porting planned by kili@  Thu, 19 Jun 2014 19:46:28 +0200
290
291- check compatibility with Plan9:
292  http://swtch.com/usr/local/plan9/tmac/tmac.an
293  http://swtch.com/plan9port/man/man7/man.html
294  "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
295
296- check compatibility with the man(7) formatter
297  https://raw.githubusercontent.com/rofl0r/hardcore-utils/master/man.c
298
299- check compatibility with
300  http://ikiwiki.info/plugins/contrib/mandoc/
301  https://github.com/schmonz/ikiwiki/compare/mandoc
302  Amitai Schlair  Mon, 19 May 2014 14:05:53 -0400
303
304************************************************************************
305* formatting issues: ugly output
306************************************************************************
307
308- revisit empty in-line macros
309  look at the difference between "Em x Em ." and "Sq x Em ."
310  Carsten Kunze  Fri, 12 Dec 2014 00:15:41 +0100
311  loc *** exist *** algo *** size * imp **
312
313- a column list with blank `Ta' cells triggers a spurious
314  start-with-whitespace printing of a newline
315
316- In .Bl -column, .It a<tab>"b<tab>c"
317  shows the quotes in groff, but not in mandoc
318  loc * exist *** algo ** size * imp **
319
320- In .Bl -column,
321  .It Em Authentication<tab>Key Length
322  ought to render "Key Length" with emphasis, too,
323  see OpenBSD iked.conf(5).
324  reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200
325  loc *  exist ***  algo ***  size **  imp ***
326
327- empty phrases in .Bl column produce too few blanks
328  try e.g. .Bl -column It Ta Ta
329  reported by millert Fri, 02 Apr 2010 16:13:46 -0400
330  loc *  exist ***  algo ***  size *  imp **
331
332- .%T can have trailing punctuation.  Currently, it puts the trailing
333  punctuation into a trailing MDOC_TEXT element inside its own scope.
334  That element should rather be outside its scope, such that the
335  punctuation does not get underlines.  This is not trivial to
336  implement because .%T then needs some features of in_line_eoln() -
337  slurp all arguments into one single text element - and one feature
338  of in_line() - put trailing punctuation out of scope.
339  Found in mount_nfs(8) and exports(5), search for "Appendix".
340  loc **  exist **  algo ***  size *  imp **
341
342- Trailing punctuation after .%T triggers EOS spacing, at least
343  outside .Rs (eek!).  Simply setting ARGSFL_DELIM for .%T is not
344  the right solution, it sends mandoc into an endless loop.
345  reported by Nicolas Joly  Sat, 17 Nov 2012 11:49:54 +0100
346  loc *  exist **  algo **  size *  imp **
347
348- global variables in the SYNOPSIS of section 3 pages
349  .Vt vs .Vt/.Va vs .Ft/.Va vs .Ft/.Fa ...
350  from kristaps@  Tue, 08 Jun 2010 11:13:32 +0200
351
352- in enclosures, mandoc sometimes fancies a bogus end of sentence
353  reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
354  loc *  exist **  algo ***  size *  imp ***
355
356- a line starting with "\fB something" counts as starting with whitespace
357  and triggers a line break; found in audio/normalize-mp3(1)
358  loc **  exist *  algo **  size *  imp **
359
360- formatting /usr/local/man/man1/latex2man.1 with groff and mandoc
361  reveals lots of bugs both in groff and mandoc...
362  reported by bentley@  Wed, 22 May 2013 23:49:30 -0600
363
364--- PDF issues ---------------------------------------------------------
365
366- PDF output doesn't use a monospaced font for .Bd -literal
367  Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf".
368  Search the text "Routing tables".
369  Also check what PostScript mode does when fixing this.
370  reported by juanfra@ Wed, 04 Jun 2014 21:44:58 +0200
371  instructions from juanfra@  Wed, 11 Jun 2014 02:21:01 +0200
372    add a new <</Type /Font>> block to the PDF files with /BaseFont /Courier
373    and change the /Name from /F0 to the new font (/F5 (?)).
374  loc *  exist **  algo **  size *  imp **
375
376--- HTML issues --------------------------------------------------------
377
378- <dl><dt><dd> formatting is ugly
379  hints are easy to find on the web, e.g.
380  http://stackoverflow.com/questions/1713048/
381  see also matthew@  Fri, 18 Jul 2014 19:25:12 -0700
382  loc *  exist *  algo **  size *  imp ***
383
384- jsg on icb, Nov 3, 2014:
385  try to guess Xr in man(7) for hyperlinking
386
387- The tables used to render the three-part page headers actually force
388  the width of the <body> to the max-width given for <html>.
389  Not yet sure how to fix that...
390  Observed by an Anonymous Coward on undeadly.org:
391  http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1
392  loc *  exist *  algo **  size *  imp ***
393
394- consider whether <var> can be used for Ar Dv Er Ev Fa Va.
395  from bentley@  Wed, 13 Aug 2014 09:17:55 -0600
396
397- check https://github.com/trentm/mdocml
398
399************************************************************************
400* formatting issues: gratuitous differences
401************************************************************************
402
403- .Fn reopens a new scope after punctuation in mandoc,
404  but closes its scope for good in groff.
405  Do we want to change mandoc or groff?
406  Steffen Nurpmeso  Sat, 08 Nov 2014 13:34:59 +0100
407  loc *  exist **  algo **  size *  imp **
408
409- In .Bl -enum -width 0n, groff continues one the same line after
410  the number, mandoc breaks the line.
411  mail to kristaps@  Mon, 20 Jul 2009 02:21:39 +0200
412  loc *  exist **  algo **  size *  imp **
413
414- .Pp between two .It in .Bl -column should produce one,
415  not two blank lines, see e.g. login.conf(5).
416  reported by jmc@  Sun, 17 Apr 2011 14:04:58 +0059
417  reported again by sthen@  Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
418  loc *  exist ***  algo **  size *  imp **
419
420- If the *first* line after .It is .Pp, break the line right after
421  the tag, do not pad with space characters before breaking.
422  See the description of the a, c, and i commands in sed(1).
423  loc *  exist **  algo **  size *  imp **
424
425- If the first line after .It is .D1, do not assert a blank line
426  in between, see for example tmux(1).
427  reported by nicm@  13 Jan 2011 00:18:57 +0000
428  loc *  exist **  algo **  size *  imp **
429
430- Trailing punctuation after .It should trigger EOS spacing.
431  reported by Nicolas Joly  Sat, 17 Nov 2012 11:49:54 +0100
432  Probably, this should be fixed somewhere in termp_it_pre(), not sure.
433  loc *  exist **  algo **  size *  imp **
434
435- .Nx 1.0a
436  should be "NetBSD 1.0A", not "NetBSD 1.0a",
437  see OpenBSD ccdconfig(8).
438  loc *  exist *  algo *  size *  imp **
439
440- In .Bl -tag, if a tag exceeds the right margin and must be continued
441  on the next line, it must be indented by -width, not width+1;
442  see "rule block|pass" in OpenBSD ifconfig(8).
443  loc *  exist ***  algo **  size *  imp **
444
445- When the -width string contains macros, the macros must be rendered
446  before measuring the width, for example
447    .Bl -tag -width ".Dv message"
448  in magic(5), located in src/usr.bin/file, is the same
449  as -width 7n, not -width 11n.
450  The same applies to .Bl -column column widths;
451  reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
452  reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200
453  loc ***  exist ***  algo ***  size **  imp ***
454  An easy partial fix would be to just skip the first word if it starts
455  with a dot, including any following white space, when measuring.
456  loc *  exist *  algo *  size *  imp ***
457
458- The \& zero-width character counts as output.
459  That is, when it is alone on a line between two .Pp,
460  we want three blank lines, not two as in mandoc.
461  loc **  exist **  algo **  size *  imp **
462
463- Header lines of excessive length:
464  Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
465  and document it in mdoc(7) and man(7) COMPATIBILITY
466  found while talking to Chris Bennett
467  loc *  exist *  algo *  size *  imp *
468
469- trailing whitespace must be ignored even when followed by a font escape,
470  see for example
471    makes
472    \fBdig \fR
473    operate in batch mode
474  in dig(1).
475  loc **  exist **  algo **  size *  imp **
476
477************************************************************************
478* warning issues
479************************************************************************
480
481- check that MANDOCERR_BADTAB is thrown in the right cases,
482  i.e. when finding a literal tab character in fill mode,
483  and possibly change the wording of the warning message
484  to refer to fill mode, not literal mode
485  See the mail from Werner LEMBERG on the groff list,
486  Fri, 14 Feb 2014 18:54:42 +0100 (CET)
487  loc *  exist **  algo **  size *  imp **
488
489- warn about attempts to call non-callable macros
490  Steffen Nurpmeso  Tue, 11 Nov 2014 22:55:16 +0100
491  Note that formatting is inconsistent in groff.
492  .Fn Po prints "Po()", .Ar Sh prints "file ..." and no "Sh".
493  Relatively hard because the relevant code is scattered
494  all over mdoc_macro.c and all subtly different.
495  loc **  exist **  algo **  size **  imp **
496
497- warn about "new sentence, new line"
498  loc **  exist **  algo ***  size *  imp **
499
500- mandoc_special does not really check the escape sequence,
501  but just the overall format
502  loc **  exist **  algo ***  size **  imp **
503
504- integrate mdoclint into mandoc ("end-of-line whitespace" thread)
505  from jmc@  Mon, 13 Jul 2009 17:12:09 +0100
506  from kristaps@  Mon, 13 Jul 2009 18:34:53 +0200
507  from jmc@  Mon, 13 Jul 2009 17:45:37 +0059
508  from kristaps@  Mon, 13 Jul 2009 19:02:03 +0200
509  (mostly done, check what remains)
510
511- -Tlint parser errors and warnings to stdout
512  to tech@mdocml, naddy@  Wed, 28 Sep 2011 11:21:46 +0200
513  wait!  kristaps@  Sun, 02 Oct 2011 17:12:52 +0200
514
515- for system errors, use errno/strerror/warn/err
516
517************************************************************************
518* documentation issues
519************************************************************************
520
521- mention hyphenation rules:
522  breaking at letter-letter in text mode (not macro args)
523  proper hyphenation is unimplemented
524
525- talk about spacing around delimiters
526  to jmc@, kristaps@  Sat, 23 Apr 2011 17:41:27 +0200
527
528- mark macros as: page structure domain, manual domain, general text domain
529  is this useful?
530
531- mention /usr/share/misc/mdoc.template in mdoc(7)?
532
533- Is all the content from http://www.std.com/obi/BSD/doc/usd/28.tbl/tbl
534  covered in tbl(7)?
535
536************************************************************************
537* performance issues
538************************************************************************
539
540- Why are we using MAP_SHARED, not MAP_PRIVATE for mmap(2)?
541  How does SQLITE_CONFIG_PAGECACHE actually work?  Document it!
542  from kristaps@  Sat, 09 Aug 2014 13:51:36 +0200
543
544Several areas can be cleaned up to make mandoc even faster.  These are
545
546- improve hashing mechanism for macros (quite important: performance)
547
548- improve hashing mechanism for characters (not as important)
549
550- the PDF file is HUGE: this can be reduced by using relative offsets
551
552- instead of re-initialising the roff predefined-strings set before each
553  parse, create a read-only version the first time and copy it
554  loc *  exist **  algo **  size *  imp **
555
556************************************************************************
557* structural issues
558************************************************************************
559
560- Improve -O suboption parsing.  Do it in the main program such that
561  errors can be reported.  Pay attention to distinguishing the
562  mandoc(1) and apropos(1) styles of both options.
563  loc **  exist *  algo **  size **  imp ***
564
565- Use libz directly instead of forking gunzip(1).
566  Suggested by bapt at FreeBSD among others.
567
568- We use the input line number at several places to distinguish
569  same-line from different-line input.  That plainly doesn't work
570  with user-defined macros, leading to random breakage.
571
572- Find better ways to prevent endless loops
573  in roff(7) macro and string expansion.
574
575- Finish cleanup of date handling.
576  Decide which formats should be recognized where.
577  Update both mdoc(7) and man(7) documentation.
578  Triggered by  Tim van der Molen  Tue, 22 Feb 2011 20:30:45 +0100
579
580- struct mparse refactoring
581  Steffen Nurpmeso  Thu, 04 Sep 2014 12:50:00 +0200
582
583- Consider creating some views that will make the database more
584  readable from the sqlite3 shell.  Consider using them to
585  abstract from the database structure, too.
586  suggested by espie@  Sat, 19 Apr 2014 14:52:57 +0200
587
588************************************************************************
589* CGI issues
590************************************************************************
591
592 - Enable HTTP compression by detecting gzip encoding and filtering
593   output through libz.
594 - Sandbox (see OpenSSH).
595 - Enable caching support via HTTP 304 and If-Modified-Since.
596 - Allow for cgi.h to be overridden by CGI environment variables.
597   Otherwise, binary distributions will inherit the compile-time
598   behaviour, which is not optimal.
599 - Have Mac OSX systems automatically disable -static compilation of the
600   CGI: -static isn't supported.
601
602************************************************************************
603* to improve in the groff_mdoc(7) macros
604************************************************************************
605
606- use uname(1) to set doc-default-operating-system at install time
607  tobimensch  Mon, 1 Dec 2014 00:25:07 +0100
608