1 ************************************************************************
2 * Official mandoc TODO.
3 * $Id: TODO,v 1.65 2010/11/29 13:04:31 kristaps Exp $
4 ************************************************************************
6 ************************************************************************
8 ************************************************************************
10 - the roff parser doesn't tolerate additional characters between
11 a macro and the \} terminating a conditional block, e.g.
14 reported by ulrich spoerlein Tue, 19 Oct 2010 20:39:50 +0200
16 - .BI "string string " word punct in gettext(3)
17 add bogus line breaks (rep by naddy@)
18 committed; currently working on IP and TP?
19 and what about B and I?
21 ************************************************************************
23 ************************************************************************
25 - explicit blocks with missing end macro should be implicitely closed
26 at the end of the enclosing block, e.g. .Bl It (El) Sh
27 reminded by stsp@ in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200
29 - fix bad block nesting involving multiple identical explicit blocks
30 see the OpenBSD mdoc_macro.c 1.47 commit message
32 - .Bl -column .Xo support is missing
34 restore .Xr and .Dv to
35 lib/libc/compat-43/sigvec.3
37 lib/libc/sys/sigaction.2
39 - edge case: decide how to deal with blk_full bad nesting, e.g.
40 .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
41 from jmc@ Wed, 14 Jul 2010 18:10:32 +0100
43 - auto-Bk in the SYNOPSIS
44 patch from kristaps@ Fri, 16 Jul 2010 14:51:24 +0200
45 to be revisited after OpenBSD 4.8 tree unlock
48 in plain text, identical to \e
49 as a macro argument, identical to \ i.e. escaping the next character
50 We do not have macro definitions yet; if we implement them,
51 \\ must behave in a macro def like in a macro argument,
52 and when using the macro, it must expand yet again.
54 - implement basic non-parametric .de to support e.g. sox(1)
69 reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
71 - implement parametric .de to support e.g.
72 /usr/xenocara/lib/libXxf86vm/manXF86VM.man
74 .ie t \fB\^\\$1\^\fR\\$2
75 .el \fI\^\\$1\^\fP\\$2
79 - clean up escape sequence handling, creating three classes:
80 (1) fully implemented, or parsed and ignored without loss of content
81 (2) unimplemented, potentially causing loss of content
82 or serious mangling of formatting (e.g. \n) -> ERROR
83 see textproc/mgdiff(1) for nice examples
84 (3) undefined, just output the character -> perhaps WARNING
86 - port OpenBSD tbl integration bsd.lv, probably cleaning it up
88 - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
89 These are a weird mixture of man(7) and custom autogenerated low-level
90 roff stuff. Figure out to what extent we can cope.
91 noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
92 reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
94 - implement blank `Bl -column', such as
99 - explicitly disallow nested `Bl -column', which would clobber internal
100 flags defined for struct mdoc_macro
102 - inside `.Bl -column' phrases, punctuation is handled like normal
103 text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
105 - inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
106 is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
107 but should give "ab ."
109 - set a meaningful default if no `Bl' list type is assigned
111 - have a blank `It' head for `Bl -tag' not puke
113 - prohibit `Nm' from having non-text HEAD children
114 (e.g., NetBSD mDNSShared/dns-sd.1)
115 (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
117 - allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments
118 noted by Alex Kozlov 08/06/10 23:05
120 - Have `Sh', `It', `Ss' and others complain if `Pp' is invoked prior to
121 close (in the post validation) or prior to open (pre). This noted by
122 jmc@ a thousand years ago.
124 - xloadimage(1) wants .ti (temporary indent), rep by naddy@
126 - bashbug(1) complains "line scope broken" after
129 should either just work or be a warning
132 ************************************************************************
133 * formatting issues: ugly output
134 ************************************************************************
136 - perl(1) SYNOPSIS looks bad; reported by deraadt@
137 1) man(7) seems to need SYNOPSIS .Nm blocks, too
140 .It Em Authentication<tab>Key Length
141 ought to render "Key Length" with emphasis, too,
142 see OpenBSD iked.conf(5).
144 - empty phrases in .Bl column produce too few blanks
145 try e.g. .Bl -column It Ta Ta
146 reported by millert Fri, 02 Apr 2010 16:13:46 -0400
148 - in enclosures, mandoc sometimes fancies a bogus end of sentence
149 reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059
151 ************************************************************************
152 * formatting issues: gratuitious differences
153 ************************************************************************
155 - .Rv (and probably .Ex) print different text if an `Nm' has been named
156 or not (run a manual without `Nm blah' to see this). I'm not sure
157 that this exists in the wild, but it's still an error.
159 - .%T should be quoted, not underlined, when .%J is also present,
160 to better distinguish the contents of .%T and .%J,
161 see for example OpenBSD cat(1)
163 - In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
165 see for example OpenBSD ksh(1)
167 - The characters "|" and "\*(Ba" should never be bold,
168 not even in the middle of a word, e.g. ".Cm b\*(Bac" in
169 "mknod [-m mode] name b|c major minor"
172 - A bogus .Pp between two .It must not produce a double blank line,
173 see between -R and -r in OpenBSD rm(1), before "update" in mount(8),
174 or in DIAGNOSTICS in init(8).
176 - .Bd -literal and .Bd -unfilled are *not* identical.
177 In -literal, tabs are 8 spaces.
178 In -unfilled, tabs are 5 spaces, just like in -filled and -ragged.
179 See the CCDF_* display in OpenBSD ccdconfig(8).
182 should be "NetBSD 1.0A", not "NetBSD 1.0a",
183 see OpenBSD ccdconfig(8).
185 - In .Bl -tag, if a tag exceeds the right margin and must be continued
186 on the next line, it must be indented by -width, not width+1;
187 see "rule block|pass" in OpenBSD ifconfig(8).
189 - The \& zero-width character counts as output.
190 That is, when it is alone on a line between two .Pp,
191 we want three blank lines, not two as in mandoc.
193 - When .Fn arguments exceed one output line, all but the first
194 should be indented, see e.g. rpc(3);
195 reported by jmc@ on discuss@ Fri, 29 Oct 2010 13:48:33 +0100
197 - It seems that .TP does not want TWOSPACE after the tag;
198 see bashbug(1); reported by naddy@
200 - Header lines of excessive length:
201 Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
202 and document it in mdoc(7) and man(7) COMPATIBILITY
203 found while talking to Chris Bennett
205 ************************************************************************
207 ************************************************************************
209 Several areas can be cleaned up to make mandoc even faster. These are
211 - improve hashing mechanism for macros (quite important: performance)
213 - improve hashing mechanism for characters (not as important)
215 - the PDF file is HUGE: this can be reduced by using relative offsets
217 ************************************************************************
219 ************************************************************************