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