[BACK]Return to TODO CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/TODO, Revision 1.279

1.1       kristaps    1: ************************************************************************
1.37      kristaps    2: * Official mandoc TODO.
1.279   ! schwarze    3: * $Id: TODO,v 1.278 2018/11/25 21:17:34 schwarze Exp $
1.27      kristaps    4: ************************************************************************
1.145     schwarze    5:
1.184     schwarze    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.
1.101     schwarze   34:
1.61      schwarze   35: ************************************************************************
1.1       kristaps   36: * missing features
                     37: ************************************************************************
1.70      kristaps   38:
1.79      schwarze   39: --- missing roff features ----------------------------------------------
1.258     schwarze   40:
1.82      schwarze   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).
1.184     schwarze   49:   loc ***  exist ***  algo **  size **  imp **  (parser reorg would help)
1.150     schwarze   50:
                     51: - .fc (field control)
                     52:   found by naddy@ in xloadimage(1)
1.184     schwarze   53:   loc **  exist ***  algo *  size *  imp *
1.198     schwarze   54:
1.80      schwarze   55: - .ns (no-space mode) occurs in xine-config(1)
1.205     schwarze   56:   when implementing this, also let .TH set it
1.80      schwarze   57:   reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
1.184     schwarze   58:   loc ***  exist ***  algo ***  size **  imp *
1.201     schwarze   59:
1.184     schwarze   60: - \w'' improve width measurements
1.167     schwarze   61:   would not be very useful without an expression parser, see below
                     62:   needed for Tcl_NewStringObj(3) via wiz@  Wed, 5 Mar 2014 22:27:43 +0100
1.184     schwarze   63:   loc **  exist ***  algo ***  size *  imp ***
1.203     schwarze   64:
                     65: - \\ in high-level macro arguments
                     66:   Currently, \\ is expanded in two situations:
                     67:   1) macro and string definition (roff.c setstrn())
                     68:   2) macro argument parsing (mandoc.c mandoc_getarg())
                     69:   For user defined macros, the second happens in time because of ROFF_REPARSE.
                     70:   But for standard high-level macros, it only happens after entering the
                     71:   high level parsers, which is too late because the code doesn't get
                     72:   back to roff.c roff_res() from that point.  Because this requires
                     73:   distinguishing requests, user-defined macros and standard macros
                     74:   on the roff_res() level, it is hard to solve without the parser reorg.
                     75:   Found by naddy@ in devel/cutils cobfusc(1)  Mon, 16 Feb 2015 19:10:52 +0100
                     76:   loc ***  exist ***  algo ***  size **  imp *
1.167     schwarze   77:
1.252     schwarze   78: - check for missing roff escape sequences, implement those that are
                     79:   trivial even if not usually appearing in manual pages, gracefully
                     80:   ignore the non-trivial ones, document what they are supposed to do
                     81:   and what mandoc does instead
                     82:   loc *  exist **  algo *  size *  imp *
                     83:
1.79      schwarze   84: --- missing mdoc features ----------------------------------------------
1.18      schwarze   85:
1.1       kristaps   86: - .Bl -column .Xo support is missing
                     87:   ultimate goal:
                     88:   restore .Xr and .Dv to
                     89:   lib/libc/compat-43/sigvec.3
                     90:   lib/libc/gen/signal.3
                     91:   lib/libc/sys/sigaction.2
1.184     schwarze   92:   loc *  exist ***  algo ***  size *  imp **
1.1       kristaps   93:
1.28      schwarze   94: - edge case: decide how to deal with blk_full bad nesting, e.g.
                     95:   .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
                     96:   from jmc@  Wed, 14 Jul 2010 18:10:32 +0100
1.184     schwarze   97:   loc *  exist ***  algo ***  size **  imp **
1.28      schwarze   98:
1.174     schwarze   99: - .Bd -centered implies -filled, not -unfilled, which is not
                    100:   easy to implement; it requires code similar to .ce, which
                    101:   we don't have either.
                    102:   Besides, groff has bug causing text right *before* .Bd -centered
                    103:   to be centered as well.
1.184     schwarze  104:   loc ***  exist ***  algo **  size **  imp **  (parser reorg would help)
1.174     schwarze  105:
1.82      schwarze  106: - .Bd -filled should not be the same as .Bd -ragged, but align both
                    107:   the left and right margin.  In groff, it is implemented in terms
                    108:   of .ad b, which we don't have either.  Found in cksum(1).
