Annotation of mandoc/TODO, Revision 1.173
1.1 kristaps 1: ************************************************************************
1.37 kristaps 2: * Official mandoc TODO.
1.173 ! schwarze 3: * $Id: TODO,v 1.172 2014/06/20 02:53:13 schwarze Exp $
1.27 kristaps 4: ************************************************************************
1.145 schwarze 5:
6: ************************************************************************
7: * crashes
8: ************************************************************************
9:
1.169 schwarze 10: - The abort() in bufcat(), html.c, can be triggered via buffmt_includes()
11: by running -Thtml -Oincludes on a file containing a long .In argument.
12: Fixing this will probably require reworking the whole bufcat() concept.
1.101 schwarze 13:
1.61 schwarze 14: ************************************************************************
1.1 kristaps 15: * missing features
16: ************************************************************************
1.70 kristaps 17:
1.79 schwarze 18: --- missing roff features ----------------------------------------------
19:
1.82 schwarze 20: - .ad (adjust margins)
21: .ad l -- adjust left margin only (flush left)
22: .ad r -- adjust right margin only (flush right)
23: .ad c -- center text on line
24: .ad b -- adjust both margins (alias: .ad n)
25: .na -- temporarily disable adjustment without changing the mode
26: .ad -- re-enable adjustment without changing the mode
27: Adjustment mode is ignored while in no-fill mode (.nf).
1.150 schwarze 28:
29: - .fc (field control)
30: found by naddy@ in xloadimage(1)
31:
1.160 schwarze 32: - .nr third argument (auto-increment step size, requires \n+)
33: found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700
34:
1.80 schwarze 35: - .ns (no-space mode) occurs in xine-config(1)
36: reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500
1.61 schwarze 37:
1.81 schwarze 38: - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
39: reported by brad@ Sat, 15 Jan 2011 15:50:51 -0500
1.167 schwarze 40: also Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100
1.150 schwarze 41:
42: - .ti (temporary indent)
43: found by naddy@ in xloadimage(1)
44: found by bentley@ in nmh(1) Mon, 23 Apr 2012 13:38:28 -0600
1.154 schwarze 45:
46: - .while and .shift
47: found by jca@ in ratpoison(1) Sun, 30 Jun 2013 12:01:09 +0200
1.79 schwarze 48:
1.132 schwarze 49: - \c (interrupted text) should prevent the line break
50: even inside .Bd literal; that occurs in chat(8)
1.155 schwarze 51: also found in cclive(1) - DocBook output
52:
53: - \h horizontal move
54: found in cclive(1) DocBook output
55: Anthony J. Bentley on discuss@ Sat, 21 Sep 2013 22:29:34 -0600
1.125 schwarze 56:
1.160 schwarze 57: - \n+ and \n- numerical register increment and decrement
58: found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700
59:
1.167 schwarze 60: - \w'' width measurements
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
63:
1.125 schwarze 64: - using undefined strings or macros defines them to be empty
65: wl@ Mon, 14 Nov 2011 14:37:01 +0000
1.167 schwarze 66:
67: - general expression parser, including arithmetics
68: to be used at least for .if/.ie and .nr and maybe at other places
69: could use J.T.Conklin's PD code in bin/expr/expr.c for inspiration
70: needed for Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100
1.98 schwarze 71:
1.79 schwarze 72: --- missing mdoc features ----------------------------------------------
73:
1.18 schwarze 74: - fix bad block nesting involving multiple identical explicit blocks
75: see the OpenBSD mdoc_macro.c 1.47 commit message
76:
1.1 kristaps 77: - .Bl -column .Xo support is missing
78: ultimate goal:
79: restore .Xr and .Dv to
80: lib/libc/compat-43/sigvec.3
81: lib/libc/gen/signal.3
82: lib/libc/sys/sigaction.2
83:
1.28 schwarze 84: - edge case: decide how to deal with blk_full bad nesting, e.g.
85: .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
86: from jmc@ Wed, 14 Jul 2010 18:10:32 +0100
87:
1.74 schwarze 88: - \\ is now implemented correctly
89: * when defining strings and macros using .ds and .de
90: * when parsing roff(7) and man(7) macro arguments
91: It does not yet work in mdoc(7) macro arguments
92: because libmdoc does not yet use mandoc_getarg().
93: Also check what happens in plain text, it must be identical to \e.
1.82 schwarze 94:
95: - .Bd -filled should not be the same as .Bd -ragged, but align both
96: the left and right margin. In groff, it is implemented in terms
97: of .ad b, which we don't have either. Found in cksum(1).
1.22 schwarze 98:
1.10 kristaps 99: - implement blank `Bl -column', such as
100: .Bl -column
101: .It foo Ta bar
102: .El
1.11 kristaps 103:
104: - explicitly disallow nested `Bl -column', which would clobber internal
105: flags defined for struct mdoc_macro
1.102 schwarze 106:
107: - In .Bl -column .It, the end of the line probably has to be regarded
108: as an implicit .Ta, if there could be one, see the following mildly
109: ugly code from login.conf(5):
110: .Bl -column minpasswordlen program xetcxmotd
111: .It path Ta path Ta value of Dv _PATH_DEFPATH
112: .br
113: Default search path.
114: reported by Michal Mazurek <akfaew at jasminek dot net>
115: via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
1.42 schwarze 116:
117: - inside `.Bl -column' phrases, punctuation is handled like normal
118: text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
119:
120: - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
121: is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
122: but should give "ab ."
1.12 kristaps 123:
124: - set a meaningful default if no `Bl' list type is assigned
1.13 kristaps 125:
126: - have a blank `It' head for `Bl -tag' not puke
1.20 kristaps 127:
128: - prohibit `Nm' from having non-text HEAD children
129: (e.g., NetBSD mDNSShared/dns-sd.1)
130: (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.109 schwarze 131:
132: - When there is free text in the SYNOPSIS and that free text contains
133: the .Nm macro, groff somehow understands to treat the .Nm as an in-line
134: macro, while mandoc treats it as a block macro and breaks the line.
135: No idea how the logic for distinguishing in-line and block instances
136: should be, needs investigation.
137: uqs@ Thu, 2 Jun 2011 11:03:51 +0200
138: uqs@ Thu, 2 Jun 2011 11:33:35 +0200
1.57 kristaps 139:
1.79 schwarze 140: --- missing man features -----------------------------------------------
141:
1.119 kristaps 142: - -T[x]html doesn't stipulate non-collapsing spaces in literal mode
1.80 schwarze 143:
1.79 schwarze 144: --- missing tbl features -----------------------------------------------
145:
1.171 schwarze 146: - look at the POSIX manuals in the books/man-pages-posix port,
147: they use some unsupported tbl(7) features.
148:
1.79 schwarze 149: - implement basic non-parametric .de to support e.g. sox(1)
150: reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
151: *** sox(1) still doesn't work, tbl(1) errors need investigation
1.105 kristaps 152:
153: - allow standalone `.' to be interpreted as an end-of-layout
154: delimiter instead of being thrown away as a no-op roff line
155: reported by Yuri Pankov, Wed 18 May 2011 11:34:59 CEST
1.79 schwarze 156:
157: --- missing misc features ----------------------------------------------
1.159 schwarze 158:
159: - italic correction (\/) in PostScript mode
160: Werner LEMBERG on groff at gnu dot org Sun, 10 Nov 2013 12:47:46
1.153 schwarze 161:
162: - The whatis(1) utility looks for whole words in Nm.
163: If the file name of a page does not agree with the contents of any
164: of its Nm macros (e.g. pool(9)), add the file name as an Nm entry
165: to the mandoc.db as well, such that whatis(1) finds it.
166: If there is a page with a file name that does not appear as a substring
167: neither in Nm nor in Nd, the same fix would allow finding that page
168: with apropos(1) using the file name as a key, as well.
169: Issue reported by tedu@ Fri, 05 Jul 2013 21:15:23 -0400
1.79 schwarze 170:
1.173 ! schwarze 171: - When makewhatis(8) encounters a FATAL parse error,
! 172: it silently treats the file as formatted, which makes no sense
! 173: at all for paths like man1/foo.1 - and which also contradicts
! 174: what the manual says at the end of the description.
! 175: The end result will be ENOENT for file names returned
! 176: by mansearch() in manpage.file.
! 177:
1.171 schwarze 178: - makewhatis(8) for preformatted pages:
179: parse the section number from the header line
180: and compare to the section number from the directory name
181:
182: - Does makewhatis(8) detect missing NAME sections, missing names,
183: and missing descriptions in all the file formats?
184:
1.79 schwarze 185: - clean up escape sequence handling, creating three classes:
186: (1) fully implemented, or parsed and ignored without loss of content
187: (2) unimplemented, potentially causing loss of content
188: or serious mangling of formatting (e.g. \n) -> ERROR
189: see textproc/mgdiff(1) for nice examples
190: (3) undefined, just output the character -> perhaps WARNING
1.83 schwarze 191:
1.79 schwarze 192: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
193: These are a weird mixture of man(7) and custom autogenerated low-level
194: roff stuff. Figure out to what extent we can cope.
1.80 schwarze 195: For details, see http://docutils.sourceforge.net/rst.html
1.79 schwarze 196: noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
197: reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
1.160 schwarze 198:
199: - look at pages generated from Texinfo source by yat2m, e.g. security/gnupg
200: First impression is not that bad.
1.172 schwarze 201:
202: - look at pages generated by pandoc; see
203: https://github.com/jgm/pandoc/blob/master/src/Text/Pandoc/Writers/Man.hs
204: porting planned by kili@ Thu, 19 Jun 2014 19:46:28 +0200
1.71 schwarze 205:
206: - check compatibility with Plan9:
207: http://swtch.com/usr/local/plan9/tmac/tmac.an
208: http://swtch.com/plan9port/man/man7/man.html
209: "Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700
1.63 schwarze 210:
1.1 kristaps 211: ************************************************************************
212: * formatting issues: ugly output
213: ************************************************************************
1.87 kristaps 214:
215: - a column list with blank `Ta' cells triggers a spurrious
216: start-with-whitespace printing of a newline
1.1 kristaps 217:
1.39 schwarze 218: - In .Bl -column,
219: .It Em Authentication<tab>Key Length
220: ought to render "Key Length" with emphasis, too,
221: see OpenBSD iked.conf(5).
1.123 schwarze 222: reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200
1.39 schwarze 223:
1.1 kristaps 224: - empty phrases in .Bl column produce too few blanks
225: try e.g. .Bl -column It Ta Ta
226: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.48 schwarze 227:
1.83 schwarze 228: - .%T can have trailing punctuation. Currently, it puts the trailing
229: punctuation into a trailing MDOC_TEXT element inside its own scope.
230: That element should rather be outside its scope, such that the
231: punctuation does not get underlines. This is not trivial to
232: implement because .%T then needs some features of in_line_eoln() -
233: slurp all arguments into one single text element - and one feature
234: of in_line() - put trailing punctuation out of scope.
235: Found in mount_nfs(8) and exports(5), search for "Appendix".
236:
1.147 schwarze 237: - Trailing punctuation after .%T triggers EOS spacing, at least
238: outside .Rs (eek!). Simply setting ARGSFL_DELIM for .%T is not
239: the right solution, it sends mandoc into an endless loop.
240: reported by Nicolas Joly Sat, 17 Nov 2012 11:49:54 +0100
241:
1.48 schwarze 242: - in enclosures, mandoc sometimes fancies a bogus end of sentence
243: reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059
1.149 schwarze 244:
245: - formatting /usr/local/man/man1/latex2man.1 with groff and mandoc
246: reveals lots of bugs both in groff and mandoc...
247: reported by bentley@ Wed, 22 May 2013 23:49:30 -0600
1.171 schwarze 248:
249: --- PDF issues ---------------------------------------------------------
250:
251: - PDF output doesn't use a monospaced font for .Bd -literal
252: Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf".
253: Search the text "Routing tables".
254: Also check what PostScript mode does when fixing this.
255: reported by juanfra@ Wed, 04 Jun 2014 21:44:58 +0200
1.173 ! schwarze 256:
! 257: --- HTML issues --------------------------------------------------------
! 258:
! 259: - check https://github.com/trentm/mdocml
1.35 kristaps 260:
1.1 kristaps 261: ************************************************************************
1.104 kristaps 262: * formatting issues: gratuitous differences
1.1 kristaps 263: ************************************************************************
1.65 kristaps 264:
265: - .Rv (and probably .Ex) print different text if an `Nm' has been named
266: or not (run a manual without `Nm blah' to see this). I'm not sure
267: that this exists in the wild, but it's still an error.
1.38 schwarze 268:
269: - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
270: is just "o\bo".
271: see for example OpenBSD ksh(1)
1.103 schwarze 272:
273: - .Pp between two .It in .Bl -column should produce one,
274: not two blank lines, see e.g. login.conf(5).
275: reported by jmc@ Sun, 17 Apr 2011 14:04:58 +0059
1.129 schwarze 276: reported again by sthen@ Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
1.39 schwarze 277:
1.83 schwarze 278: - If the *first* line after .It is .Pp, break the line right after
279: the tag, do not pad with space characters before breaking.
280: See the description of the a, c, and i commands in sed(1).
281:
282: - If the first line after .It is .D1, do not assert a blank line
283: in between, see for example tmux(1).
284: reported by nicm@ 13 Jan 2011 00:18:57 +0000
1.147 schwarze 285:
286: - Trailing punctuation after .It should trigger EOS spacing.
287: reported by Nicolas Joly Sat, 17 Nov 2012 11:49:54 +0100
288: Probably, this should be fixed somewhere in termp_it_pre(), not sure.
1.83 schwarze 289:
1.39 schwarze 290: - .Nx 1.0a
291: should be "NetBSD 1.0A", not "NetBSD 1.0a",
292: see OpenBSD ccdconfig(8).
1.83 schwarze 293:
1.39 schwarze 294: - In .Bl -tag, if a tag exceeds the right margin and must be continued
295: on the next line, it must be indented by -width, not width+1;
296: see "rule block|pass" in OpenBSD ifconfig(8).
1.56 schwarze 297:
1.83 schwarze 298: - When the -width string contains macros, the macros must be rendered
299: before measuring the width, for example
300: .Bl -tag -width ".Dv message"
301: in magic(5), located in src/usr.bin/file, is the same
302: as -width 7n, not -width 11n.
1.129 schwarze 303: The same applies to .Bl -column column widths;
304: reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
1.157 schwarze 305: reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200
306: An easy partial fix would be to just skip the first word if it starts
307: with a dot, including any following white space, when measuring.
1.83 schwarze 308:
1.56 schwarze 309: - The \& zero-width character counts as output.
310: That is, when it is alone on a line between two .Pp,
311: we want three blank lines, not two as in mandoc.
1.83 schwarze 312:
1.64 schwarze 313: - Header lines of excessive length:
314: Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
315: and document it in mdoc(7) and man(7) COMPATIBILITY
316: found while talking to Chris Bennett
1.83 schwarze 317:
318: - trailing whitespace must be ignored even when followed by a font escape,
319: see for example
320: makes
321: \fBdig \fR
322: operate in batch mode
323: in dig(1).
1.166 schwarze 324:
325: ************************************************************************
326: * warning issues
327: ************************************************************************
328:
329: - check that MANDOCERR_BADTAB is thrown in the right cases,
330: i.e. when finding a literal tab character in fill mode,
331: and possibly change the wording of the warning message
332: to refer to fill mode, not literal mode
333: See the mail from Werner LEMBERG on the groff list,
334: Fri, 14 Feb 2014 18:54:42 +0100 (CET)
1.1 kristaps 335:
1.9 kristaps 336: ************************************************************************
337: * performance issues
338: ************************************************************************
339:
340: Several areas can be cleaned up to make mandoc even faster. These are
341:
342: - improve hashing mechanism for macros (quite important: performance)
343:
344: - improve hashing mechanism for characters (not as important)
1.23 kristaps 345:
1.37 kristaps 346: - the PDF file is HUGE: this can be reduced by using relative offsets
1.115 kristaps 347:
348: - instead of re-initialising the roff predefined-strings set before each
349: parse, create a read-only version the first time and copy it
1.37 kristaps 350:
1.23 kristaps 351: ************************************************************************
352: * structural issues
353: ************************************************************************
1.122 schwarze 354:
355: - We use the input line number at several places to distinguish
356: same-line from different-line input. That plainly doesn't work
357: with user-defined macros, leading to random breakage.
1.67 schwarze 358:
359: - Find better ways to prevent endless loops
360: in roff(7) macro and string expansion.
1.91 schwarze 361:
1.96 schwarze 362: - Finish cleanup of date handling.
1.91 schwarze 363: Decide which formats should be recognized where.
364: Update both mdoc(7) and man(7) documentation.
365: Triggered by Tim van der Molen Tue, 22 Feb 2011 20:30:45 +0100
1.170 schwarze 366:
367: - Consider creating some views that will make the database more
368: readable from the sqlite3 shell. Consider using them to
369: abstract from the database structure, too.
370: suggested by espie@ Sat, 19 Apr 2014 14:52:57 +0200
371:
CVSweb