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