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