ASCII characters that are special to roff

[mandoc.git] / TODO

diff --git a/TODO b/TODO
index b599863e11cefc5071ccb03a070159b33cb91e8c..ac587990e95d743cfa6bf10d74df62e1382d2df0 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,6 +1,6 @@
 ************************************************************************
 * Official mandoc TODO.
 ************************************************************************
 * Official mandoc TODO.

-* $Id: TODO,v 1.207 2015/04/18 16:05:45 schwarze Exp $
+* $Id: TODO,v 1.236 2017/04/27 17:08:04 schwarze Exp $

 ************************************************************************
 
 Many issues are annotated for difficulty as follows:
 ************************************************************************
 
 Many issues are annotated for difficulty as follows:


@@ -32,15 +32,6 @@ Many issues are annotated for difficulty as follows:
 Obviously, as the issues have not been solved yet, these annotations
 are mere guesses, and some may be wrong.
 
 Obviously, as the issues have not been solved yet, these annotations
 are mere guesses, and some may be wrong.
 

-************************************************************************
-* crashes
-************************************************************************
-
-- The abort() in bufcat(), html.c, can be triggered via buffmt_includes()
-  by running -Thtml -Oincludes on a file containing a long .In argument.
-  Fixing this will probably require reworking the whole bufcat() concept.
-  loc **  exist *  algo *  size **  imp **
-

 ************************************************************************
 * missing features
 ************************************************************************
 ************************************************************************
 * missing features
 ************************************************************************


@@ -202,28 +193,54 @@ are mere guesses, and some may be wrong.
   uqs@  Thu, 2 Jun 2011 11:33:35 +0200
   loc *  exist **  algo ***  size *  imp **
 
   uqs@  Thu, 2 Jun 2011 11:33:35 +0200
   loc *  exist **  algo ***  size *  imp **
 

---- missing man features -----------------------------------------------
+--- missing tbl features -----------------------------------------------

 
 

-- -T[x]html doesn't stipulate non-collapsing spaces in literal mode
+- horizontal lines in the layout still consume data cells
+  and can be mixed with actual data on the same table line
+  synaptics(4) found by tedu@  Mon, 17 Aug 2015 21:17:42 -0400
+  loc **  exist **  algo **  size **  imp ***

 
 

---- missing tbl features -----------------------------------------------
+- break long text into lines inside cells
+  net/lftp(1) from jirib via bentley@ Sep 13, 2016
+
+- layout l1 for a column of max text width 3 reduces the following
+  inter-column spacing for groff, but not for mandoc
+  net/lftp(1) from jirib via bentley@ Sep 13, 2016
+
+- the "w" layout option is ignored
+  synaptics(4) found by tedu@  Mon, 17 Aug 2015 21:17:42 -0400
+  loc *  exist *  algo *  size *  imp **
+
+- the "s" layout column specifier is used for placement of data
+  into columns, but ignored during column width calculations
+  synaptics(4) found by tedu@  Mon, 17 Aug 2015 21:17:42 -0400
+  loc *  exist **  algo ***  size *  imp **
+
+- support mdoc(7) and man(7) macros inside tbl(7) code;
+  probably requires the parser reorg and letting tbl(7)
+  use roff_node such that macro sets can mix;
+  informed by bapt@ that FreeBSD needs this: 3 Jan 2015 23:32:23 +0100
+  loc ***  exist **  algo ***  size **  imp ***

 
 - look at the POSIX manuals in the books/man-pages-posix port,
   they use some unsupported tbl(7) features.
   loc *  exist **  algo **  size **  imp ***
 
 
 - look at the POSIX manuals in the books/man-pages-posix port,
   they use some unsupported tbl(7) features.
   loc *  exist **  algo **  size **  imp ***
 

+- look what Joerg Schilling manual pages use
+  Thu, 19 Mar 2015 18:31:48 +0100
+

 - use Unicode U+2500 to U+256C for table borders
   in tbl(7) -Tutf-8 output
   suggested by bentley@  Tue, 14 Oct 2014 04:10:55 -0600
   loc *  exist **  algo *  size *  imp **
 
 - use Unicode U+2500 to U+256C for table borders
   in tbl(7) -Tutf-8 output
   suggested by bentley@  Tue, 14 Oct 2014 04:10:55 -0600
   loc *  exist **  algo *  size *  imp **
 

