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