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