-- 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
-  loc **  exist **  algo **  size *  imp **
-

 --- missing eqn features -----------------------------------------------
 
 --- missing eqn features -----------------------------------------------
 

+- In a matrix, break the output line after each matrix line.
+  Found in the discussion at CDBUG 2015.
+  Suggested by Avi Weinstock.
+  loc *  exist *  algo *  size *  imp **
+

 - The "size" keyword is parsed, but ignored by the formatter.
   loc *  exist *  algo *  size *  imp *
 
 - The "size" keyword is parsed, but ignored by the formatter.
   loc *  exist *  algo *  size *  imp *
 


@@ -241,21 +258,8 @@ are mere guesses, and some may be wrong.
   Werner LEMBERG on groff at gnu dot org  Sun, 10 Nov 2013 12:47:46
   loc **  exist **  algo *  size *  imp *
 
   Werner LEMBERG on groff at gnu dot org  Sun, 10 Nov 2013 12:47:46
   loc **  exist **  algo *  size *  imp *
 

-- When makewhatis(8) encounters a FATAL parse error,
-  it silently treats the file as formatted, which makes no sense
-  at all for paths like man1/foo.1 - and which also contradicts
-  what the manual says at the end of the description.
-  The end result will be ENOENT for file names returned
-  by mansearch() in manpage.file.
-  loc *  exist *  algo *  size *  imp **
-
-- makewhatis(8) for preformatted pages:
-  parse the section number from the header line
-  and compare to the section number from the directory name
-  loc *  exist *  algo *  size *  imp **
-
-- Does makewhatis(8) detect missing NAME sections, missing names,
-  and missing descriptions in all the file formats?
+- change the default PAGER to more -Es and use the pager
+  even for apropos title line output; req by bapt@

   loc *  exist *  algo *  size *  imp ***
 
 - clean up escape sequence handling, creating three classes:
   loc *  exist *  algo *  size *  imp ***
 
 - clean up escape sequence handling, creating three classes:


@@ -271,10 +275,6 @@ are mere guesses, and some may be wrong.
 
 --- compatibility checks -----------------------------------------------
 
 
 --- 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
 
 - is .Bk implemented correctly in modern groff?
   sobrado@  Tue, 19 Apr 2011 22:12:55 +0200
 


@@ -284,6 +284,8 @@ are mere guesses, and some may be wrong.
 - look at AT&T DWB http://www2.research.att.com/sw/download
   Carsten Kunze <carsten dot kunze at arcor dot de> has patches
   Mon, 4 Aug 2014 17:01:28 +0200
 - look at AT&T DWB http://www2.research.att.com/sw/download
   Carsten Kunze <carsten dot kunze at arcor dot de> has patches
   Mon, 4 Aug 2014 17:01:28 +0200

+  ported version: https://github.com/n-t-roff/DWB3.3
+  Carsten Kunze  Wed, 22 Apr 2015 11:21:43 +0200

 
 - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
   These are a weird mixture of man(7) and custom autogenerated low-level
 
 - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
   These are a weird mixture of man(7) and custom autogenerated low-level


@@ -318,6 +320,9 @@ are mere guesses, and some may be wrong.
   https://github.com/schmonz/ikiwiki/compare/mandoc
   Amitai Schlair  Mon, 19 May 2014 14:05:53 -0400
 
   https://github.com/schmonz/ikiwiki/compare/mandoc
   Amitai Schlair  Mon, 19 May 2014 14:05:53 -0400
 

+- check features of the Slackware man.conf(5) format
+  Carsten Kunze  Wed, 11 Mar 2015 17:57:24 +0100
+

 ************************************************************************
 * formatting issues: ugly output
 ************************************************************************
 ************************************************************************
 * formatting issues: ugly output
 ************************************************************************


@@ -378,7 +383,7 @@ are mere guesses, and some may be wrong.
   reveals lots of bugs both in groff and mandoc...
   reported by bentley@  Wed, 22 May 2013 23:49:30 -0600
 
   reveals lots of bugs both in groff and mandoc...
   reported by bentley@  Wed, 22 May 2013 23:49:30 -0600
 

