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