mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.196 and 1.235

version 1.196, 2014/12/17 20:31:19

version 1.235, 2017/03/03 14:23:23

Line 33 Obviously, as the issues have not been solved yet, the

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

************************************************************************

Line 60 are mere guesses, and some may be wrong.

Line 51 are mere guesses, and some may be wrong.

- .fc (field control)

found by naddy@ in xloadimage(1)

loc ** exist *** algo * size * imp *

- .nr third argument (auto-increment step size, requires \n+)

found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700

loc * exist * algo * size * imp **

- .ns (no-space mode) occurs in xine-config(1)

when implementing this, also let .TH set it

reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500

loc *** exist *** algo *** size ** imp *

- .ta (tab settings) occurs in ircbug(1) and probably gnats(1)

- .ta (tab settings)

reported by brad@ Sat, 15 Jan 2011 15:50:51 -0500

#1 most important issue naddy@ Mon, 16 Feb 2015 20:59:17 +0100

ircbug(1) 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

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 naddy@ in xloadimage(1) [devel/libvstr] vstr(3)

found by bentley@ in nmh(1) Mon, 23 Apr 2012 13:38:28 -0600

loc ** exist ** algo ** size * imp ** (parser reorg helps a lot)

- .while and .shift

found by jca@ in ratpoison(1) Sun, 30 Jun 2013 12:01:09 +0200

loc * exist ** algo ** size ** imp **

- \h horizontal move

found in cclive(1) and nasm(1) asciidoc/DocBook output

#2 most important issue naddy@ Mon, 16 Feb 2015 20:59:17 +0100

found in cclive(1) nasm(1) bogofilter(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)

loc ** exist ** algo ** size * imp *** (parser reorg helps a lot)

- \n+ and \n- numerical register increment and decrement

found by bentley@ in sbcl(1) Mon, 9 Dec 2013 18:36:57 -0700

loc * exist * algo * size * imp **

- \n(.$ macro argument count number register; ocserv(8) by autogen

found by sthen@ Thu, 19 Feb 2015 22:03:01 +0000

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 *

- using undefined strings or macros defines them to be empty

wl@ Mon, 14 Nov 2011 14:37:01 +0000

loc * exist * algo * size * imp *

--- missing mdoc features ----------------------------------------------

- fix bad block nesting involving multiple identical explicit blocks

see the OpenBSD mdoc_macro.c 1.47 commit message

loc * exist *** algo *** size * imp **

- .Bl -column .Xo support is missing

ultimate goal:

restore .Xr and .Dv to

Line 186 are mere guesses, and some may be wrong.

Line 193 are mere guesses, and some may be wrong.

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 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 **

- 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 -----------------------------------------------

- 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 *

Line 225 are mere guesses, and some may be wrong.

Line 258 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 *

- When makewhatis(8) encounters a FATAL parse error,

- change the default PAGER to more -Es and use the pager

it silently treats the file as formatted, which makes no sense

even for apropos title line output; req by bapt@

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?

loc * exist * algo * size * imp ***

- clean up escape sequence handling, creating three classes:

Line 255 are mere guesses, and some may be wrong.

Line 275 are mere guesses, and some may be wrong.

--- 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

Line 268 are mere guesses, and some may be wrong.

Line 284 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

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

Line 291 are mere guesses, and some may be wrong.

Line 309 are mere guesses, and some may be wrong.

http://swtch.com/plan9port/man/man7/man.html

"Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700

- check compatibility with COHERENT troff:

http://www.nesssoftware.com/home/mwc/source.php

- check compatibility with the man(7) formatter

https://raw.githubusercontent.com/rofl0r/hardcore-utils/master/man.c

Line 299 are mere guesses, and some may be wrong.

Line 320 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

- check features of the Slackware man.conf(5) format

Carsten Kunze Wed, 11 Mar 2015 17:57:24 +0100

************************************************************************

* formatting issues: ugly output

************************************************************************

Line 351 are mere guesses, and some may be wrong.

Line 375 are mere guesses, and some may be wrong.

reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059

loc * exist ** algo *** size * imp ***

- a line starting with "\fB something" counts as starting with whitespace

and triggers a line break; found in audio/normalize-mp3(1)

loc ** exist * algo ** size * imp **

- formatting /usr/local/man/man1/latex2man.1 with groff and mandoc

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".

Line 365 are mere guesses, and some may be wrong.

Line 393 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 (?)).

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