---- PDF issues ---------------------------------------------------------
+--- PostScript and PDF issues ------------------------------------------

 
 - PDF output doesn't use a monospaced font for .Bd -literal
   Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf".
 
 - PDF output doesn't use a monospaced font for .Bd -literal
   Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf".


@@ -388,18 +393,22 @@ are mere guesses, and some may be wrong.
   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 (?)).
   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 (?)).

+  re-reported by tb@ Mon, 16 Mar 2015 16:47:21 +0100

   loc *  exist **  algo **  size *  imp **
 
 --- HTML issues --------------------------------------------------------
 
   loc *  exist **  algo **  size *  imp **
 
 --- HTML issues --------------------------------------------------------
 

-- <dl><dt><dd> formatting is ugly
-  hints are easy to find on the web, e.g.
-  http://stackoverflow.com/questions/1713048/
-  see also matthew@  Fri, 18 Jul 2014 19:25:12 -0700
-  loc *  exist *  algo **  size *  imp ***
+- .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal
+  space, see for example random(3).  Introduced in
+  http://mdocml.bsd.lv/cgi-bin/cvsweb/mdoc_html.c.diff?r1=1.91&r2=1.92
+  reported by deraadt@ Mon, 28 Sep 2015 20:14:13 -0600 (MDT)
+  loc **  exist **  algo **  size *  imp *

 
 - jsg on icb, Nov 3, 2014:
   try to guess Xr in man(7) for hyperlinking
 
 - jsg on icb, Nov 3, 2014:
   try to guess Xr in man(7) for hyperlinking

+  and render them with <a class="Xr" href=...>
+  https://github.com/Debian/debiman/issues/15
+  loc *  exist *  algo **  size **  imp **

 
 - The tables used to render the three-part page headers actually force
   the width of the <body> to the max-width given for <html>.
 
 - The tables used to render the three-part page headers actually force
   the width of the <body> to the max-width given for <html>.


@@ -408,9 +417,6 @@ are mere guesses, and some may be wrong.
   http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1
   loc *  exist *  algo **  size *  imp ***
 
   http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1
   loc *  exist *  algo **  size *  imp ***
 

-- consider whether <var> can be used for Ar Dv Er Ev Fa Va.
-  from bentley@  Wed, 13 Aug 2014 09:17:55 -0600
-

 - generate <img> tags in HTML
   idea from florian@  Tue, 7 Apr 2015 00:26:28 +0000
   may be possible to implement with .Lk img://something.png alt_text
 - generate <img> tags in HTML
   idea from florian@  Tue, 7 Apr 2015 00:26:28 +0000
   may be possible to implement with .Lk img://something.png alt_text


@@ -427,6 +433,9 @@ are mere guesses, and some may be wrong.
   Steffen Nurpmeso  Sat, 08 Nov 2014 13:34:59 +0100
   loc *  exist **  algo **  size *  imp **
 
   Steffen Nurpmeso  Sat, 08 Nov 2014 13:34:59 +0100
   loc *  exist **  algo **  size *  imp **
 

+- .Lk formatting for long links with line breaks
+  Franco Fichtner  8 Oct 2013 00:33:42 +0200
+

 - In .Bl -enum -width 0n, groff continues one the same line after
   the number, mandoc breaks the line.
   mail to kristaps@  Mon, 20 Jul 2009 02:21:39 +0200
 - In .Bl -enum -width 0n, groff continues one the same line after
   the number, mandoc breaks the line.
   mail to kristaps@  Mon, 20 Jul 2009 02:21:39 +0200


@@ -471,6 +480,7 @@ are mere guesses, and some may be wrong.
   The same applies to .Bl -column column widths;
   reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
   reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200
   The same applies to .Bl -column column widths;
   reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
   reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200

+  reported again by Bruce Evans Fri, 17 Feb 2017 21:22:44 +0100 via bapt@

   loc ***  exist ***  algo ***  size **  imp ***
   An easy partial fix would be to just skip the first word if it starts
   with a dot, including any following white space, when measuring.
   loc ***  exist ***  algo ***  size **  imp ***
   An easy partial fix would be to just skip the first word if it starts
   with a dot, including any following white space, when measuring.


