************************************************************************
* Official mandoc TODO.
-* $Id: TODO,v 1.185 2014/10/16 01:11:20 schwarze Exp $
+* $Id: TODO,v 1.196 2014/12/17 20:31:19 schwarze Exp $
************************************************************************
Many issues are annotated for difficulty as follows:
- .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
reported by brad@ Sat, 15 Jan 2011 15:50:51 -0500
also Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100
- loc ** exist *** algo ** size ** imp **
+ also posix2time(3) Carsten Kunze Mon, 1 Dec 2014 13:03:10 +0100
+ loc ** exist *** algo ** size ** imp ***
- .ti (temporary indent)
found by naddy@ in xloadimage(1)
found by jca@ in ratpoison(1) Sun, 30 Jun 2013 12:01:09 +0200
loc * exist ** algo ** size ** imp **
-- \c (interrupted text) should prevent the line break
- even inside .Bd literal; that occurs in chat(8)
- also found in cclive(1) - DocBook output
- loc ** exist *** algo ** size * imp *
-
- \h horizontal move
- found in cclive(1) DocBook output
- Anthony J. Bentley on discuss@ Sat, 21 Sep 2013 22:29:34 -0600
+ found in cclive(1) and nasm(1) asciidoc/DocBook output
+ bentley@ on discuss@ Sat, 21 Sep 2013 22:29:34 -0600
+ naddy@ Thu, 4 Dec 2014 16:26:41 +0100
loc ** exist ** algo ** size * imp ** (parser reorg helps a lot)
- \n+ and \n- numerical register increment and decrement
from jmc@ Wed, 14 Jul 2010 18:10:32 +0100
loc * exist *** algo *** size ** imp **
-- \\ is now implemented correctly
- * when defining strings and macros using .ds and .de
- * when parsing roff(7) and man(7) macro arguments
- It does not yet work in mdoc(7) macro arguments
- because libmdoc does not yet use mandoc_getarg().
- Also check what happens in plain text, it must be identical to \e.
-
- .Bd -centered implies -filled, not -unfilled, which is not
easy to implement; it requires code similar to .ce, which
we don't have either.
is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
but should give "ab ."
-- set a meaningful default if no `Bl' list type is assigned
- loc * exist * algo * size * imp ** (already done?)
-
-- have a blank `It' head for `Bl -tag' not puke
- loc * exist * algo * size * imp ** (already done?)
-
- check whether it is correct that `D1' uses INDENT+1;
does it need its own constant?
loc * exist ** algo ** size * imp **
--- compatibility checks -----------------------------------------------
+- write a configure check for [[:<:]] support and provide some
+ fallback for whatis(1) when it doesn't work;
+ Svyatoslav Mishyn Wed, 17 Dec 2014 11:07:10 +0200
+
- is .Bk implemented correctly in modern groff?
sobrado@ Tue, 19 Apr 2011 22:12:55 +0200
- check compatibility with the man(7) formatter
https://raw.githubusercontent.com/rofl0r/hardcore-utils/master/man.c
+- check compatibility with
+ http://ikiwiki.info/plugins/contrib/mandoc/
+ https://github.com/schmonz/ikiwiki/compare/mandoc
+ Amitai Schlair Mon, 19 May 2014 14:05:53 -0400
+
************************************************************************
* formatting issues: ugly output
************************************************************************
-- a column list with blank `Ta' cells triggers a spurrious
+- revisit empty in-line macros
+ look at the difference between "Em x Em ." and "Sq x Em ."
+ Carsten Kunze Fri, 12 Dec 2014 00:15:41 +0100
+ loc *** exist *** algo *** size * imp **
+
+- a column list with blank `Ta' cells triggers a spurious
start-with-whitespace printing of a newline
+- In .Bl -column, .It a<tab>"b<tab>c"
+ shows the quotes in groff, but not in mandoc
+ loc * exist *** algo ** size * imp **
+
- In .Bl -column,
.It Em Authentication<tab>Key Length
ought to render "Key Length" with emphasis, too,
Search the text "Routing tables".
Also check what PostScript mode does when fixing this.
reported by juanfra@ Wed, 04 Jun 2014 21:44:58 +0200
- loc * exist ** algo ? size * imp **
+ instructions from juanfra@ Wed, 11 Jun 2014 02:21:01 +0200
+ add a new <</Type /Font>> block to the PDF files with /BaseFont /Courier
+ and change the /Name from /F0 to the new font (/F5 (?)).
+ loc * exist ** algo ** size * imp **
--- HTML issues --------------------------------------------------------
see also matthew@ Fri, 18 Jul 2014 19:25:12 -0700
loc * exist * algo ** size * imp ***
+- jsg on icb, Nov 3, 2014:
+ try to guess Xr in man(7) for hyperlinking
+
- The tables used to render the three-part page headers actually force
the width of the <body> to the max-width given for <html>.
Not yet sure how to fix that...
* formatting issues: gratuitous differences
************************************************************************
-- .Rv (and probably .Ex) print different text if an `Nm' has been named
- or not (run a manual without `Nm blah' to see this). I'm not sure
- that this exists in the wild, but it's still an error.
- loc * exist * algo * size * imp * (already done?)
-
-- In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
- is just "o\bo". The problem is to not break ps/pdf when fixing.
- see for example OpenBSD ksh(1)
- loc ** exist ** algo ** size * imp **
+- .Fn reopens a new scope after punctuation in mandoc,
+ but closes its scope for good in groff.
+ Do we want to change mandoc or groff?
+ Steffen Nurpmeso Sat, 08 Nov 2014 13:34:59 +0100
+ loc * exist ** algo ** size * imp **
- In .Bl -enum -width 0n, groff continues one the same line after
the number, mandoc breaks the line.
Fri, 14 Feb 2014 18:54:42 +0100 (CET)
loc * exist ** algo ** size * imp **
+- warn about attempts to call non-callable macros
+ Steffen Nurpmeso Tue, 11 Nov 2014 22:55:16 +0100
+ Note that formatting is inconsistent in groff.
+ .Fn Po prints "Po()", .Ar Sh prints "file ..." and no "Sh".
+ Relatively hard because the relevant code is scattered
+ all over mdoc_macro.c and all subtly different.
+ loc ** exist ** algo ** size ** imp **
+
- warn about "new sentence, new line"
loc ** exist ** algo *** size * imp **
* structural issues
************************************************************************
+- Use libz directly instead of forking gunzip(1).
+ Suggested by bapt at FreeBSD among others.
+
- 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.
Update both mdoc(7) and man(7) documentation.
Triggered by Tim van der Molen Tue, 22 Feb 2011 20:30:45 +0100
+- struct mparse refactoring
+ Steffen Nurpmeso Thu, 04 Sep 2014 12:50:00 +0200
+
- Consider creating some views that will make the database more
readable from the sqlite3 shell. Consider using them to
abstract from the database structure, too.
- Have Mac OSX systems automatically disable -static compilation of the
CGI: -static isn't supported.
+************************************************************************
+* to improve in the groff_mdoc(7) macros
+************************************************************************
+
+- use uname(1) to set doc-default-operating-system at install time
+ tobimensch Mon, 1 Dec 2014 00:25:07 +0100
git.ckatri.com / mandoc.git / blobdiff