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