@@ -481,12 +491,6 @@ are mere guesses, and some may be wrong.
   we want three blank lines, not two as in mandoc.
   loc **  exist **  algo **  size *  imp **
 
   we want three blank lines, not two as in mandoc.
   loc **  exist **  algo **  size *  imp **
 

-- Header lines of excessive length:
-  Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
-  and document it in mdoc(7) and man(7) COMPATIBILITY
-  found while talking to Chris Bennett
-  loc *  exist *  algo *  size *  imp *
-

 - Sequences of multiple man(7) paragraphs (.PP, .IP) interspersed
   with .ps and .nf/.fi produce execessive blank lines, see libJudy
   and graphics/dcmtk.  The parser reorg may help with this.
 - Sequences of multiple man(7) paragraphs (.PP, .IP) interspersed
   with .ps and .nf/.fi produce execessive blank lines, see libJudy
   and graphics/dcmtk.  The parser reorg may help with this.


@@ -499,25 +503,18 @@ are mere guesses, and some may be wrong.
   in dig(1).
   loc **  exist **  algo **  size *  imp **
 
   in dig(1).
   loc **  exist **  algo **  size *  imp **
 

-************************************************************************
-* portability
-************************************************************************
-
-- word boundaries in regular expressions for whatis(1)
-  set up config tests to use [[:<:]], \<, or nothing
-  reminded by Peter Bray Fri, 03 Apr 2015 23:02:16 +1100
-

 ************************************************************************
 * warning issues
 ************************************************************************
 
 ************************************************************************
 * warning issues
 ************************************************************************
 

-- check that MANDOCERR_BADTAB is thrown in the right cases,
-  i.e. when finding a literal tab character in fill mode,
-  and possibly change the wording of the warning message
-  to refer to fill mode, not literal mode
-  See the mail from Werner LEMBERG on the groff list,
-  Fri, 14 Feb 2014 18:54:42 +0100 (CET)
-  loc *  exist **  algo **  size *  imp **
+- provide a way in mandoc(1) to warn about broken .Xr links;
+  probably cannot be on by default in -Tlint because it needs
+  to access the manpath and mandoc.db(3) after parsing.
+  asked for by jmc@ Fri, 4 Dec 2015 22:39:40 +0000
+
+- warn when .Sh or .Ss contain other macros
+  Steffen Nurpmeso, savannah.gnu.org/bugs/index.php?45034
+  loc *  exist *  algo *  size *  imp **

 
 - warn about attempts to call non-callable macros
   Steffen Nurpmeso  Tue, 11 Nov 2014 22:55:16 +0100
 
 - warn about attempts to call non-callable macros
   Steffen Nurpmeso  Tue, 11 Nov 2014 22:55:16 +0100


@@ -527,9 +524,6 @@ are mere guesses, and some may be wrong.
   all over mdoc_macro.c and all subtly different.
   loc **  exist **  algo **  size **  imp **
 
   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 **
-

 - mandoc_special does not really check the escape sequence,
   but just the overall format
   loc **  exist **  algo ***  size **  imp **
 - mandoc_special does not really check the escape sequence,
   but just the overall format
   loc **  exist **  algo ***  size **  imp **


@@ -545,19 +539,10 @@ are mere guesses, and some may be wrong.
   to tech@mdocml, naddy@  Wed, 28 Sep 2011 11:21:46 +0200
   wait!  kristaps@  Sun, 02 Oct 2011 17:12:52 +0200
 
   to tech@mdocml, naddy@  Wed, 28 Sep 2011 11:21:46 +0200
   wait!  kristaps@  Sun, 02 Oct 2011 17:12:52 +0200
 

-- for system errors, use errno/strerror/warn/err
-

 ************************************************************************
 * documentation issues
 ************************************************************************
 
 ************************************************************************
 * documentation issues
 ************************************************************************
 

-- mention hyphenation rules:
-  breaking at letter-letter in text mode (not macro args)
-  proper hyphenation is unimplemented
-
-- talk about spacing around delimiters
-  to jmc@, kristaps@  Sat, 23 Apr 2011 17:41:27 +0200
-

 - mark macros as: page structure domain, manual domain, general text domain
   is this useful?
 
 - mark macros as: page structure domain, manual domain, general text domain
   is this useful?
 