1.184     schwarze  109:   loc ***  exist ***  algo **  size **  imp **  (parser reorg would help)
1.22      schwarze  110:
1.10      kristaps  111: - implement blank `Bl -column', such as
                    112:   .Bl -column
                    113:   .It foo Ta bar
                    114:   .El
1.184     schwarze  115:   loc *  exist ***  algo ***  size *  imp *
1.11      kristaps  116:
                    117: - explicitly disallow nested `Bl -column', which would clobber internal
                    118:   flags defined for struct mdoc_macro
1.184     schwarze  119:   loc *  exist *  algo *  size *  imp **
1.102     schwarze  120:
                    121: - In .Bl -column .It, the end of the line probably has to be regarded
                    122:   as an implicit .Ta, if there could be one, see the following mildly
                    123:   ugly code from login.conf(5):
                    124:     .Bl -column minpasswordlen program xetcxmotd
                    125:     .It path Ta path Ta value of Dv _PATH_DEFPATH
                    126:     .br
                    127:     Default search path.
                    128:   reported by Michal Mazurek <akfaew at jasminek dot net>
                    129:   via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
1.184     schwarze  130:   loc *  exist ***  algo **  size *  imp **
1.42      schwarze  131:
                    132: - inside `.Bl -column' phrases, punctuation is handled like normal
                    133:   text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
                    134:
                    135: - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
                    136:   is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
                    137:   but should give "ab ."
1.12      kristaps  138:
1.20      kristaps  139: - prohibit `Nm' from having non-text HEAD children
                    140:   (e.g., NetBSD mDNSShared/dns-sd.1)
                    141:   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.109     schwarze  142:
1.174     schwarze  143: - support translated section names
                    144:   e.g. x11/scrotwm scrotwm_es.1:21:2: error: NAME section must be first
                    145:   that one uses NOMBRE because it is spanish...
                    146:   deraadt tends to think that section-dependent macro behaviour
                    147:   is a bad idea in the first place, so this may be irrelevant
1.184     schwarze  148:   loc **  exist **  algo **  size *  imp **
1.174     schwarze  149:
1.109     schwarze  150: - When there is free text in the SYNOPSIS and that free text contains
                    151:   the .Nm macro, groff somehow understands to treat the .Nm as an in-line
                    152:   macro, while mandoc treats it as a block macro and breaks the line.
                    153:   No idea how the logic for distinguishing in-line and block instances
                    154:   should be, needs investigation.
                    155:   uqs@  Thu, 2 Jun 2011 11:03:51 +0200
                    156:   uqs@  Thu, 2 Jun 2011 11:33:35 +0200
1.184     schwarze  157:   loc *  exist **  algo ***  size *  imp **
1.57      kristaps  158:
1.252     schwarze  159: --- missing man features -----------------------------------------------
1.258     schwarze  160:
1.252     schwarze  161: - groff_www(7) .MTO and .URL
                    162:   These macros were used by the GNU grep(1) man page.
1.258     schwarze  163:   The groff_www(7) manual page itself uses them, too.
1.252     schwarze  164:   We should probably *not* add them to mandoc.
                    165:   Just mentioning this here to keep track of the abuse.
                    166:   Laura Morales <lauretas at mail dot com> 20 Apr 2018 07:33:02 +0200
                    167:   loc **  exist *  algo *  size **  imp *
                    168:
1.79      schwarze  169: --- missing tbl features -----------------------------------------------
1.277     schwarze  170:
1.213     schwarze  171: - the "s" layout column specifier is used for placement of data
                    172:   into columns, but ignored during column width calculations
                    173:   synaptics(4) found by tedu@  Mon, 17 Aug 2015 21:17:42 -0400
                    174:   loc *  exist **  algo ***  size *  imp **
1.79      schwarze  175:
1.255     schwarze  176: - vertical centering in cells vertically spanned with ^
                    177:   pali dot rohar at gmail dot com 16 Jul 2018 13:03:35 +0200
                    178:   loc *  exist ***  algo ***  size **  imp *
                    179:
