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