@@ -571,32 +556,24 @@ are mere guesses, and some may be wrong.
 ************************************************************************
 
 - Why are we using MAP_SHARED, not MAP_PRIVATE for mmap(2)?
 ************************************************************************
 
 - Why are we using MAP_SHARED, not MAP_PRIVATE for mmap(2)?

-  How does SQLITE_CONFIG_PAGECACHE actually work?  Document it!

   from kristaps@  Sat, 09 Aug 2014 13:51:36 +0200
 
 Several areas can be cleaned up to make mandoc even faster.  These are
 
 - improve hashing mechanism for macros (quite important: performance)
 
   from kristaps@  Sat, 09 Aug 2014 13:51:36 +0200
 
 Several areas can be cleaned up to make mandoc even faster.  These are
 
 - improve hashing mechanism for macros (quite important: performance)
 

-- improve hashing mechanism for characters (not as important)
-

 - 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
-  loc *  exist **  algo **  size *  imp **
-

 ************************************************************************
 * structural issues
 ************************************************************************
 
 ************************************************************************
 * structural issues
 ************************************************************************
 

-- Improve -O suboption parsing.  Do it in the main program such that
-  errors can be reported.  Pay attention to distinguishing the
-  mandoc(1) and apropos(1) styles of both options.
-  loc **  exist *  algo **  size **  imp ***
-
-- Use libz directly instead of forking gunzip(1).
-  Suggested by bapt at FreeBSD among others.
+- POSIX says in the documentation of sysconf(3) that PATH_MAX
+  is allowed to be so large that it is a bad idea to use it
+  for sizing static buffers.  So use dynamic buffers throughout.
+  See the file test-PATH_MAX.c for details.
+  Found by Aaron M. Ucko in the GNU Hurd via Bdale Garbee,
+  https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=829624

 
 - We use the input line number at several places to distinguish
   same-line from different-line input.  That plainly doesn't work
 
 - We use the input line number at several places to distinguish
   same-line from different-line input.  That plainly doesn't work


@@ -613,11 +590,6 @@ Several areas can be cleaned up to make mandoc even faster.  These are
 - struct mparse refactoring
   Steffen Nurpmeso  Thu, 04 Sep 2014 12:50:00 +0200
 
 - 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.
-  suggested by espie@  Sat, 19 Apr 2014 14:52:57 +0200
-

 ************************************************************************
 * CGI issues
 ************************************************************************
 ************************************************************************
 * CGI issues
 ************************************************************************


@@ -626,9 +598,6 @@ Several areas can be cleaned up to make mandoc even faster.  These are
    output through libz.
  - Sandbox (see OpenSSH).
  - Enable caching support via HTTP 304 and If-Modified-Since.
    output through libz.
  - Sandbox (see OpenSSH).
  - Enable caching support via HTTP 304 and If-Modified-Since.

- - Allow for cgi.h to be overridden by CGI environment variables.
-   Otherwise, binary distributions will inherit the compile-time
-   behaviour, which is not optimal.

  - Have Mac OSX systems automatically disable -static compilation of the
    CGI: -static isn't supported.
 
  - Have Mac OSX systems automatically disable -static compilation of the
    CGI: -static isn't supported.
 


@@ -638,3 +607,10 @@ Several areas can be cleaned up to make mandoc even faster.  These are
 
 - use uname(1) to set doc-default-operating-system at install time
   tobimensch  Mon, 1 Dec 2014 00:25:07 +0100
 
 - use uname(1) to set doc-default-operating-system at install time
   tobimensch  Mon, 1 Dec 2014 00:25:07 +0100

+
+- apostrophe (39), circumflex (94), grave (96), tilde (126)
+  in manuals: \(aq, \(ha, \`, \(ti
+  Re: [Groff] ASCII Minus Sign in man Pages.
+  bentley@ 26 Apr 2017 10:02:06 -0600
+  Do we need to fix existing manuals?
+  Do we need to fix the definition of the mdoc(7) language?