1.208     schwarze  180: - support mdoc(7) and man(7) macros inside tbl(7) code;
                    181:   probably requires the parser reorg and letting tbl(7)
                    182:   use roff_node such that macro sets can mix;
1.233     schwarze  183:   informed by bapt@ that FreeBSD needs this: 3 Jan 2015 23:32:23 +0100
1.208     schwarze  184:   loc ***  exist **  algo ***  size **  imp ***
                    185:
1.171     schwarze  186: - look at the POSIX manuals in the books/man-pages-posix port,
                    187:   they use some unsupported tbl(7) features.
1.184     schwarze  188:   loc *  exist **  algo **  size **  imp ***
1.171     schwarze  189:
1.230     schwarze  190: - look what Joerg Schilling manual pages use
                    191:   Thu, 19 Mar 2015 18:31:48 +0100
1.255     schwarze  192:
1.182     schwarze  193: --- missing eqn features -----------------------------------------------
1.209     schwarze  194:
                    195: - In a matrix, break the output line after each matrix line.
                    196:   Found in the discussion at CDBUG 2015.
                    197:   Suggested by Avi Weinstock.
                    198:   loc *  exist *  algo *  size *  imp **
1.182     schwarze  199:
                    200: - The "size" keyword is parsed, but ignored by the formatter.
1.184     schwarze  201:   loc *  exist *  algo *  size *  imp *
1.182     schwarze  202:
                    203: - The spacing characters `~', `^', and tab are currently ignored,
                    204:   see User's Guide (Second Edition) page 2 section 4.
1.184     schwarze  205:   loc *  exist *  algo **  size *  imp **
1.182     schwarze  206:
                    207: - Mark and lineup are parsed and ignored,
                    208:   see User's Guide (Second Edition) page 5 section 15.
