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