************************************************************************
* Official mandoc TODO.
-* $Id: TODO,v 1.258 2018/08/06 14:16:30 schwarze Exp $
+* $Id: TODO,v 1.283 2019/01/17 08:14:38 schwarze Exp $
************************************************************************
Many issues are annotated for difficulty as follows:
--- missing roff features ----------------------------------------------
-- .nop prints its arguments as text,
- see groff(7) for an example
-
-- .ft CB selects constant-width bold font
- see groff_out(7) for examples
-
-- \*(.T prints the device being used,
- see groff_char(7) for an example
-
-- \[charNN], \[charNNN] prints a single-byte codepoint
- see groff_char(7) for examples
-
- .ad (adjust margins)
.ad l -- adjust left margin only (flush left)
.ad r -- adjust right margin only (flush right)
reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500
loc *** exist *** algo *** size ** imp *
-- .while and .shift
- found by jca@ in ratpoison(1) Sun, 30 Jun 2013 12:01:09 +0200
- loc * exist ** algo ** size ** imp **
-
- \w'' improve 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
loc ** exist *** algo *** size * imp ***
-- \\ in high-level macro arguments
- Currently, \\ is expanded in two situations:
- 1) macro and string definition (roff.c setstrn())
- 2) macro argument parsing (mandoc.c mandoc_getarg())
- For user defined macros, the second happens in time because of ROFF_REPARSE.
- But for standard high-level macros, it only happens after entering the
- high level parsers, which is too late because the code doesn't get
- back to roff.c roff_res() from that point. Because this requires
- distinguishing requests, user-defined macros and standard macros
- on the roff_res() level, it is hard to solve without the parser reorg.
- Found by naddy@ in devel/cutils cobfusc(1) Mon, 16 Feb 2015 19:10:52 +0100
- loc *** exist *** algo *** size ** imp *
-
-- check for missing roff escape sequences, implement those that are
- trivial even if not usually appearing in manual pages, gracefully
- ignore the non-trivial ones, document what they are supposed to do
- and what mandoc does instead
- loc * exist ** algo * size * imp *
-
--- missing mdoc features ----------------------------------------------
- .Bl -column .Xo support is missing
from jmc@ Wed, 14 Jul 2010 18:10:32 +0100
loc * exist *** algo *** size ** imp **
-- .Bd -centered implies -filled, not -unfilled, which is not
- easy to implement; it requires code similar to .ce, which
- we don't have either.
- Besides, groff has bug causing text right *before* .Bd -centered
- to be centered as well.
- loc *** exist *** algo ** size ** imp ** (parser reorg would help)
-
- .Bd -filled should not be the same as .Bd -ragged, but align both
the left and right margin. In groff, it is implemented in terms
of .ad b, which we don't have either. Found in cksum(1).
--- missing man features -----------------------------------------------
-- .SY and .YS,
- used by many groff manual pages
-
-- preserve punctuation following .ME,
- see ditroff(7) for an example
-
-- .TQ tagged paragraph continuation,
- see groff_diff(7) for examples
-
- groff_www(7) .MTO and .URL
These macros were used by the GNU grep(1) man page.
The groff_www(7) manual page itself uses them, too.
--- missing tbl features -----------------------------------------------
-- 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 **
-
- vertical centering in cells vertically spanned with ^
pali dot rohar at gmail dot com 16 Jul 2018 13:03:35 +0200
loc * exist *** algo *** size ** imp *
-- support .ds requests inside tbl(7) code,
- see tbl(1) for an example
-
- 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;
loc *** exist ** algo *** size ** imp ***
- look at the POSIX manuals in the books/man-pages-posix port,
- they use some unsupported tbl(7) features.
+ they use some unsupported tbl(7) features, mostly macros in tbl(7).
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 **
-
-- implement horizontal and vertical alignment in HTML output
- pali dot rohar at gmail dot com 16 Jul 2018 13:03:35 +0200
- loc * exist * algo * size * imp ***
-
-- implement cell spanning in HTML output
- pali dot rohar at gmail dot com 16 Jul 2018 13:03:35 +0200
- loc * exist * algo ** size ** imp **
-
-- implement table borders in HTML output
- pali dot rohar at gmail dot com 16 Jul 2018 13:03:35 +0200
- loc * exist * algo ** size ** imp **
-
--- missing eqn features -----------------------------------------------
- In a matrix, break the output line after each matrix line.
* formatting issues: ugly output
************************************************************************
-- .UR can nest inside .TP,
- see roff(7) for examples
-
- 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
it does seem cleaner.)
loc ** exist ** algo * size * imp ***
+- format multiple subsequent .IP as a single list
+ rather than opening a new list for each item
+ Pali Rohar 25 Nov 2018 14:34:26 +0100
+ loc * exist ** algo * size * imp ***
+
- format ".IP *" etc. as <ul> rather than <dl>
https://github.com/Debian/debiman/issues/67
+ reminded by Pali Rohar 25 Nov 2018 14:34:26 +0100
loc ** exist ** algo ** size * imp ***
- .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal
* warning issues
************************************************************************
+- When a man(1) command returns no result and there was an -S
+ argument, check the -S argument against the list of valid
+ architectures and say "Unknown architecture AAA" rather than
+ "No entry for NNN in the manual" if there is no match.
+ Requires moving the lists of valid architectures out of
+ mdoc_validate.c such that they can be used by main.c.
+ Discussed with jmc@ 10 Aug 2018 19:20:12 +0100.
+ loc ** exist * algo * size * imp **
+
- warn about duplicate .Sh/.Ss heads
gre(4): Rename duplicate sections 20 Apr 2018 15:27:33 +0200
loc * exist * algo * size * imp **
all over mdoc_macro.c and all subtly different.
loc ** exist ** algo ** size ** imp **
-- style message about suspicious uses of - vs. \- vs. \(mi
- e.g. -1 is likely wrong (from the mdoclint TODO)
-
- warn about punctuation - e.g. ',' and ';' - at the beginning
of a text line, if it is likely intended to follow the preceding
output without intervening whitespace, in particular after a
macro line (from the mdoclint TODO)
-- mandoc_special does not really check the escape sequence,
- but just the overall format
- loc ** exist ** algo *** size ** imp **
-
- makewhatis -p complains about language subdirectories:
/usr/local/man//ru: Unknown directory part
* documentation issues
************************************************************************
-- dashes, hyphens, and minus signs in manual pages
- jmc@ Fri, 28 Mar 2014 07:19:27 +0000
-
- mark macros as: page structure domain, manual domain, general text domain
is this useful?
output through libz.
- Privilege separation (see OpenSSH).
- Enable caching support via HTTP 304 and If-Modified-Since.
- - Have Mac OSX systems automatically disable -static compilation of the
- CGI: -static isn't supported.
************************************************************************
* to improve in the groff_mdoc(7) macros
git.ckatri.com / mandoc.git / blobdiff