TODO

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