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