Annotation of mandoc/TODO, Revision 1.239
1.1 kristaps 1: ************************************************************************
1.37 kristaps 2: * Official mandoc TODO.
1.239 ! schwarze 3: * $Id: TODO,v 1.238 2017/06/23 22:20:17 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 ----------------------------------------------
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.160 schwarze 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
1.184 schwarze 57: loc * exist * algo * size * imp **
1.160 schwarze 58:
1.80 schwarze 59: - .ns (no-space mode) occurs in xine-config(1)
1.205 schwarze 60: when implementing this, also let .TH set it
1.80 schwarze 61: reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500
1.184 schwarze 62: loc *** exist *** algo *** size ** imp *
1.61 schwarze 63:
1.198 schwarze 64: - .while and .shift
1.154 schwarze 65: found by jca@ in ratpoison(1) Sun, 30 Jun 2013 12:01:09 +0200
1.184 schwarze 66: loc * exist ** algo ** size ** imp **
1.155 schwarze 67:
68: - \h horizontal move
1.200 schwarze 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
1.194 schwarze 71: bentley@ on discuss@ Sat, 21 Sep 2013 22:29:34 -0600
72: naddy@ Thu, 4 Dec 2014 16:26:41 +0100
1.200 schwarze 73: loc ** exist ** algo ** size * imp *** (parser reorg helps a lot)
1.125 schwarze 74:
1.160 schwarze 75: - \n+ and \n- numerical register increment and decrement
76: found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700
1.184 schwarze 77: loc * exist * algo * size * imp **
1.201 schwarze 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 **
1.160 schwarze 82:
1.184 schwarze 83: - \w'' improve width measurements
1.167 schwarze 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
1.184 schwarze 86: loc ** exist *** algo *** size * imp ***
1.203 schwarze 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 *
1.167 schwarze 100:
1.125 schwarze 101: - using undefined strings or macros defines them to be empty
102: wl@ Mon, 14 Nov 2011 14:37:01 +0000
1.184 schwarze 103: loc * exist * algo * size * imp *
1.167 schwarze 104:
1.79 schwarze 105: --- missing mdoc features ----------------------------------------------
1.18 schwarze 106:
1.1 kristaps 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
1.184 schwarze 113: loc * exist *** algo *** size * imp **
1.1 kristaps 114:
1.28 schwarze 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
1.184 schwarze 118: loc * exist *** algo *** size ** imp **
1.28 schwarze 119:
1.174 schwarze 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.
1.184 schwarze 125: loc *** exist *** algo ** size ** imp ** (parser reorg would help)
1.174 schwarze 126:
1.82 schwarze 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).
1.184 schwarze 130: loc *** exist *** algo ** size ** imp ** (parser reorg would help)
1.22 schwarze 131:
1.10 kristaps 132: - implement blank `Bl -column', such as
133: .Bl -column
134: .It foo Ta bar
135: .El
1.184 schwarze 136: loc * exist *** algo *** size * imp *
1.11 kristaps 137:
138: - explicitly disallow nested `Bl -column', which would clobber internal
139: flags defined for struct mdoc_macro
1.184 schwarze 140: loc * exist * algo * size * imp **
1.102 schwarze 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
1.184 schwarze 151: loc * exist *** algo ** size * imp **
1.42 schwarze 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 ."
1.12 kristaps 159:
1.174 schwarze 160: - check whether it is correct that `D1' uses INDENT+1;
161: does it need its own constant?
1.184 schwarze 162: loc * exist ** algo ** size * imp **
1.174 schwarze 163:
1.20 kristaps 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)
1.109 schwarze 167:
1.174 schwarze 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
1.184 schwarze 173: loc ** exist ** algo ** size * imp **
1.174 schwarze 174:
1.109 schwarze 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
1.184 schwarze 182: loc * exist ** algo *** size * imp **
1.57 kristaps 183:
1.79 schwarze 184: --- missing tbl features -----------------------------------------------
1.213 schwarze 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 ***
1.222 schwarze 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
1.213 schwarze 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 **
1.79 schwarze 206:
1.208 schwarze 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;
1.233 schwarze 210: informed by bapt@ that FreeBSD needs this: 3 Jan 2015 23:32:23 +0100
1.208 schwarze 211: loc *** exist ** algo *** size ** imp ***
212:
1.171 schwarze 213: - look at the POSIX manuals in the books/man-pages-posix port,
214: they use some unsupported tbl(7) features.
1.184 schwarze 215: loc * exist ** algo ** size ** imp ***
1.171 schwarze 216:
1.230 schwarze 217: - look what Joerg Schilling manual pages use
218: Thu, 19 Mar 2015 18:31:48 +0100
219:
1.183 schwarze 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
1.184 schwarze 223: loc * exist ** algo * size * imp **
1.105 kristaps 224:
1.182 schwarze 225: --- missing eqn features -----------------------------------------------
1.209 schwarze 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 **
1.182 schwarze 231:
232: - The "size" keyword is parsed, but ignored by the formatter.
1.184 schwarze 233: loc * exist * algo * size * imp *
1.182 schwarze 234:
235: - The spacing characters `~', `^', and tab are currently ignored,
236: see User's Guide (Second Edition) page 2 section 4.
1.184 schwarze 237: loc * exist * algo ** size * imp **
1.182 schwarze 238:
239: - Mark and lineup are parsed and ignored,
240: see User's Guide (Second Edition) page 5 section 15.
1.184 schwarze 241: loc ** exist ** algo ** size ** imp **
1.238 schwarze 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
1.182 schwarze 249:
1.239 ! schwarze 250: - Primes, opprime, and '
! 251: bentley@ Thu, 13 Jul 2017 23:14:20 -0600
! 252:
1.79 schwarze 253: --- missing misc features ----------------------------------------------
1.159 schwarze 254:
255: - italic correction (\/) in PostScript mode
256: Werner LEMBERG on groff at gnu dot org Sun, 10 Nov 2013 12:47:46
1.184 schwarze 257: loc ** exist ** algo * size * imp *
1.153 schwarze 258:
1.210 schwarze 259: - change the default PAGER to more -Es and use the pager
260: even for apropos title line output; req by bapt@
261: loc * exist * algo * size * imp ***
1.171 schwarze 262:
1.79 schwarze 263: - clean up escape sequence handling, creating three classes:
264: (1) fully implemented, or parsed and ignored without loss of content
265: (2) unimplemented, potentially causing loss of content
266: or serious mangling of formatting (e.g. \n) -> ERROR
267: see textproc/mgdiff(1) for nice examples
268: (3) undefined, just output the character -> perhaps WARNING
1.184 schwarze 269: loc *** exist ** algo ** size ** imp *** (parser reorg helps)
1.83 schwarze 270:
1.174 schwarze 271: - kettenis wants base roff, ms, and me Fri, 1 Jan 2010 22:13:15 +0100 (CET)
1.184 schwarze 272: loc ** exist ** algo ** size *** imp *
1.174 schwarze 273:
274: --- compatibility checks -----------------------------------------------
1.196 schwarze 275:
1.174 schwarze 276: - is .Bk implemented correctly in modern groff?
277: sobrado@ Tue, 19 Apr 2011 22:12:55 +0200
278:
1.175 schwarze 279: - compare output to Heirloom roff, Solaris roff, and
280: http://repo.or.cz/w/neatroff.git http://litcave.rudi.ir/
1.178 schwarze 281:
282: - look at AT&T DWB http://www2.research.att.com/sw/download
283: Carsten Kunze <carsten dot kunze at arcor dot de> has patches
284: Mon, 4 Aug 2014 17:01:28 +0200
1.230 schwarze 285: ported version: https://github.com/n-t-roff/DWB3.3
286: Carsten Kunze Wed, 22 Apr 2015 11:21:43 +0200
1.174 schwarze 287:
1.79 schwarze 288: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
289: These are a weird mixture of man(7) and custom autogenerated low-level
290: roff stuff. Figure out to what extent we can cope.
1.80 schwarze 291: For details, see http://docutils.sourceforge.net/rst.html
1.79 schwarze 292: noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
293: reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
1.160 schwarze 294:
1.174 schwarze 295: - look at pages generated from ronn(1) github.com/rtomayko/ronn
296: (based on markdown)
297:
1.160 schwarze 298: - look at pages generated from Texinfo source by yat2m, e.g. security/gnupg
299: First impression is not that bad.
1.172 schwarze 300:
301: - look at pages generated by pandoc; see
302: https://github.com/jgm/pandoc/blob/master/src/Text/Pandoc/Writers/Man.hs
303: porting planned by kili@ Thu, 19 Jun 2014 19:46:28 +0200
1.71 schwarze 304:
305: - check compatibility with Plan9:
306: http://swtch.com/usr/local/plan9/tmac/tmac.an
307: http://swtch.com/plan9port/man/man7/man.html
308: "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
1.63 schwarze 309:
1.207 schwarze 310: - check compatibility with COHERENT troff:
311: http://www.nesssoftware.com/home/mwc/source.php
312:
1.174 schwarze 313: - check compatibility with the man(7) formatter
314: https://raw.githubusercontent.com/rofl0r/hardcore-utils/master/man.c
315:
1.186 schwarze 316: - check compatibility with
317: http://ikiwiki.info/plugins/contrib/mandoc/
318: https://github.com/schmonz/ikiwiki/compare/mandoc
319: Amitai Schlair Mon, 19 May 2014 14:05:53 -0400
320:
1.230 schwarze 321: - check features of the Slackware man.conf(5) format
322: Carsten Kunze Wed, 11 Mar 2015 17:57:24 +0100
323:
1.1 kristaps 324: ************************************************************************
325: * formatting issues: ugly output
326: ************************************************************************
1.87 kristaps 327:
1.195 schwarze 328: - revisit empty in-line macros
329: look at the difference between "Em x Em ." and "Sq x Em ."
330: Carsten Kunze Fri, 12 Dec 2014 00:15:41 +0100
331: loc *** exist *** algo *** size * imp **
332:
333: - a column list with blank `Ta' cells triggers a spurious
1.87 kristaps 334: start-with-whitespace printing of a newline
1.195 schwarze 335:
336: - In .Bl -column, .It a<tab>"b<tab>c"
337: shows the quotes in groff, but not in mandoc
338: loc * exist *** algo ** size * imp **
1.1 kristaps 339:
1.39 schwarze 340: - In .Bl -column,
341: .It Em Authentication<tab>Key Length
342: ought to render "Key Length" with emphasis, too,
343: see OpenBSD iked.conf(5).
1.123 schwarze 344: reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200
1.184 schwarze 345: loc * exist *** algo *** size ** imp ***
1.39 schwarze 346:
1.1 kristaps 347: - empty phrases in .Bl column produce too few blanks
348: try e.g. .Bl -column It Ta Ta
349: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.184 schwarze 350: loc * exist *** algo *** size * imp **
1.48 schwarze 351:
1.83 schwarze 352: - .%T can have trailing punctuation. Currently, it puts the trailing
353: punctuation into a trailing MDOC_TEXT element inside its own scope.
354: That element should rather be outside its scope, such that the
355: punctuation does not get underlines. This is not trivial to
356: implement because .%T then needs some features of in_line_eoln() -
357: slurp all arguments into one single text element - and one feature
358: of in_line() - put trailing punctuation out of scope.
359: Found in mount_nfs(8) and exports(5), search for "Appendix".
1.184 schwarze 360: loc ** exist ** algo *** size * imp **
1.83 schwarze 361:
1.147 schwarze 362: - Trailing punctuation after .%T triggers EOS spacing, at least
363: outside .Rs (eek!). Simply setting ARGSFL_DELIM for .%T is not
364: the right solution, it sends mandoc into an endless loop.
365: reported by Nicolas Joly Sat, 17 Nov 2012 11:49:54 +0100
1.184 schwarze 366: loc * exist ** algo ** size * imp **
1.147 schwarze 367:
1.174 schwarze 368: - global variables in the SYNOPSIS of section 3 pages
369: .Vt vs .Vt/.Va vs .Ft/.Va vs .Ft/.Fa ...
370: from kristaps@ Tue, 08 Jun 2010 11:13:32 +0200
1.239 ! schwarze 371:
! 372: - implicit whitespace around inline equations
! 373: example code: where '$times$' denotes matrix multiplication
! 374: must not have an HTML line break, nor a blank, before <math>
! 375: partial solution: html.c {"math", HTML_NLINSIDE | HTML_INDENT},
! 376: bentley@ Thu, 13 Jul 2017 19:00:59 -0600
1.174 schwarze 377:
1.48 schwarze 378: - in enclosures, mandoc sometimes fancies a bogus end of sentence
379: reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059
1.184 schwarze 380: loc * exist ** algo *** size * imp ***
1.197 schwarze 381:
382: - a line starting with "\fB something" counts as starting with whitespace
383: and triggers a line break; found in audio/normalize-mp3(1)
384: loc ** exist * algo ** size * imp **
1.149 schwarze 385:
386: - formatting /usr/local/man/man1/latex2man.1 with groff and mandoc
387: reveals lots of bugs both in groff and mandoc...
388: reported by bentley@ Wed, 22 May 2013 23:49:30 -0600
1.171 schwarze 389:
1.230 schwarze 390: --- PostScript and PDF issues ------------------------------------------
1.171 schwarze 391:
392: - PDF output doesn't use a monospaced font for .Bd -literal
393: Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf".
394: Search the text "Routing tables".
395: Also check what PostScript mode does when fixing this.
396: reported by juanfra@ Wed, 04 Jun 2014 21:44:58 +0200
1.186 schwarze 397: instructions from juanfra@ Wed, 11 Jun 2014 02:21:01 +0200
398: add a new <</Type /Font>> block to the PDF files with /BaseFont /Courier
399: and change the /Name from /F0 to the new font (/F5 (?)).
1.230 schwarze 400: re-reported by tb@ Mon, 16 Mar 2015 16:47:21 +0100
1.186 schwarze 401: loc * exist ** algo ** size * imp **
1.173 schwarze 402:
403: --- HTML issues --------------------------------------------------------
1.214 schwarze 404:
405: - .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal
406: space, see for example random(3). Introduced in
407: http://mdocml.bsd.lv/cgi-bin/cvsweb/mdoc_html.c.diff?r1=1.91&r2=1.92
408: reported by deraadt@ Mon, 28 Sep 2015 20:14:13 -0600 (MDT)
409: loc ** exist ** algo ** size * imp *
1.180 schwarze 410:
1.187 schwarze 411: - jsg on icb, Nov 3, 2014:
412: try to guess Xr in man(7) for hyperlinking
1.226 schwarze 413: and render them with <a class="Xr" href=...>
414: https://github.com/Debian/debiman/issues/15
415: loc * exist * algo ** size ** imp **
1.187 schwarze 416:
1.180 schwarze 417: - The tables used to render the three-part page headers actually force
418: the width of the <body> to the max-width given for <html>.
419: Not yet sure how to fix that...
420: Observed by an Anonymous Coward on undeadly.org:
421: http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1
1.184 schwarze 422: loc * exist * algo ** size * imp ***
1.206 schwarze 423:
424: - generate <img> tags in HTML
425: idea from florian@ Tue, 7 Apr 2015 00:26:28 +0000
426: may be possible to implement with .Lk img://something.png alt_text
1.174 schwarze 427:
1.173 schwarze 428: - check https://github.com/trentm/mdocml
1.35 kristaps 429:
1.1 kristaps 430: ************************************************************************
1.104 kristaps 431: * formatting issues: gratuitous differences
1.1 kristaps 432: ************************************************************************
1.187 schwarze 433:
434: - .Fn reopens a new scope after punctuation in mandoc,
435: but closes its scope for good in groff.
436: Do we want to change mandoc or groff?
437: Steffen Nurpmeso Sat, 08 Nov 2014 13:34:59 +0100
438: loc * exist ** algo ** size * imp **
1.230 schwarze 439:
440: - .Lk formatting for long links with line breaks
441: Franco Fichtner 8 Oct 2013 00:33:42 +0200
1.103 schwarze 442:
1.174 schwarze 443: - In .Bl -enum -width 0n, groff continues one the same line after
444: the number, mandoc breaks the line.
445: mail to kristaps@ Mon, 20 Jul 2009 02:21:39 +0200
1.184 schwarze 446: loc * exist ** algo ** size * imp **
1.174 schwarze 447:
1.103 schwarze 448: - .Pp between two .It in .Bl -column should produce one,
449: not two blank lines, see e.g. login.conf(5).
450: reported by jmc@ Sun, 17 Apr 2011 14:04:58 +0059
1.129 schwarze 451: reported again by sthen@ Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
1.184 schwarze 452: loc * exist *** algo ** size * imp **
1.39 schwarze 453:
1.83 schwarze 454: - If the *first* line after .It is .Pp, break the line right after
455: the tag, do not pad with space characters before breaking.
456: See the description of the a, c, and i commands in sed(1).
1.184 schwarze 457: loc * exist ** algo ** size * imp **
1.83 schwarze 458:
459: - If the first line after .It is .D1, do not assert a blank line
460: in between, see for example tmux(1).
461: reported by nicm@ 13 Jan 2011 00:18:57 +0000
1.184 schwarze 462: loc * exist ** algo ** size * imp **
1.147 schwarze 463:
464: - Trailing punctuation after .It should trigger EOS spacing.
465: reported by Nicolas Joly Sat, 17 Nov 2012 11:49:54 +0100
466: Probably, this should be fixed somewhere in termp_it_pre(), not sure.
1.184 schwarze 467: loc * exist ** algo ** size * imp **
1.83 schwarze 468:
1.39 schwarze 469: - .Nx 1.0a
470: should be "NetBSD 1.0A", not "NetBSD 1.0a",
471: see OpenBSD ccdconfig(8).
1.184 schwarze 472: loc * exist * algo * size * imp **
1.83 schwarze 473:
1.39 schwarze 474: - In .Bl -tag, if a tag exceeds the right margin and must be continued
475: on the next line, it must be indented by -width, not width+1;
476: see "rule block|pass" in OpenBSD ifconfig(8).
1.184 schwarze 477: loc * exist *** algo ** size * imp **
1.56 schwarze 478:
1.83 schwarze 479: - When the -width string contains macros, the macros must be rendered
480: before measuring the width, for example
481: .Bl -tag -width ".Dv message"
482: in magic(5), located in src/usr.bin/file, is the same
483: as -width 7n, not -width 11n.
1.129 schwarze 484: The same applies to .Bl -column column widths;
485: reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
1.157 schwarze 486: reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200
1.234 schwarze 487: reported again by Bruce Evans Fri, 17 Feb 2017 21:22:44 +0100 via bapt@
1.184 schwarze 488: loc *** exist *** algo *** size ** imp ***
1.157 schwarze 489: An easy partial fix would be to just skip the first word if it starts
490: with a dot, including any following white space, when measuring.
1.184 schwarze 491: loc * exist * algo * size * imp ***
1.83 schwarze 492:
1.56 schwarze 493: - The \& zero-width character counts as output.
494: That is, when it is alone on a line between two .Pp,
495: we want three blank lines, not two as in mandoc.
1.184 schwarze 496: loc ** exist ** algo ** size * imp **
1.83 schwarze 497:
1.205 schwarze 498: - Sequences of multiple man(7) paragraphs (.PP, .IP) interspersed
499: with .ps and .nf/.fi produce execessive blank lines, see libJudy
1.207 schwarze 500: and graphics/dcmtk. The parser reorg may help with this.
1.83 schwarze 501:
502: - trailing whitespace must be ignored even when followed by a font escape,
1.198 schwarze 503: see for example
1.83 schwarze 504: makes
505: \fBdig \fR
506: operate in batch mode
507: in dig(1).
1.184 schwarze 508: loc ** exist ** algo ** size * imp **
1.166 schwarze 509:
510: ************************************************************************
511: * warning issues
512: ************************************************************************
1.216 schwarze 513:
514: - provide a way in mandoc(1) to warn about broken .Xr links;
515: probably cannot be on by default in -Tlint because it needs
516: to access the manpath and mandoc.db(3) after parsing.
517: asked for by jmc@ Fri, 4 Dec 2015 22:39:40 +0000
1.211 schwarze 518:
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:
523: - warn about attempts to call non-callable macros
524: Steffen Nurpmeso Tue, 11 Nov 2014 22:55:16 +0100
525: Note that formatting is inconsistent in groff.
526: .Fn Po prints "Po()", .Ar Sh prints "file ..." and no "Sh".
527: Relatively hard because the relevant code is scattered
528: all over mdoc_macro.c and all subtly different.
529: loc ** exist ** algo ** size ** imp **
1.174 schwarze 530:
531: - mandoc_special does not really check the escape sequence,
532: but just the overall format
1.184 schwarze 533: loc ** exist ** algo *** size ** imp **
1.174 schwarze 534:
535: - integrate mdoclint into mandoc ("end-of-line whitespace" thread)
536: from jmc@ Mon, 13 Jul 2009 17:12:09 +0100
537: from kristaps@ Mon, 13 Jul 2009 18:34:53 +0200
538: from jmc@ Mon, 13 Jul 2009 17:45:37 +0059
539: from kristaps@ Mon, 13 Jul 2009 19:02:03 +0200
1.184 schwarze 540: (mostly done, check what remains)
1.174 schwarze 541:
542: - -Tlint parser errors and warnings to stdout
543: to tech@mdocml, naddy@ Wed, 28 Sep 2011 11:21:46 +0200
544: wait! kristaps@ Sun, 02 Oct 2011 17:12:52 +0200
545:
546: ************************************************************************
547: * documentation issues
548: ************************************************************************
549:
550: - mark macros as: page structure domain, manual domain, general text domain
551: is this useful?
552:
553: - mention /usr/share/misc/mdoc.template in mdoc(7)?
1.185 schwarze 554:
555: - Is all the content from http://www.std.com/obi/BSD/doc/usd/28.tbl/tbl
556: covered in tbl(7)?
1.1 kristaps 557:
1.9 kristaps 558: ************************************************************************
559: * performance issues
560: ************************************************************************
1.176 schwarze 561:
562: - Why are we using MAP_SHARED, not MAP_PRIVATE for mmap(2)?
563: from kristaps@ Sat, 09 Aug 2014 13:51:36 +0200
1.9 kristaps 564:
1.198 schwarze 565: Several areas can be cleaned up to make mandoc even faster. These are
1.9 kristaps 566:
1.37 kristaps 567: - the PDF file is HUGE: this can be reduced by using relative offsets
1.115 kristaps 568:
1.23 kristaps 569: ************************************************************************
570: * structural issues
571: ************************************************************************
1.221 schwarze 572:
573: - POSIX says in the documentation of sysconf(3) that PATH_MAX
574: is allowed to be so large that it is a bad idea to use it
575: for sizing static buffers. So use dynamic buffers throughout.
576: See the file test-PATH_MAX.c for details.
577: Found by Aaron M. Ucko in the GNU Hurd via Bdale Garbee,
578: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=829624
1.122 schwarze 579:
580: - We use the input line number at several places to distinguish
581: same-line from different-line input. That plainly doesn't work
582: with user-defined macros, leading to random breakage.
1.67 schwarze 583:
584: - Find better ways to prevent endless loops
585: in roff(7) macro and string expansion.
1.198 schwarze 586:
1.96 schwarze 587: - Finish cleanup of date handling.
1.91 schwarze 588: Decide which formats should be recognized where.
589: Update both mdoc(7) and man(7) documentation.
590: Triggered by Tim van der Molen Tue, 22 Feb 2011 20:30:45 +0100
1.186 schwarze 591:
592: - struct mparse refactoring
593: Steffen Nurpmeso Thu, 04 Sep 2014 12:50:00 +0200
1.170 schwarze 594:
1.179 kristaps 595: ************************************************************************
596: * CGI issues
597: ************************************************************************
598:
599: - Enable HTTP compression by detecting gzip encoding and filtering
600: output through libz.
601: - Sandbox (see OpenSSH).
602: - Enable caching support via HTTP 304 and If-Modified-Since.
603: - Have Mac OSX systems automatically disable -static compilation of the
604: CGI: -static isn't supported.
1.181 kristaps 605:
1.192 schwarze 606: ************************************************************************
607: * to improve in the groff_mdoc(7) macros
608: ************************************************************************
609:
610: - use uname(1) to set doc-default-operating-system at install time
611: tobimensch Mon, 1 Dec 2014 00:25:07 +0100
1.236 schwarze 612:
613: - apostrophe (39), circumflex (94), grave (96), tilde (126)
614: in manuals: \(aq, \(ha, \`, \(ti
615: Re: [Groff] ASCII Minus Sign in man Pages.
616: bentley@ 26 Apr 2017 10:02:06 -0600
617: Do we need to fix existing manuals?
618: Do we need to fix the definition of the mdoc(7) language?
CVSweb