************************************************************************
* Official mandoc TODO.
-* $Id: TODO,v 1.105 2011/05/18 09:45:21 kristaps Exp $
+* $Id: TODO,v 1.124 2011/11/13 10:02:54 schwarze Exp $
************************************************************************
************************************************************************
* parser bugs
************************************************************************
-- .TP before .SH is still FATAL in man(7)
- reported by brad@ Sat, 15 Jan 2011 15:54:54 -0500
+- ".\}" on its own line gets translated to bare ".\&"
+ which forces pset() into man(7)
+ and then triggers an unknown macro error
+ reported by naddy@ Sun, 3 Jul 2011 21:52:24 +0200
-- the roff parser doesn't tolerate additional characters between
- a macro and the \} terminating a conditional block, e.g.
- .if n \{
- .br \}
- reported by ulrich spoerlein Tue, 19 Oct 2010 20:39:50 +0200
+- .It is parsed in general, except in .Bl -diag
+ deraadt@ Mon, 07 Nov 2011 11:10:52 -0700
************************************************************************
* formatter bugs
--- missing roff features ----------------------------------------------
+- .if n \{
+ .br\}
+ should cause an extra space to be raised.
+
- .ad (adjust margins)
.ad l -- adjust left margin only (flush left)
.ad r -- adjust right margin only (flush right)
- .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
reported by brad@ Sat, 15 Jan 2011 15:50:51 -0500
-- pod2man expects `tr' to be implemented for \*(-- to work
-
- \c (interrupted text) occurs in chat(8)
-- \f(CW (constant width font) occurs in rsyncd.conf(5).
- I think we should treat unknown/unavailable fonts as \fR
- such that switching back with \fP works correctly -
- and doesn't revert the _previous_ \fP.
-
--- missing mdoc features ----------------------------------------------
- fix bad block nesting involving multiple identical explicit blocks
(e.g., NetBSD mDNSShared/dns-sd.1)
(mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
---- missing man features -----------------------------------------------
+- When there is free text in the SYNOPSIS and that free text contains
+ the .Nm macro, groff somehow understands to treat the .Nm as an in-line
+ macro, while mandoc treats it as a block macro and breaks the line.
+ No idea how the logic for distinguishing in-line and block instances
+ should be, needs investigation.
+ uqs@ Thu, 2 Jun 2011 11:03:51 +0200
+ uqs@ Thu, 2 Jun 2011 11:33:35 +0200
-- .RS/.RE can be nested, see e.g. the x11/fluxbox manuals
- noticed by dcoppa@ Wed, Apr 13, 2011 at 04:58:14PM +0200:
+--- missing man features -----------------------------------------------
- groff an-ext.tmac macros (.UR, .UE) occur in xine(5)
reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500
+- -T[x]html doesn't stipulate non-collapsing spaces in literal mode
+
--- missing tbl features -----------------------------------------------
- implement basic non-parametric .de to support e.g. sox(1)
.It Em Authentication<tab>Key Length
ought to render "Key Length" with emphasis, too,
see OpenBSD iked.conf(5).
+ reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200
- empty phrases in .Bl column produce too few blanks
try e.g. .Bl -column It Ta Ta
- When .Fn arguments exceed one output line, all but the first
should be indented, see e.g. rpc(3);
reported by jmc@ on discuss@ Fri, 29 Oct 2010 13:48:33 +0100
+ reported again by Nicolas Joly via wiz@ Sun, 18 Sep 2011 18:24:40 +0200
+ Also, we don't want to break the line within the argument of:
+ .Fa "chtype tl"
- .Ns should work when called at the end of an input line, see
the following code in vi(1):
should not produce two blank lines before the .SH,
see for example named-checkconf(8).
-- In man(7), the sequence
- regular text
- .RS
- .IP
- should have a blank line between the text and the beginning of the
- indented paragraph, see for example sudo(1).
-
- In man(7), the sequence
.SH HEADER
<blank line>
see for example rsync(1).
Reported by naddy@ Mon, 28 Mar 2011 20:45:42 +0200
-- In man(7), the sequence
- regular text
- .PP
- .RS
- indented text
- should produce one blank line between the regular and indented texts,
- see for example rsync(1), and
- .RE
- <blank line>
- .PP
- .RS
- should produce two,not one blank lines.
- Reported by naddy@ Mon, 28 Mar 2011 20:45:42 +0200
-
- In man(7), the sequence
regular text
.IP
should produce one, not three blank lines.
Reported by naddy@ Mon, 28 Mar 2011 20:45:42 +0200
-- At least sometimes, .sp is ignored right after .SH; see named.conf(5).
-
- trailing whitespace must be ignored even when followed by a font escape,
see for example
makes
- the PDF file is HUGE: this can be reduced by using relative offsets
+- instead of re-initialising the roff predefined-strings set before each
+ parse, create a read-only version the first time and copy it
+
************************************************************************
* structural issues
************************************************************************
+- We use the input line number at several places to distinguish
+ same-line from different-line input. That plainly doesn't work
+ with user-defined macros, leading to random breakage.
+
- Find better ways to prevent endless loops
in roff(7) macro and string expansion.