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