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