mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.193 and 1.208

version 1.193, 2014/12/03 01:46:54

version 1.208, 2015/06/10 22:26:19

Line 60 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) DocBook output

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

Anthony J. Bentley on discuss@ Sat, 21 Sep 2013 22:29:34 -0600

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

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

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

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 191 are mere guesses, and some may be wrong.

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

--- missing tbl features -----------------------------------------------

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

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

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

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

- kettenis wants base roff, ms, and me Fri, 1 Jan 2010 22:13:15 +0100 (CET)

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

- Some FreeBSD people need either a markdown output formatter

for mandoc -mdoc or a markdown to mdoc converter because they

have to maintain manuals needed both in markdown and mdoc format.

--- 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 286 are mere guesses, and some may be wrong.

Line 317 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 298 are mere guesses, and some may be wrong.

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

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

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

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

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

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

- 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

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

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

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

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

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.

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

see for example

makes

\fBdig \fR

operate in batch mode

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

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

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

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

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

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

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)

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

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

- 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

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

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

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

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

CVSweb