1.184     schwarze  209:   loc **  exist **  algo **  size **  imp **
1.238     schwarze  210:
                    211: - GNU eqn converts some operators to special characters, for example,
                    212:   input HYPHEN-MINUS becomes output \(mi, unless it is part of a
                    213:   quoted word.  mandoc(1) only does this when the operator is
                    214:   surrounded by blanks, not when it is part of an unquoted word.
                    215:   Also, check whether there are more such cases (e.g., +?).
                    216:   reported by bentley@  20 Jun 2017 02:04:29 -0600
1.252     schwarze  217:   loc *  exist **  algo **  size *  imp *
1.182     schwarze  218:
1.239     schwarze  219: - Primes, opprime, and '
                    220:   bentley@  Thu, 13 Jul 2017 23:14:20 -0600
                    221:
1.79      schwarze  222: --- missing misc features ----------------------------------------------
1.255     schwarze  223:
                    224: - man -ks 1,8 route; kn@ Jul 13, 2018 orally
1.159     schwarze  225:
                    226: - italic correction (\/) in PostScript mode
                    227:   Werner LEMBERG on groff at gnu dot org  Sun, 10 Nov 2013 12:47:46
1.184     schwarze  228:   loc **  exist **  algo *  size *  imp *
1.153     schwarze  229:
1.210     schwarze  230: - change the default PAGER to more -Es and use the pager
                    231:   even for apropos title line output; req by bapt@
                    232:   loc *  exist *  algo *  size *  imp ***
1.171     schwarze  233:
1.79      schwarze  234: - clean up escape sequence handling, creating three classes:
                    235:   (1) fully implemented, or parsed and ignored without loss of content
                    236:   (2) unimplemented, potentially causing loss of content
                    237:       or serious mangling of formatting (e.g. \n) -> ERROR
                    238:       see textproc/mgdiff(1) for nice examples
                    239:   (3) undefined, just output the character -> perhaps WARNING
1.184     schwarze  240:   loc ***  exist **  algo **  size **  imp *** (parser reorg helps)
1.83      schwarze  241:
1.174     schwarze  242: - kettenis wants base roff, ms, and me  Fri, 1 Jan 2010 22:13:15 +0100 (CET)
1.184     schwarze  243:   loc **  exist **  algo **  size ***  imp *
1.174     schwarze  244:
                    245: --- compatibility checks -----------------------------------------------
1.196     schwarze  246:
1.174     schwarze  247: - is .Bk implemented correctly in modern groff?
                    248:   sobrado@  Tue, 19 Apr 2011 22:12:55 +0200
                    249:
1.175     schwarze  250: - compare output to Heirloom roff, Solaris roff, and
                    251:   http://repo.or.cz/w/neatroff.git  http://litcave.rudi.ir/
1.178     schwarze  252:
                    253: - look at AT&T DWB http://www2.research.att.com/sw/download
                    254:   Carsten Kunze <carsten dot kunze at arcor dot de> has patches
                    255:   Mon, 4 Aug 2014 17:01:28 +0200
1.230     schwarze  256:   ported version: https://github.com/n-t-roff/DWB3.3
                    257:   Carsten Kunze  Wed, 22 Apr 2015 11:21:43 +0200
1.174     schwarze  258:
1.79      schwarze  259: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
                    260:   These are a weird mixture of man(7) and custom autogenerated low-level
                    261:   roff stuff.  Figure out to what extent we can cope.
1.80      schwarze  262:   For details, see http://docutils.sourceforge.net/rst.html
1.79      schwarze  263:   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
                    264:   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
1.160     schwarze  265:
1.174     schwarze  266: - look at pages generated from ronn(1) github.com/rtomayko/ronn
                    267:   (based on markdown)
                    268:
1.160     schwarze  269: - look at pages generated from Texinfo source by yat2m, e.g. security/gnupg
                    270:   First impression is not that bad.
1.172     schwarze  271:
                    272: - look at pages generated by pandoc; see
                    273:   https://github.com/jgm/pandoc/blob/master/src/Text/Pandoc/Writers/Man.hs
                    274:   porting planned by kili@  Thu, 19 Jun 2014 19:46:28 +0200
1.71      schwarze  275:
                    276: - check compatibility with Plan9:
                    277:   http://swtch.com/usr/local/plan9/tmac/tmac.an
                    278:   http://swtch.com/plan9port/man/man7/man.html
                    279:   "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
1.63      schwarze  280:
1.207     schwarze  281: - check compatibility with COHERENT troff:
                    282:   http://www.nesssoftware.com/home/mwc/source.php
                    283:
1.174     schwarze  284: - check compatibility with the man(7) formatter
                    285:   https://raw.githubusercontent.com/rofl0r/hardcore-utils/master/man.c
                    286:
1.186     schwarze  287: - check compatibility with
                    288:   http://ikiwiki.info/plugins/contrib/mandoc/
                    289:   https://github.com/schmonz/ikiwiki/compare/mandoc
                    290:   Amitai Schlair  Mon, 19 May 2014 14:05:53 -0400
                    291:
1.230     schwarze  292: - check features of the Slackware man.conf(5) format
                    293:   Carsten Kunze  Wed, 11 Mar 2015 17:57:24 +0100
                    294:
1.1       kristaps  295: ************************************************************************
                    296: * formatting issues: ugly output
                    297: ************************************************************************
1.87      kristaps  298:
1.195     schwarze  299: - revisit empty in-line macros
                    300:   look at the difference between "Em x Em ." and "Sq x Em ."
                    301:   Carsten Kunze  Fri, 12 Dec 2014 00:15:41 +0100
                    302:   loc *** exist *** algo *** size * imp **
                    303:
                    304: - a column list with blank `Ta' cells triggers a spurious
1.87      kristaps  305:   start-with-whitespace printing of a newline
1.195     schwarze  306:
                    307: - In .Bl -column, .It a<tab>"b<tab>c"
                    308:   shows the quotes in groff, but not in mandoc
                    309:   loc * exist *** algo ** size * imp **
1.1       kristaps  310:
1.39      schwarze  311: - In .Bl -column,
                    312:   .It Em Authentication<tab>Key Length
                    313:   ought to render "Key Length" with emphasis, too,
                    314:   see OpenBSD iked.conf(5).
1.123     schwarze  315:   reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200
1.184     schwarze  316:   loc *  exist ***  algo ***  size **  imp ***
1.39      schwarze  317:
1.1       kristaps  318: - empty phrases in .Bl column produce too few blanks
                    319:   try e.g. .Bl -column It Ta Ta
                    320:   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.184     schwarze  321:   loc *  exist ***  algo ***  size *  imp **
1.48      schwarze  322:
1.83      schwarze  323: - .%T can have trailing punctuation.  Currently, it puts the trailing
                    324:   punctuation into a trailing MDOC_TEXT element inside its own scope.
                    325:   That element should rather be outside its scope, such that the
                    326:   punctuation does not get underlines.  This is not trivial to
                    327:   implement because .%T then needs some features of in_line_eoln() -
                    328:   slurp all arguments into one single text element - and one feature
                    329:   of in_line() - put trailing punctuation out of scope.
                    330:   Found in mount_nfs(8) and exports(5), search for "Appendix".
1.184     schwarze  331:   loc **  exist **  algo ***  size *  imp **
1.83      schwarze  332:
1.147     schwarze  333: - Trailing punctuation after .%T triggers EOS spacing, at least
                    334:   outside .Rs (eek!).  Simply setting ARGSFL_DELIM for .%T is not
                    335:   the right solution, it sends mandoc into an endless loop.
                    336:   reported by Nicolas Joly  Sat, 17 Nov 2012 11:49:54 +0100
1.184     schwarze  337:   loc *  exist **  algo **  size *  imp **
1.147     schwarze  338:
1.174     schwarze  339: - global variables in the SYNOPSIS of section 3 pages
                    340:   .Vt vs .Vt/.Va vs .Ft/.Va vs .Ft/.Fa ...
                    341:   from kristaps@  Tue, 08 Jun 2010 11:13:32 +0200
1.239     schwarze  342:
                    343: - implicit whitespace around inline equations
                    344:   example code:  where '$times$' denotes matrix multiplication
                    345:   must not have an HTML line break, nor a blank, before <math>
                    346:   partial solution: html.c {"math", HTML_NLINSIDE | HTML_INDENT},
                    347:   bentley@  Thu, 13 Jul 2017 19:00:59 -0600
1.174     schwarze  348:
1.48      schwarze  349: - in enclosures, mandoc sometimes fancies a bogus end of sentence
                    350:   reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
1.184     schwarze  351:   loc *  exist **  algo ***  size *  imp ***
1.197     schwarze  352:
                    353: - a line starting with "\fB something" counts as starting with whitespace
                    354:   and triggers a line break; found in audio/normalize-mp3(1)
                    355:   loc **  exist *  algo **  size *  imp **
1.149     schwarze  356:
                    357: - formatting /usr/local/man/man1/latex2man.1 with groff and mandoc
                    358:   reveals lots of bugs both in groff and mandoc...
                    359:   reported by bentley@  Wed, 22 May 2013 23:49:30 -0600
1.171     schwarze  360:
1.230     schwarze  361: --- PostScript and PDF issues ------------------------------------------
1.171     schwarze  362:
                    363: - PDF output doesn't use a monospaced font for .Bd -literal
                    364:   Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf".
                    365:   Search the text "Routing tables".
                    366:   Also check what PostScript mode does when fixing this.
                    367:   reported by juanfra@ Wed, 04 Jun 2014 21:44:58 +0200
1.186     schwarze  368:   instructions from juanfra@  Wed, 11 Jun 2014 02:21:01 +0200
                    369:     add a new <</Type /Font>> block to the PDF files with /BaseFont /Courier
                    370:     and change the /Name from /F0 to the new font (/F5 (?)).
1.230     schwarze  371:   re-reported by tb@ Mon, 16 Mar 2015 16:47:21 +0100
1.186     schwarze  372:   loc *  exist **  algo **  size *  imp **
1.173     schwarze  373:
                    374: --- HTML issues --------------------------------------------------------
1.252     schwarze  375:
                    376: - wrap Sh and Ss content into <div>
                    377:   Laura Morales <lauretas at mail dot com> 21 Apr 2018 18:10:48 +0200
                    378:   (Evaluate whether this is really useful and has no adverse
                    379:    side effects before implementing; if it is possible,
                    380:    it does seem cleaner.)
                    381:   loc **  exist **  algo *  size *  imp ***
1.274     schwarze  382:
                    383: - .IP wants vertical spacing before itself;
                    384:   currently, it is formatted like .Bl -compact.
                    385:   Fixing this requires getting rid of the "float"
                    386:   in the CSS for .Bl-tag first.
                    387:   Reminded by Pali Rohar 25 Oct 2018 10:10:35 +0200.
1.247     schwarze  388:
1.276     schwarze  389: - format multiple subsequent .IP as a single list
                    390:   rather than opening a new list for each item
                    391:   Pali Rohar 25 Nov 2018 14:34:26 +0100
                    392:   loc *  exist **  algo *  size *  imp ***
                    393:
1.247     schwarze  394: - format ".IP *" etc. as <ul> rather than <dl>
                    395:   https://github.com/Debian/debiman/issues/67
1.276     schwarze  396:   reminded by Pali Rohar 25 Nov 2018 14:34:26 +0100
1.247     schwarze  397:   loc ** exist ** algo ** size * imp ***
1.214     schwarze  398:
                    399: - .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal
                    400:   space, see for example random(3).  Introduced in
                    401:   http://mdocml.bsd.lv/cgi-bin/cvsweb/mdoc_html.c.diff?r1=1.91&r2=1.92
                    402:   reported by deraadt@ Mon, 28 Sep 2015 20:14:13 -0600 (MDT)
                    403:   loc **  exist **  algo **  size *  imp *
1.180     schwarze  404:
1.187     schwarze  405: - jsg on icb, Nov 3, 2014:
                    406:   try to guess Xr in man(7) for hyperlinking
1.226     schwarze  407:   and render them with <a class="Xr" href=...>
                    408:   https://github.com/Debian/debiman/issues/15
                    409:   loc *  exist *  algo **  size **  imp **
1.187     schwarze  410:
1.180     schwarze  411: - The tables used to render the three-part page headers actually force
                    412:   the width of the <body> to the max-width given for <html>.
                    413:   Not yet sure how to fix that...
                    414:   Observed by an Anonymous Coward on undeadly.org:
                    415:   http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1
1.184     schwarze  416:   loc *  exist *  algo **  size *  imp ***
1.206     schwarze  417:
                    418: - generate <img> tags in HTML
                    419:   idea from florian@  Tue, 7 Apr 2015 00:26:28 +0000
                    420:   may be possible to implement with .Lk img://something.png alt_text
1.174     schwarze  421:
1.173     schwarze  422: - check https://github.com/trentm/mdocml
1.35      kristaps  423:
1.1       kristaps  424: ************************************************************************
1.104     kristaps  425: * formatting issues: gratuitous differences
1.1       kristaps  426: ************************************************************************
1.187     schwarze  427:
                    428: - .Fn reopens a new scope after punctuation in mandoc,
                    429:   but closes its scope for good in groff.
                    430:   Do we want to change mandoc or groff?
                    431:   Steffen Nurpmeso  Sat, 08 Nov 2014 13:34:59 +0100
                    432:   loc *  exist **  algo **  size *  imp **
1.230     schwarze  433:
1.174     schwarze  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
1.184     schwarze  437:   loc *  exist **  algo **  size *  imp **
1.174     schwarze  438:
1.103     schwarze  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
1.129     schwarze  442:   reported again by sthen@  Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
1.184     schwarze  443:   loc *  exist ***  algo **  size *  imp **
1.39      schwarze  444:
1.83      schwarze  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).
1.184     schwarze  448:   loc *  exist **  algo **  size *  imp **
1.83      schwarze  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
1.184     schwarze  453:   loc *  exist **  algo **  size *  imp **
1.147     schwarze  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.
1.184     schwarze  458:   loc *  exist **  algo **  size *  imp **
1.83      schwarze  459:
                    460: - When the -width string contains macros, the macros must be rendered
                    461:   before measuring the width, for example
                    462:     .Bl -tag -width ".Dv message"
                    463:   in magic(5), located in src/usr.bin/file, is the same
                    464:   as -width 7n, not -width 11n.
1.129     schwarze  465:   The same applies to .Bl -column column widths;
                    466:   reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
1.157     schwarze  467:   reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200
1.234     schwarze  468:   reported again by Bruce Evans Fri, 17 Feb 2017 21:22:44 +0100 via bapt@
1.184     schwarze  469:   loc ***  exist ***  algo ***  size **  imp ***
1.157     schwarze  470:   An easy partial fix would be to just skip the first word if it starts
                    471:   with a dot, including any following white space, when measuring.
1.184     schwarze  472:   loc *  exist *  algo *  size *  imp ***
1.83      schwarze  473:
1.56      schwarze  474: - The \& zero-width character counts as output.
                    475:   That is, when it is alone on a line between two .Pp,
                    476:   we want three blank lines, not two as in mandoc.
1.184     schwarze  477:   loc **  exist **  algo **  size *  imp **
1.83      schwarze  478:
1.205     schwarze  479: - Sequences of multiple man(7) paragraphs (.PP, .IP) interspersed
                    480:   with .ps and .nf/.fi produce execessive blank lines, see libJudy
1.207     schwarze  481:   and graphics/dcmtk.  The parser reorg may help with this.
1.83      schwarze  482:
                    483: - trailing whitespace must be ignored even when followed by a font escape,
1.198     schwarze  484:   see for example
1.83      schwarze  485:     makes
                    486:     \fBdig \fR
                    487:     operate in batch mode
                    488:   in dig(1).
1.184     schwarze  489:   loc **  exist **  algo **  size *  imp **
1.166     schwarze  490:
                    491: ************************************************************************
                    492: * warning issues
                    493: ************************************************************************
1.262     schwarze  494:
                    495: - When a man(1) command returns no result and there was an -S
                    496:   argument, check the -S argument against the list of valid
                    497:   architectures and say "Unknown architecture AAA" rather than
                    498:   "No entry for NNN in the manual" if there is no match.
                    499:   Requires moving the lists of valid architectures out of
                    500:   mdoc_validate.c such that they can be used by main.c.
                    501:   Discussed with jmc@ 10 Aug 2018 19:20:12 +0100.
                    502:   loc **  exist *  algo *  size *  imp **
1.251     schwarze  503:
                    504: - warn about duplicate .Sh/.Ss heads
                    505:   gre(4): Rename duplicate sections 20 Apr 2018 15:27:33 +0200
1.252     schwarze  506:   loc *  exist *  algo *  size *  imp **
1.216     schwarze  507:
1.245     schwarze  508: - style message about macros inside .Bd -literal and .Dl, in particular
                    509:   font changing macros like .Cm, .Ar, .Fa (from the mdoclint TODO)
                    510:
1.246     schwarze  511: - style message about mismatches between the section number in the
                    512:   file name (if it is known) and the section number in .Dt
                    513:   (from the mdoclint TODO)
                    514:
1.245     schwarze  515: - style message about NULL without .Dv (from the mdoclint TODO)
                    516:
                    517: - style message about error constants without .Er (from the mdoclint TODO)
                    518:
1.211     schwarze  519: - warn when .Sh or .Ss contain other macros
                    520:   Steffen Nurpmeso, savannah.gnu.org/bugs/index.php?45034
1.210     schwarze  521:   loc *  exist *  algo *  size *  imp **
1.188     schwarze  522:
1.245     schwarze  523: - style message about violations of the convention
1.246     schwarze  524:   .An name Aq Mt localpart@domain in AUTHORS (from the mdoclint TODO)
1.245     schwarze  525:
1.188     schwarze  526: - warn about attempts to call non-callable macros
                    527:   Steffen Nurpmeso  Tue, 11 Nov 2014 22:55:16 +0100
                    528:   Note that formatting is inconsistent in groff.
                    529:   .Fn Po prints "Po()", .Ar Sh prints "file ..." and no "Sh".
                    530:   Relatively hard because the relevant code is scattered
                    531:   all over mdoc_macro.c and all subtly different.
                    532:   loc **  exist **  algo **  size **  imp **
1.245     schwarze  533:
                    534: - style message about suspicious uses of - vs. \- vs. \(mi
                    535:   e.g. -1 is likely wrong (from the mdoclint TODO)
1.246     schwarze  536:
                    537: - warn about punctuation - e.g. ',' and ';' - at the beginning
                    538:   of a text line, if it is likely intended to follow the preceding
                    539:   output without intervening whitespace, in particular after a
                    540:   macro line (from the mdoclint TODO)
1.174     schwarze  541:
                    542: - mandoc_special does not really check the escape sequence,
                    543:   but just the overall format
1.184     schwarze  544:   loc **  exist **  algo ***  size **  imp **
1.257     schwarze  545:
                    546: - makewhatis -p complains about language subdirectories:
                    547:   /usr/local/man//ru: Unknown directory part
                    548:
1.174     schwarze  549:
                    550: ************************************************************************
                    551: * documentation issues
                    552: ************************************************************************
                    553:
1.241     schwarze  554: - dashes, hyphens, and minus signs in manual pages
                    555:   jmc@ Fri, 28 Mar 2014 07:19:27 +0000
                    556:
1.174     schwarze  557: - mark macros as: page structure domain, manual domain, general text domain
                    558:   is this useful?
                    559:
                    560: - mention /usr/share/misc/mdoc.template in mdoc(7)?
1.185     schwarze  561:
                    562: - Is all the content from http://www.std.com/obi/BSD/doc/usd/28.tbl/tbl
                    563:   covered in tbl(7)?
1.1       kristaps  564:
1.9       kristaps  565: ************************************************************************
                    566: * performance issues
                    567: ************************************************************************
                    568:
1.37      kristaps  569: - the PDF file is HUGE: this can be reduced by using relative offsets
1.115     kristaps  570:
1.23      kristaps  571: ************************************************************************
                    572: * structural issues
                    573: ************************************************************************
1.221     schwarze  574:
                    575: - POSIX says in the documentation of sysconf(3) that PATH_MAX
                    576:   is allowed to be so large that it is a bad idea to use it
                    577:   for sizing static buffers.  So use dynamic buffers throughout.
                    578:   See the file test-PATH_MAX.c for details.
                    579:   Found by Aaron M. Ucko in the GNU Hurd via Bdale Garbee,
                    580:   https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=829624
1.122     schwarze  581:
                    582: - We use the input line number at several places to distinguish
                    583:   same-line from different-line input.  That plainly doesn't work
                    584:   with user-defined macros, leading to random breakage.
1.67      schwarze  585:
1.241     schwarze  586: - Is it possible to further simplify ENDBODY_SPACE?
                    587:
1.67      schwarze  588: - Find better ways to prevent endless loops
                    589:   in roff(7) macro and string expansion.
1.241     schwarze  590:
                    591: - make buffers for parsing functions const
                    592:   christos@ via wiz@  Fri, 18 Dec 2015 17:10:01 +0100
1.186     schwarze  593:
                    594: - struct mparse refactoring
                    595:   Steffen Nurpmeso  Thu, 04 Sep 2014 12:50:00 +0200
1.170     schwarze  596:
1.179     kristaps  597: ************************************************************************
                    598: * CGI issues
                    599: ************************************************************************
                    600:
                    601:  - Enable HTTP compression by detecting gzip encoding and filtering
                    602:    output through libz.
1.256     schwarze  603:  - Privilege separation (see OpenSSH).
1.179     kristaps  604:  - Enable caching support via HTTP 304 and If-Modified-Since.
                    605:  - Have Mac OSX systems automatically disable -static compilation of the
                    606:    CGI: -static isn't supported.
1.181     kristaps  607:
1.192     schwarze  608: ************************************************************************
                    609: * to improve in the groff_mdoc(7) macros
                    610: ************************************************************************
1.252     schwarze  611:
                    612: - .Cd # arch1, arch2 in section 4 pages:
                    613:   find better way to indicate multiple architectures, maybe:
                    614:   allow .Dt vgafb 4 "macppc sparc64"
                    615:   already shown as "Device Drivers Manual (macppc sparc64)"
                    616:   for apropos, make that "vgafb(4) - macppc # sparc64" instead of "- all"
                    617:   groff can be made to show multiple arches, too, but it is
                    618:   tedious to do the string parsing in roff code...
                    619:   jmc@ 23 Apr 2018 07:24:52 +0100 [man for vgafb(4)...]
                    620:   loc **  exist **  algo *  size *  imp ***
1.192     schwarze  621:
                    622: - use uname(1) to set doc-default-operating-system at install time
                    623:   tobimensch  Mon, 1 Dec 2014 00:25:07 +0100
1.236     schwarze  624:
                    625: - apostrophe (39), circumflex (94), grave (96), tilde (126)
                    626:   in manuals: \(aq, \(ha, \`, \(ti
                    627:   Re: [Groff] ASCII Minus Sign in man Pages.
                    628:   bentley@ 26 Apr 2017 10:02:06 -0600
                    629:   Do we need to fix existing manuals?
                    630:   Do we need to fix the definition of the mdoc(7) language?

CVSweb