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