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