Add support for 1/2, 1/4, and 3/4 (needed by eqn).

[mandoc.git] / TODO

diff --git a/TODO b/TODO
index 3f47d14854707fc61a12a45e46df01e6aab1de07..896d39b5487d3b533b40b87825f39f7ea5b7db11 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,40 +1,39 @@
 ************************************************************************
 * Official mandoc TODO.
 ************************************************************************
 * Official mandoc TODO.

-* $Id: TODO,v 1.85 2011/01/25 15:17:18 kristaps Exp $
+* $Id: TODO,v 1.119 2011/07/09 10:26:57 kristaps Exp $

 ************************************************************************
 
 ************************************************************************
 * parser bugs
 ************************************************************************
 
 ************************************************************************
 
 ************************************************************************
 * parser bugs
 ************************************************************************
 

+- ".\}" 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
+

 - .TP before .SH is still FATAL in man(7)
   reported by brad@  Sat, 15 Jan 2011 15:54:54 -0500
 
 - .TP before .SH is still FATAL in man(7)
   reported by brad@  Sat, 15 Jan 2011 15:54:54 -0500
 

-- The mdoc(7) parser should handle `\.' as punctuation:
-    .Ql .if ${VAR} op something \.
-  should produce
-    `.if ${VAR} op something'.
-  not
-    `.if ${VAR} op something .'
-  as seen in make(1).
-  To escape the dot, one would use `\&.'.
-
-- 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
-

 ************************************************************************
 * formatter bugs
 ************************************************************************
 
 ************************************************************************
 * formatter bugs
 ************************************************************************
 

+- tbl(7): Horizontal and vertical lines are formatted badly:
+  With the box option, there is too much white space at the end of cells.
+  Horizontal lines from "=" lines are a bit too long.
+  yuri dot pankov at gmail dot com  Thu, 14 Apr 2011 05:45:26 +0400
+

 ************************************************************************
 * missing features
 ************************************************************************
 
 --- missing roff features ----------------------------------------------
 
 ************************************************************************
 * missing features
 ************************************************************************
 
 --- 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)
 - .ad (adjust margins)
   .ad l -- adjust left margin only (flush left)
   .ad r -- adjust right margin only (flush right)


@@ -95,6 +94,16 @@
 - explicitly disallow nested `Bl -column', which would clobber internal
   flags defined for struct mdoc_macro
 
 - explicitly disallow nested `Bl -column', which would clobber internal
   flags defined for struct mdoc_macro
 

+- In .Bl -column .It, the end of the line probably has to be regarded
+  as an implicit .Ta, if there could be one, see the following mildly
+  ugly code from login.conf(5):
+    .Bl -column minpasswordlen program xetcxmotd
+    .It path Ta path Ta value of Dv _PATH_DEFPATH
+    .br
+    Default search path.
+  reported by Michal Mazurek <akfaew at jasminek dot net>
+  via jmc@ Thu, 7 Apr 2011 16:00:53 +0059
+

 - inside `.Bl -column' phrases, punctuation is handled like normal
   text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
 
 - inside `.Bl -column' phrases, punctuation is handled like normal
   text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
 


@@ -110,23 +119,31 @@
   (e.g., NetBSD mDNSShared/dns-sd.1)
   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
 
   (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

 
 

-- bashbug(1) complains "line scope broken" after
-  .SM
-  .B something
-  should either just work or be a warning
-  reported by naddy@
+--- 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
 
 
 - 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)
   reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
   *** sox(1) still doesn't work, tbl(1) errors need investigation
 
 --- missing tbl features -----------------------------------------------
 
 - implement basic non-parametric .de to support e.g. sox(1)
   reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
   *** sox(1) still doesn't work, tbl(1) errors need investigation
 

+- allow standalone `.' to be interpreted as an end-of-layout
+  delimiter instead of being thrown away as a no-op roff line
+  reported by Yuri Pankov, Wed 18 May 2011 11:34:59 CEST
+

 --- missing misc features ----------------------------------------------
 
 - clean up escape sequence handling, creating three classes:
 --- missing misc features ----------------------------------------------
 
 - clean up escape sequence handling, creating three classes:


@@ -160,6 +177,9 @@
 * formatting issues: ugly output
 ************************************************************************
 
 * formatting issues: ugly output
 ************************************************************************
 

+- a column list with blank `Ta' cells triggers a spurrious
+  start-with-whitespace printing of a newline
+

 - double quotes inside double quotes are escaped by doubling them
   implement this in mdoc(7), too
   so far, we only have it in roff(7) and man(7)
 - double quotes inside double quotes are escaped by doubling them
   implement this in mdoc(7), too
   so far, we only have it in roff(7) and man(7)


