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