[BACK]Return to TODO CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.155 and 1.171

version 1.155, 2013/09/22 11:48:38 version 1.171, 2014/06/10 21:19:57
Line 7 
Line 7 
 * crashes  * crashes
 ************************************************************************  ************************************************************************
   
 None known right now.  - 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.
   
 ************************************************************************  ************************************************************************
 * missing features  * missing features
Line 15  None known right now.
Line 17  None known right now.
   
 --- missing roff features ----------------------------------------------  --- missing roff features ----------------------------------------------
   
 - roff.c should treat \n(.H>23 and \n(.V>19 in the pod2man(1)  
   preamble as true, see for example AUTHORS in MooseX::Getopt.3p  
   reported by Andreas Voegele <mail at andreasvoegele dot com>  
   Tue, 22 Nov 2011 15:34:47 +0100 on ports@  
   
 - .ad (adjust margins)  - .ad (adjust margins)
   .ad l -- adjust left margin only (flush left)    .ad l -- adjust left margin only (flush left)
   .ad r -- adjust right margin only (flush right)    .ad r -- adjust right margin only (flush right)
Line 29  None known right now.
Line 26  None known right now.
   .ad   -- re-enable adjustment without changing the mode    .ad   -- re-enable adjustment without changing the mode
   Adjustment mode is ignored while in no-fill mode (.nf).    Adjustment mode is ignored while in no-fill mode (.nf).
   
 - .as (append to string)  
   found by jca@ in ratpoison(1)  Sun, 30 Jun 2013 12:01:09 +0200  
   
 - .ce (center N lines)  
   found by naddy@ in xloadimage(1)  
   found by Juan Francisco Cantero Hurtado <iam at juanfra dot info>  
            in lang/racket(1)  Thu, 20 Jun 2013 03:19:11 +0200  
   
 - .fc (field control)  - .fc (field control)
   found by naddy@ in xloadimage(1)    found by naddy@ in xloadimage(1)
   
   - .nr third argument (auto-increment step size, requires \n+)
     found by bentley@ in sbcl(1)  Mon, 9 Dec 2013 18:36:57 -0700
   
 - .ns (no-space mode) occurs in xine-config(1)  - .ns (no-space mode) occurs in xine-config(1)
   reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500    reported by brad@  Sat, 15 Jan 2011 15:45:23 -0500
   
 - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)  - .ta (tab settings) occurs in ircbug(1) and probably gnats(1)
   reported by brad@  Sat, 15 Jan 2011 15:50:51 -0500    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
   
 - .ti (temporary indent)  - .ti (temporary indent)
   found by naddy@ in xloadimage(1)    found by naddy@ in xloadimage(1)
Line 61  None known right now.
Line 54  None known right now.
   found in cclive(1) DocBook output    found in cclive(1) DocBook output
   Anthony J. Bentley on discuss@  Sat, 21 Sep 2013 22:29:34 -0600    Anthony J. Bentley on discuss@  Sat, 21 Sep 2013 22:29:34 -0600
   
   - \n+ and \n- numerical register increment and decrement
     found by bentley@ in sbcl(1)  Mon, 9 Dec 2013 18:36:57 -0700
   
   - \w'' width measurements
     would not be very useful without an expression parser, see below
     needed for Tcl_NewStringObj(3) via wiz@  Wed, 5 Mar 2014 22:27:43 +0100
   
 - using undefined strings or macros defines them to be empty  - using undefined strings or macros defines them to be empty
   wl@  Mon, 14 Nov 2011 14:37:01 +0000    wl@  Mon, 14 Nov 2011 14:37:01 +0000
   
   - general expression parser, including arithmetics
     to be used at least for .if/.ie and .nr and maybe at other places
     could use J.T.Conklin's PD code in bin/expr/expr.c for inspiration
     needed for Tcl_NewStringObj(3) via wiz@  Wed, 5 Mar 2014 22:27:43 +0100
   
 --- missing mdoc features ----------------------------------------------  --- missing mdoc features ----------------------------------------------
   
 - fix bad block nesting involving multiple identical explicit blocks  - fix bad block nesting involving multiple identical explicit blocks
Line 134  None known right now.
Line 139  None known right now.
   
 --- missing man features -----------------------------------------------  --- 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  
   also occur in freeciv-client(6) freeciv-server(6) freeciv-modpack(6)  
   reported by bentley@  Tue, 30 Oct 2012 01:05:57 -0600  
   
 - -T[x]html doesn't stipulate non-collapsing spaces in literal mode  - -T[x]html doesn't stipulate non-collapsing spaces in literal mode
   
 --- missing tbl features -----------------------------------------------  --- missing tbl features -----------------------------------------------
   
   - look at the POSIX manuals in the books/man-pages-posix port,
     they use some unsupported tbl(7) features.
   
 - implement basic non-parametric .de to support e.g. sox(1)  - implement basic non-parametric .de to support e.g. sox(1)
   reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200    reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200
   *** sox(1) still doesn't work, tbl(1) errors need investigation    *** sox(1) still doesn't work, tbl(1) errors need investigation
Line 153  None known right now.
Line 156  None known right now.
   
 --- missing misc features ----------------------------------------------  --- missing misc features ----------------------------------------------
   
   - italic correction (\/) in PostScript mode
     Werner LEMBERG on groff at gnu dot org  Sun, 10 Nov 2013 12:47:46
   
 - The whatis(1) utility looks for whole words in Nm.  - The whatis(1) utility looks for whole words in Nm.
   If the file name of a page does not agree with the contents of any    If the file name of a page does not agree with the contents of any
   of its Nm macros (e.g. pool(9)), add the file name as an Nm entry    of its Nm macros (e.g. pool(9)), add the file name as an Nm entry
Line 162  None known right now.
Line 168  None known right now.
   with apropos(1) using the file name as a key, as well.    with apropos(1) using the file name as a key, as well.
   Issue reported by tedu@  Fri, 05 Jul 2013 21:15:23 -0400    Issue reported by tedu@  Fri, 05 Jul 2013 21:15:23 -0400
   
   - makewhatis(8) for preformatted pages:
     parse the section number from the header line
     and compare to the section number from the directory name
   
   - Does makewhatis(8) detect missing NAME sections, missing names,
     and missing descriptions in all the file formats?
   
 - clean up escape sequence handling, creating three classes:  - clean up escape sequence handling, creating three classes:
   (1) fully implemented, or parsed and ignored without loss of content    (1) fully implemented, or parsed and ignored without loss of content
   (2) unimplemented, potentially causing loss of content    (2) unimplemented, potentially causing loss of content
Line 176  None known right now.
Line 189  None known right now.
   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200    noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100    reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
   
   - look at pages generated from Texinfo source by yat2m, e.g. security/gnupg
     First impression is not that bad.
   
 - check compatibility with Plan9:  - check compatibility with Plan9:
   http://swtch.com/usr/local/plan9/tmac/tmac.an    http://swtch.com/usr/local/plan9/tmac/tmac.an
   http://swtch.com/plan9port/man/man7/man.html    http://swtch.com/plan9port/man/man7/man.html
Line 188  None known right now.
Line 204  None known right now.
 - a column list with blank `Ta' cells triggers a spurrious  - a column list with blank `Ta' cells triggers a spurrious
   start-with-whitespace printing of a newline    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)  
   reminded by millert@  Thu, 09 Dec 2010 17:29:52 -0500  
   
 - In .Bl -column,  - In .Bl -column,
   .It Em Authentication<tab>Key Length    .It Em Authentication<tab>Key Length
   ought to render "Key Length" with emphasis, too,    ought to render "Key Length" with emphasis, too,
