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