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