Line 224  None known right now.
Line 235  None known right now.
   reveals lots of bugs both in groff and mandoc...    reveals lots of bugs both in groff and mandoc...
   reported by bentley@  Wed, 22 May 2013 23:49:30 -0600    reported by bentley@  Wed, 22 May 2013 23:49:30 -0600
   
   --- PDF issues ---------------------------------------------------------
   
   - PDF output doesn't use a monospaced font for .Bd -literal
     Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf".
     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
   
 ************************************************************************  ************************************************************************
 * formatting issues: gratuitous differences  * formatting issues: gratuitous differences
 ************************************************************************  ************************************************************************
Line 268  None known right now.
Line 287  None known right now.
   as -width 7n, not -width 11n.    as -width 7n, not -width 11n.
   The same applies to .Bl -column column widths;    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 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
     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.
   
 - The \& zero-width character counts as output.  - The \& zero-width character counts as output.
   That is, when it is alone on a line between two .Pp,    That is, when it is alone on a line between two .Pp,
   we want three blank lines, not two as in mandoc.    we want three blank lines, not two as in mandoc.
   
 - 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"  
   
 - Header lines of excessive length:  - Header lines of excessive length:
   Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c    Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
   and document it in mdoc(7) and man(7) COMPATIBILITY    and document it in mdoc(7) and man(7) COMPATIBILITY
Line 293  None known right now.
Line 308  None known right now.
   in dig(1).    in dig(1).
   
 ************************************************************************  ************************************************************************
   * 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)
   
   ************************************************************************
 * performance issues  * performance issues
 ************************************************************************  ************************************************************************
   
Line 322  Several areas can be cleaned up to make mandoc even fa
Line 348  Several areas can be cleaned up to make mandoc even fa
   Decide which formats should be recognized where.    Decide which formats should be recognized where.
   Update both mdoc(7) and man(7) documentation.    Update both mdoc(7) and man(7) documentation.
   Triggered by  Tim van der Molen  Tue, 22 Feb 2011 20:30:45 +0100    Triggered by  Tim van der Molen  Tue, 22 Feb 2011 20:30:45 +0100
   
   - 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
   
Legend:
Removed from v.1.155  
changed lines
  Added in v.1.171
CVSweb