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