@@ -190,7 +210,7 @@
   reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
 
 ************************************************************************
   reminded by jmc@  Thu, 23 Sep 2010 18:13:39 +0059
 
 ************************************************************************

-* formatting issues: gratuitious differences
+* formatting issues: gratuitous differences

 ************************************************************************
 
 - .Rv (and probably .Ex) print different text if an `Nm' has been named
 ************************************************************************
 
 - .Rv (and probably .Ex) print different text if an `Nm' has been named


@@ -213,6 +233,10 @@
   Also have `It' complain if `Pp' is invoked at certain times (not
   -compact?).
 
   Also have `It' complain if `Pp' is invoked at certain times (not
   -compact?).
 

+- .Pp between two .It in .Bl -column should produce one,
+  not two blank lines, see e.g. login.conf(5).
+  reported by jmc@  Sun, 17 Apr 2011 14:04:58 +0059
+

 - If the *first* line after .It is .Pp, break the line right after
   the tag, do not pad with space characters before breaking.
   See the description of the a, c, and i commands in sed(1).
 - If the *first* line after .It is .Pp, break the line right after
   the tag, do not pad with space characters before breaking.
   See the description of the a, c, and i commands in sed(1).


@@ -225,9 +249,6 @@
   should be "NetBSD 1.0A", not "NetBSD 1.0a",
   see OpenBSD ccdconfig(8).
 
   should be "NetBSD 1.0A", not "NetBSD 1.0a",
   see OpenBSD ccdconfig(8).
 

-- The space character joining .Dx .Fx .Nx .Ox (are these all?) to its
-  argument is non-breaking.  See the cdio(1) HISTORY and many others.
-

 - In .Bl -tag, if a tag exceeds the right margin and must be continued
   on the next line, it must be indented by -width, not width+1;
   see "rule block|pass" in OpenBSD ifconfig(8).
 - In .Bl -tag, if a tag exceeds the right margin and must be continued
   on the next line, it must be indented by -width, not width+1;
   see "rule block|pass" in OpenBSD ifconfig(8).


@@ -246,10 +267,6 @@
   should be indented, see e.g. rpc(3);
   reported by jmc@ on discuss@  Fri, 29 Oct 2010 13:48:33 +0100
 
   should be indented, see e.g. rpc(3);
   reported by jmc@ on discuss@  Fri, 29 Oct 2010 13:48:33 +0100
 

-- .Ns should only be effective when called by another macro,
-  not as a stand-alone macro at the beginning of a line;
-  see for example the awk(1) SYNOPSIS.
-

 - .Ns should work when called at the end of an input line, see
   the following code in vi(1):
     .It Xo
 - .Ns should work when called at the end of an input line, see
   the following code in vi(1):
     .It Xo


@@ -272,13 +289,33 @@
   see for example named-checkconf(8).
 
 - In man(7), the sequence
   see for example named-checkconf(8).
 
 - In man(7), the sequence

+    .SH HEADER
+    <blank line>
+    .PP

     regular text
     regular text

-    .RS
-    .IP
-  should have a blank line between the text and the beginning of the
-  indented paragraph, see for example sudo(1).
+  should not produce any blank lines between the header and the text,
+  see for example rsync(1).
+  Reported by naddy@  Mon, 28 Mar 2011 20:45:42 +0200

 
 

-- At least sometimes, .sp is ignored right after .SH; see named.conf(5).
+- In man(7), the sequence
+    regular text
+    .IP
+    .IP "tag"
+    indented text
+  should produce one, not four blank lines between the regular text
+  and the tag, see for example rsync(1).
+  Likewise,
+    regular text
+    .IP
+    indented text
+  should produce one, not two blank lines in between, and
+    regular text
+    .IP
+    .RS
+    .IP tag
+    indented text
+  should produce one, not three blank lines.
+  Reported by naddy@  Mon, 28 Mar 2011 20:45:42 +0200

 
 - trailing whitespace must be ignored even when followed by a font escape,
   see for example 
 
 - trailing whitespace must be ignored even when followed by a font escape,
   see for example 


@@ -303,10 +340,17 @@ Several areas can be cleaned up to make mandoc even faster.  These are
 
 - the PDF file is HUGE: this can be reduced by using relative offsets
 
 
 - 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
 ************************************************************************
 
 - Find better ways to prevent endless loops
   in roff(7) macro and string expansion.
 ************************************************************************
 * structural issues
 ************************************************************************
 
 - Find better ways to prevent endless loops
   in roff(7) macro and string expansion.

-  
+ 
+- Finish cleanup of date handling.
+  Decide which formats should be recognized where.
+  Update both mdoc(7) and man(7) documentation.
+  Triggered by  Tim van der Molen  Tue, 22 Feb 2011 20:30:45 +0100