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