TODO

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