TODO

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