loc * exist ** algo ** size * imp **

--- HTML issues --------------------------------------------------------

- <dl><dt><dd> formatting is ugly

- .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal

hints are easy to find on the web, e.g.

space, see for example random(3). Introduced in

http://stackoverflow.com/questions/1713048/

http://mdocml.bsd.lv/cgi-bin/cvsweb/mdoc_html.c.diff?r1=1.91&r2=1.92

see also matthew@ Fri, 18 Jul 2014 19:25:12 -0700

reported by deraadt@ Mon, 28 Sep 2015 20:14:13 -0600 (MDT)

loc * exist * algo ** size * imp ***

loc ** exist ** algo ** size * imp *

- 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>.

Line 385 are mere guesses, and some may be wrong.

Line 417 are mere guesses, and some may be wrong.

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.

- generate <img> tags in HTML

from bentley@ Wed, 13 Aug 2014 09:17:55 -0600

idea from florian@ Tue, 7 Apr 2015 00:26:28 +0000

may be possible to implement with .Lk img://something.png alt_text

- check https://github.com/trentm/mdocml

Line 400 are mere guesses, and some may be wrong.

Line 433 are mere guesses, and some may be wrong.

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

Line 444 are mere guesses, and some may be wrong.

Line 480 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

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.

Line 454 are mere guesses, and some may be wrong.

Line 491 are mere guesses, and some may be wrong.

we want three blank lines, not two as in mandoc.

loc ** exist ** algo ** size * imp **

- Header lines of excessive length:

- Sequences of multiple man(7) paragraphs (.PP, .IP) interspersed

Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c

with .ps and .nf/.fi produce execessive blank lines, see libJudy

and document it in mdoc(7) and man(7) COMPATIBILITY

and graphics/dcmtk. The parser reorg may help with this.

found while talking to Chris Bennett

loc * exist * algo * size * imp *

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

see for example

makes

\fBdig \fR

operate in batch mode

Line 472 are mere guesses, and some may be wrong.

Line 507 are mere guesses, and some may be wrong.

* warning issues

************************************************************************

- check that MANDOCERR_BADTAB is thrown in the right cases,

- provide a way in mandoc(1) to warn about broken .Xr links;

i.e. when finding a literal tab character in fill mode,

probably cannot be on by default in -Tlint because it needs

and possibly change the wording of the warning message

to access the manpath and mandoc.db(3) after parsing.

to refer to fill mode, not literal mode

asked for by jmc@ Fri, 4 Dec 2015 22:39:40 +0000

See the mail from Werner LEMBERG on the groff list,

Fri, 14 Feb 2014 18:54:42 +0100 (CET)

loc * exist ** algo ** size * imp **

- 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

Note that formatting is inconsistent in groff.

Line 488 are mere guesses, and some may be wrong.

Line 524 are mere guesses, and some may be wrong.

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 **

Line 506 are mere guesses, and some may be wrong.

Line 539 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

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

************************************************************************

* 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?

Line 532 are mere guesses, and some may be wrong.

Line 556 are mere guesses, and some may be wrong.

************************************************************************

- 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)

- improve hashing mechanism for characters (not as important)

- 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

************************************************************************

- Use libz directly instead of forking gunzip(1).

- POSIX says in the documentation of sysconf(3) that PATH_MAX

Suggested by bapt at FreeBSD among others.

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

Line 560 Several areas can be cleaned up to make mandoc even fa

Line 581 Several areas can be cleaned up to make mandoc even fa

- 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.

Line 569 Several areas can be cleaned up to make mandoc even fa

Line 590 Several areas can be cleaned up to make mandoc even fa

- 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

************************************************************************

Line 582 Several areas can be cleaned up to make mandoc even fa

Line 598 Several areas can be cleaned up to make mandoc even fa

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.

CVSweb