version 1.225, 2017/01/26 18:28:18 |
version 1.306, 2020/09/07 14:18:49 |
Line 33 Obviously, as the issues have not been solved yet, the |
|
Line 33 Obviously, as the issues have not been solved yet, the |
|
are mere guesses, and some may be wrong. |
are mere guesses, and some may be wrong. |
|
|
************************************************************************ |
************************************************************************ |
|
* assertion failures |
|
************************************************************************ |
|
|
|
- .if n .ce in the middle of .TS data |
|
afl case f1/id:000103,sig:06,src:009024+009105,op:splice,rep:2 (jes@) |
|
While roff_parseln() prevents .ce and similar requests in the middle |
|
of a tbl, the guard is no longer effective when the .ce is wrapped |
|
in a roff block, for example a conditional. The resulting assertion |
|
has never been seen in any real-world manual page. |
|
This is too dangerous to fix before release because it requires |
|
reorganizing the very delicate internals of roff_parseln(), |
|
which risks causing more severe bugs. |
|
loc * exist *** algo *** size * imp * |
|
|
|
************************************************************************ |
* missing features |
* missing features |
************************************************************************ |
************************************************************************ |
|
|
Line 52 are mere guesses, and some may be wrong. |
|
Line 67 are mere guesses, and some may be wrong. |
|
found by naddy@ in xloadimage(1) |
found by naddy@ in xloadimage(1) |
loc ** exist *** algo * size * imp * |
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) |
- .ns (no-space mode) occurs in xine-config(1) |
when implementing this, also let .TH set it |
when implementing this, also let .TH set it |
reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500 |
reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500 |
loc *** exist *** algo *** size ** imp * |
loc *** exist *** algo *** size ** imp * |
|
|
- .ta (tab settings) |
|
#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) [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 |
|
#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) |
|
|
|
- \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 |
- \w'' improve width measurements |
would not be very useful without an expression parser, see below |
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 |
needed for Tcl_NewStringObj(3) via wiz@ Wed, 5 Mar 2014 22:27:43 +0100 |
loc ** exist *** algo *** size * imp *** |
loc ** exist *** algo *** size * imp *** |
|
|
- \\ in high-level macro arguments |
- .als only works for macros in mandoc, not for user-defined strings. |
Currently, \\ is expanded in two situations: |
Also, the "val" field in struct roffkv would have to be replaced |
1) macro and string definition (roff.c setstrn()) |
with a pointer to a reference-counted wrapper, and an alias |
2) macro argument parsing (mandoc.c mandoc_getarg()) |
would have to point to the same wrapper as the original. |
For user defined macros, the second happens in time because of ROFF_REPARSE. |
.als to undefined does nothing; the alias is not created. |
But for standard high-level macros, it only happens after entering the |
.rm'ing the original leaves the alias to point to the old value. |
high level parsers, which is too late because the code doesn't get |
.de .als .de changes both, but |
back to roff.c roff_res() from that point. Because this requires |
.de .als .rm .de only changes the new value, not the alias. |
distinguishing requests, user-defined macros and standard macros |
Found in groffer(1) version 1.19 |
on the roff_res() level, it is hard to solve without the parser reorg. |
Jan Stary 20 Apr 2019 20:16:54 +0200 |
Found by naddy@ in devel/cutils cobfusc(1) Mon, 16 Feb 2015 19:10:52 +0100 |
loc * exist ** algo ** size ** imp * |
loc *** exist *** algo *** size ** imp * |
|
|
|
- using undefined strings or macros defines them to be empty |
- roff string condition comparisons fail when vars contain quotes: |
wl@ Mon, 14 Nov 2011 14:37:01 +0000 |
.ds s ' |
loc * exist * algo * size * imp * |
.if '\*s'' \&... |
|
hard to fix because of the basic architecture (string replacement |
|
happens before roff(7) syntax parsing) |
|
Found in groffer(1) version 1.19 |
|
Jan Stary 20 Apr 2019 20:16:54 +0200 |
|
loc * exist *** algo *** size ** imp * |
|
|
|
- mandoc replaces all ASCII control characters except tab and line feed |
|
with '?' during input. It would be better to replace them with |
|
Unicode escapes in preconv_encode() or somewhere in the vicinity, |
|
such that the already existing better replacement strings show |
|
up in the output. Emulating groff is not desirable: groff replaces |
|
0x00, 0x0b, and 0x0d to 0x1f with the empty string (bad because |
|
that's easy to overlook for the document author), 0x01 with '.' |
|
(very confusing), and passes through 0x02 to 0x08, 0x0c, and 0x7f |
|
raw (bad because that is insecure output). Remember that 0x07 may |
|
need special handling because it is sometimes used for certain |
|
delimiters, so it may need handling *after* roff.c rather than before. |
|
reminded by John Gardner 16 Jun 2020 14:26:28 +1000 |
|
Actually, more ASCII control characters than just 0x07 may need |
|
later handling because they can for example be used in macro names. |
|
So they may need handling after roff(7) processing. |
|
pointed out by John Gardner 23 Jun 2020 18:28:08 +1000 |
|
more info from John Gardner 29 Jun 2020 19:54:04 +1000 |
|
loc ** exist ** algo ** size ** imp * |
|
|
--- missing mdoc features ---------------------------------------------- |
--- missing mdoc features ---------------------------------------------- |
|
|
|
- .Sh and .Ss should be parsed and partially callable, see groff_mdoc(7) |
|
reed at reedmedia dot net Sat, 21 Dec 2019 17:13:07 -0600 |
|
loc ** exist ** algo ** size ** imp * |
|
|
- .Bl -column .Xo support is missing |
- .Bl -column .Xo support is missing |
ultimate goal: |
ultimate goal: |
restore .Xr and .Dv to |
restore .Xr and .Dv to |
Line 129 are mere guesses, and some may be wrong. |
|
Line 136 are mere guesses, and some may be wrong. |
|
from jmc@ Wed, 14 Jul 2010 18:10:32 +0100 |
from jmc@ Wed, 14 Jul 2010 18:10:32 +0100 |
loc * exist *** algo *** size ** imp ** |
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 |
- .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 |
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). |
of .ad b, which we don't have either. Found in cksum(1). |
Line 169 are mere guesses, and some may be wrong. |
|
Line 169 are mere guesses, and some may be wrong. |
|
is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab." |
is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab." |
but should give "ab ." |
but should give "ab ." |
|
|
- check whether it is correct that `D1' uses INDENT+1; |
|
does it need its own constant? |
|
loc * exist ** algo ** size * imp ** |
|
|
|
- prohibit `Nm' from having non-text HEAD children |
- prohibit `Nm' from having non-text HEAD children |
(e.g., NetBSD mDNSShared/dns-sd.1) |
(e.g., NetBSD mDNSShared/dns-sd.1) |
(mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified) |
(mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified) |
Line 193 are mere guesses, and some may be wrong. |
|
Line 189 are mere guesses, and some may be wrong. |
|
uqs@ Thu, 2 Jun 2011 11:33:35 +0200 |
uqs@ Thu, 2 Jun 2011 11:33:35 +0200 |
loc * exist ** algo *** size * imp ** |
loc * exist ** algo *** size * imp ** |
|
|
--- missing tbl features ----------------------------------------------- |
--- missing man features ----------------------------------------------- |
|
|
- horizontal lines in the layout still consume data cells |
- groff_www(7) .MTO and .URL |
and can be mixed with actual data on the same table line |
These macros were used by the GNU grep(1) man page. |
synaptics(4) found by tedu@ Mon, 17 Aug 2015 21:17:42 -0400 |
The groff_www(7) manual page itself uses them, too. |
loc ** exist ** algo ** size ** imp *** |
We should probably *not* add them to mandoc. |
|
Just mentioning this here to keep track of the abuse. |
|
Laura Morales <lauretas at mail dot com> 20 Apr 2018 07:33:02 +0200 |
|
loc ** exist * algo * size ** imp * |
|
|
- break long text into lines inside cells |
--- missing tbl features ----------------------------------------------- |
net/lftp(1) from jirib via bentley@ Sep 13, 2016 |
|
|
|
- layout l1 for a column of max text width 3 reduces the following |
- vertical centering in cells vertically spanned with ^ |
inter-column spacing for groff, but not for mandoc |
pali dot rohar at gmail dot com 16 Jul 2018 13:03:35 +0200 |
net/lftp(1) from jirib via bentley@ Sep 13, 2016 |
loc * exist *** algo *** size ** imp * |
|
|
- 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; |
- support mdoc(7) and man(7) macros inside tbl(7) code; |
probably requires the parser reorg and letting tbl(7) |
probably requires the parser reorg and letting tbl(7) |
use roff_node such that macro sets can mix; |
use roff_node such that macro sets can mix; |
informed by bapt@ that FreeBSD needs this. |
informed by bapt@ that FreeBSD needs this: 3 Jan 2015 23:32:23 +0100 |
loc *** exist ** algo *** size ** imp *** |
loc *** exist ** algo *** size ** imp *** |
|
|
- look at the POSIX manuals in the books/man-pages-posix port, |
- 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 *** |
loc * exist ** algo ** size ** imp *** |
|
|
- use Unicode U+2500 to U+256C for table borders |
- look what Joerg Schilling manual pages use |
in tbl(7) -Tutf-8 output |
Thu, 19 Mar 2015 18:31:48 +0100 |
suggested by bentley@ Tue, 14 Oct 2014 04:10:55 -0600 |
|
loc * exist ** algo * size * imp ** |
|
|
|
--- missing eqn features ----------------------------------------------- |
--- missing eqn features ----------------------------------------------- |
|
|
- In a matrix, break the output line after each matrix line. |
- In a matrix, break the output line after each matrix line. |
Found in the discussion at CDBUG 2015. |
Found in the discussion at CDBUG 2015. Suggested by Avi Weinstock. |
Suggested by Avi Weinstock. |
This may not be the ideal solution after all: eqn(7) matrices |
loc * exist * algo * size * imp ** |
are lists of columns, so Avi's proposal would show each *column* |
|
on its own *line*, which is likely to cause confusion. |
|
A better solution, but much harder to implement, would be to |
|
actually show the coordinates of column vectors on different |
|
terminal output lines, using the clumnated output facilities |
|
developed for .Bl -tag, .Bl -column, and also used for tbl(7). |
|
loc * exist * algo ** size ** imp ** |
|
|
- The "size" keyword is parsed, but ignored by the formatter. |
- The "size" keyword is parsed, but ignored by the formatter. |
loc * exist * algo * size * imp * |
loc * exist * algo * size * imp * |
Line 249 are mere guesses, and some may be wrong. |
|
Line 242 are mere guesses, and some may be wrong. |
|
see User's Guide (Second Edition) page 5 section 15. |
see User's Guide (Second Edition) page 5 section 15. |
loc ** exist ** algo ** size ** imp ** |
loc ** exist ** algo ** size ** imp ** |
|
|
|
- GNU eqn converts some operators to special characters, for example, |
|
input HYPHEN-MINUS becomes output \(mi, unless it is part of a |
|
quoted word. mandoc(1) only does this when the operator is |
|
surrounded by blanks, not when it is part of an unquoted word. |
|
Also, check whether there are more such cases (e.g., +?). |
|
reported by bentley@ 20 Jun 2017 02:04:29 -0600 |
|
loc * exist ** algo ** size * imp * |
|
|
|
- Primes, opprime, and ' |
|
bentley@ Thu, 13 Jul 2017 23:14:20 -0600 |
|
|
--- missing misc features ---------------------------------------------- |
--- missing misc features ---------------------------------------------- |
|
|
|
- -T man does not handle eqn(7) and tbl(7) |
|
Stephen Gregoratto 16 Feb 2020 01:28:07 +1100 |
|
loc ** exist ** algo ** size *** imp ** |
|
|
|
- man -ks 1,8 route; kn@ Jul 13, 2018 orally |
|
|
- italic correction (\/) in PostScript mode |
- italic correction (\/) in PostScript mode |
Werner LEMBERG on groff at gnu dot org Sun, 10 Nov 2013 12:47:46 |
Werner LEMBERG on groff at gnu dot org Sun, 10 Nov 2013 12:47:46 |
loc ** exist ** algo * size * imp * |
loc ** exist ** algo * size * imp * |
Line 259 are mere guesses, and some may be wrong. |
|
Line 269 are mere guesses, and some may be wrong. |
|
even for apropos title line output; req by bapt@ |
even for apropos title line output; req by bapt@ |
loc * exist * algo * size * imp *** |
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: |
- 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 279 are mere guesses, and some may be wrong. |
|
Line 280 are mere guesses, and some may be wrong. |
|
- kettenis wants base roff, ms, and me Fri, 1 Jan 2010 22:13:15 +0100 (CET) |
- kettenis wants base roff, ms, and me Fri, 1 Jan 2010 22:13:15 +0100 (CET) |
loc ** exist ** algo ** size *** imp * |
loc ** exist ** algo ** size *** imp * |
|
|
- Vsevolod Stakhov (FreeBSD) needs 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. |
|
Look at the libsoldout (markdown -> whatever) |
|
loc * exist * algo * size ** imp ** |
|
|
|
--- compatibility checks ----------------------------------------------- |
--- compatibility checks ----------------------------------------------- |
|
|
- is .Bk implemented correctly in modern groff? |
- is .Bk implemented correctly in modern groff? |
Line 296 are mere guesses, and some may be wrong. |
|
Line 291 are mere guesses, and some may be wrong. |
|
- look at AT&T DWB http://www2.research.att.com/sw/download |
- look at AT&T DWB http://www2.research.att.com/sw/download |
Carsten Kunze <carsten dot kunze at arcor dot de> has patches |
Carsten Kunze <carsten dot kunze at arcor dot de> has patches |
Mon, 4 Aug 2014 17:01:28 +0200 |
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) |
- 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 |
These are a weird mixture of man(7) and custom autogenerated low-level |
Line 330 are mere guesses, and some may be wrong. |
|
Line 327 are mere guesses, and some may be wrong. |
|
https://github.com/schmonz/ikiwiki/compare/mandoc |
https://github.com/schmonz/ikiwiki/compare/mandoc |
Amitai Schlair Mon, 19 May 2014 14:05:53 -0400 |
Amitai Schlair Mon, 19 May 2014 14:05:53 -0400 |
|
|
|
- check compatibility with |
|
https://git.sr.ht/~sircmpwn/scdoc |
|
|
|
- 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 |
************************************************************************ |
************************************************************************ |
Line 378 are mere guesses, and some may be wrong. |
|
Line 381 are mere guesses, and some may be wrong. |
|
.Vt vs .Vt/.Va vs .Ft/.Va vs .Ft/.Fa ... |
.Vt vs .Vt/.Va vs .Ft/.Va vs .Ft/.Fa ... |
from kristaps@ Tue, 08 Jun 2010 11:13:32 +0200 |
from kristaps@ Tue, 08 Jun 2010 11:13:32 +0200 |
|
|
|
- implicit whitespace around inline equations |
|
example code: where '$times$' denotes matrix multiplication |
|
must not have an HTML line break, nor a blank, before <math> |
|
partial solution: html.c {"math", HTML_NLINSIDE | HTML_INDENT}, |
|
bentley@ Thu, 13 Jul 2017 19:00:59 -0600 |
|
|
- in enclosures, mandoc sometimes fancies a bogus end of sentence |
- in enclosures, mandoc sometimes fancies a bogus end of sentence |
reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059 |
reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059 |
loc * exist ** algo *** size * imp *** |
loc * exist ** algo *** size * imp *** |
|
|
- a line starting with "\fB something" counts as starting with whitespace |
- a line starting with "\fB something" counts as starting with whitespace |
and triggers a line break; found in audio/normalize-mp3(1) |
and triggers a line break; found in audio/normalize-mp3(1) |
|
This will become easier once escape sequences are represented |
|
by syntax tree nodes. |
loc ** exist * algo ** size * imp ** |
loc ** exist * algo ** size * imp ** |
|
|
- formatting /usr/local/man/man1/latex2man.1 with groff and mandoc |
- formatting /usr/local/man/man1/latex2man.1 with groff and mandoc |
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 --------------------------------------------------------- |
--- PostScript and PDF issues ------------------------------------------ |
|
|
- PDF output doesn't use a monospaced font for .Bd -literal |
- PDF output doesn't use a monospaced font for .Bd -literal |
Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf". |
Example: "mandoc -Tpdf afterboot.8 > output.pdf && pdfviewer output.pdf". |
Line 400 are mere guesses, and some may be wrong. |
|
Line 411 are mere guesses, and some may be wrong. |
|
instructions from juanfra@ Wed, 11 Jun 2014 02:21:01 +0200 |
instructions from juanfra@ Wed, 11 Jun 2014 02:21:01 +0200 |
add a new <</Type /Font>> block to the PDF files with /BaseFont /Courier |
add a new <</Type /Font>> block to the PDF files with /BaseFont /Courier |
and change the /Name from /F0 to the new font (/F5 (?)). |
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 ** |
loc * exist ** algo ** size * imp ** |
|
|
--- HTML issues -------------------------------------------------------- |
--- HTML issues -------------------------------------------------------- |
|
|
|
- get rid of the last handful of style= attributes such that |
|
Content-Security-Policy: can be enabled without unsafe-inline |
|
suggested by bentley@ Nov 10, 2019 at 06:02:49AM -0700 |
|
loc * exist * algo * size * imp ** |
|
|
- .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal |
- .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal |
space, see for example random(3). Introduced in |
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 |
http://mdocml.bsd.lv/cgi-bin/cvsweb/mdoc_html.c.diff?r1=1.91&r2=1.92 |
Line 412 are mere guesses, and some may be wrong. |
|
Line 429 are mere guesses, and some may be wrong. |
|
|
|
- jsg on icb, Nov 3, 2014: |
- jsg on icb, Nov 3, 2014: |
try to guess Xr in man(7) for hyperlinking |
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 ** |
|
|
|
- space characters can end up in href= attributes, for example coming |
|
from the first .Xr argument (where they make no sense, but still); |
|
does this affect other characters, other source macros...? |
|
Jackson Pauls 29 Aug 2017 16:56:27 +0100 |
|
|
- The tables used to render the three-part page headers actually force |
- 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 width of the <body> to the max-width given for <html>. |
Not yet sure how to fix that... |
Not yet sure how to fix that... |
Line 420 are mere guesses, and some may be wrong. |
|
Line 445 are mere guesses, and some may be wrong. |
|
http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1 |
http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1 |
loc * exist * algo ** size * imp *** |
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 |
- generate <img> tags in HTML |
idea from florian@ Tue, 7 Apr 2015 00:26:28 +0000 |
idea from florian@ Tue, 7 Apr 2015 00:26:28 +0000 |
may be possible to implement with .Lk img://something.png alt_text |
may be possible to implement with .Lk img://something.png alt_text |
Line 465 are mere guesses, and some may be wrong. |
|
Line 487 are mere guesses, and some may be wrong. |
|
Probably, this should be fixed somewhere in termp_it_pre(), not sure. |
Probably, this should be fixed somewhere in termp_it_pre(), not sure. |
loc * exist ** algo ** size * imp ** |
loc * exist ** algo ** size * imp ** |
|
|
- .Nx 1.0a |
|
should be "NetBSD 1.0A", not "NetBSD 1.0a", |
|
see OpenBSD ccdconfig(8). |
|
loc * exist * algo * size * imp ** |
|
|
|
- In .Bl -tag, if a tag exceeds the right margin and must be continued |
|
on the next line, it must be indented by -width, not width+1; |
|
see "rule block|pass" in OpenBSD ifconfig(8). |
|
loc * exist *** algo ** size * imp ** |
|
|
|
- When the -width string contains macros, the macros must be rendered |
- When the -width string contains macros, the macros must be rendered |
before measuring the width, for example |
before measuring the width, for example |
.Bl -tag -width ".Dv message" |
.Bl -tag -width ".Dv message" |
Line 483 are mere guesses, and some may be wrong. |
|
Line 495 are mere guesses, and some may be wrong. |
|
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 |
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 *** |
loc *** exist *** algo *** size ** imp *** |
An easy partial fix would be to just skip the first word if it starts |
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. |
with a dot, including any following white space, when measuring. |
Line 493 are mere guesses, and some may be wrong. |
|
Line 506 are mere guesses, and some may be wrong. |
|
we want three blank lines, not two as in mandoc. |
we want three blank lines, not two as in mandoc. |
loc ** exist ** algo ** size * imp ** |
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 |
- Sequences of multiple man(7) paragraphs (.PP, .IP) interspersed |
with .ps and .nf/.fi produce execessive blank lines, see libJudy |
with .ps and .nf/.fi produce execessive blank lines, see libJudy |
and graphics/dcmtk. The parser reorg may help with this. |
and graphics/dcmtk. The parser reorg may help with this. |
Line 515 are mere guesses, and some may be wrong. |
|
Line 522 are mere guesses, and some may be wrong. |
|
* warning issues |
* warning issues |
************************************************************************ |
************************************************************************ |
|
|
- provide a way in mandoc(1) to warn about broken .Xr links; |
- warn about duplicate .Sh/.Ss heads |
probably cannot be on by default in -Tlint because it needs |
gre(4): Rename duplicate sections 20 Apr 2018 15:27:33 +0200 |
to access the manpath and mandoc.db(3) after parsing. |
|
asked for by jmc@ Fri, 4 Dec 2015 22:39:40 +0000 |
|
|
|
- Report errors in -O suboption parsing. |
|
loc * exist * algo * size * imp ** |
loc * exist * algo * size * imp ** |
|
|
|
- style message about macros inside .Bd -literal and .Dl, in particular |
|
font changing macros like .Cm, .Ar, .Fa (from the mdoclint TODO) |
|
|
|
- style message about mismatches between the section number in the |
|
file name (if it is known) and the section number in .Dt |
|
(from the mdoclint TODO) |
|
|
|
- style message about NULL without .Dv (from the mdoclint TODO) |
|
|
|
- style message about error constants without .Er (from the mdoclint TODO) |
|
|
- warn when .Sh or .Ss contain other macros |
- warn when .Sh or .Ss contain other macros |
Steffen Nurpmeso, savannah.gnu.org/bugs/index.php?45034 |
Steffen Nurpmeso, savannah.gnu.org/bugs/index.php?45034 |
loc * exist * algo * size * imp ** |
loc * exist * algo * size * imp ** |
|
|
- check that MANDOCERR_BADTAB is thrown in the right cases, |
- style message about violations of the convention |
i.e. when finding a literal tab character in fill mode, |
.An name Aq Mt localpart@domain in AUTHORS (from the mdoclint TODO) |
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 ** |
|
|
|
- warn about attempts to call non-callable macros |
- warn about attempts to call non-callable macros |
Steffen Nurpmeso Tue, 11 Nov 2014 22:55:16 +0100 |
Steffen Nurpmeso Tue, 11 Nov 2014 22:55:16 +0100 |
Line 543 are mere guesses, and some may be wrong. |
|
Line 552 are mere guesses, and some may be wrong. |
|
all over mdoc_macro.c and all subtly different. |
all over mdoc_macro.c and all subtly different. |
loc ** exist ** algo ** size ** imp ** |
loc ** exist ** algo ** size ** imp ** |
|
|
- warn about "new sentence, new line" |
- warn about punctuation - e.g. ',' and ';' - at the beginning |
loc ** exist ** algo *** size * imp ** |
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, |
- makewhatis -p complains about language subdirectories: |
but just the overall format |
/usr/local/man//ru: Unknown directory part |
loc ** exist ** algo *** size ** imp ** |
|
|
|
- integrate mdoclint into mandoc ("end-of-line whitespace" thread) |
|
from jmc@ Mon, 13 Jul 2009 17:12:09 +0100 |
|
from kristaps@ Mon, 13 Jul 2009 18:34:53 +0200 |
|
from jmc@ Mon, 13 Jul 2009 17:45:37 +0059 |
|
from kristaps@ Mon, 13 Jul 2009 19:02:03 +0200 |
|
(mostly done, check what remains) |
|
|
|
- -Tlint parser errors and warnings to stdout |
|
to tech@mdocml, naddy@ Wed, 28 Sep 2011 11:21:46 +0200 |
|
wait! kristaps@ Sun, 02 Oct 2011 17:12:52 +0200 |
|
|
|
************************************************************************ |
************************************************************************ |
* 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 |
- mark macros as: page structure domain, manual domain, general text domain |
is this useful? |
is this useful? |
|
|
Line 584 are mere guesses, and some may be wrong. |
|
Line 577 are mere guesses, and some may be wrong. |
|
* performance issues |
* performance issues |
************************************************************************ |
************************************************************************ |
|
|
- Why are we using MAP_SHARED, not MAP_PRIVATE for mmap(2)? |
|
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 |
************************************************************************ |
************************************************************************ |
Line 610 Several areas can be cleaned up to make mandoc even fa |
|
Line 590 Several areas can be cleaned up to make mandoc even fa |
|
Found by Aaron M. Ucko in the GNU Hurd via Bdale Garbee, |
Found by Aaron M. Ucko in the GNU Hurd via Bdale Garbee, |
https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=829624 |
https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=829624 |
|
|
- We use the input line number at several places to distinguish |
- Is it possible to further simplify ENDBODY_SPACE? |
same-line from different-line input. That plainly doesn't work |
|
with user-defined macros, leading to random breakage. |
|
|
|
- Find better ways to prevent endless loops |
- Find better ways to prevent endless loops |
in roff(7) macro and string expansion. |
in roff(7) macro and string expansion. |
|
|
- Finish cleanup of date handling. |
- make buffers for parsing functions const |
Decide which formats should be recognized where. |
christos@ via wiz@ Fri, 18 Dec 2015 17:10:01 +0100 |
Update both mdoc(7) and man(7) documentation. |
|
Triggered by Tim van der Molen Tue, 22 Feb 2011 20:30:45 +0100 |
|
|
|
- struct mparse refactoring |
- struct mparse refactoring |
Steffen Nurpmeso Thu, 04 Sep 2014 12:50:00 +0200 |
Steffen Nurpmeso Thu, 04 Sep 2014 12:50:00 +0200 |
Line 629 Several areas can be cleaned up to make mandoc even fa |
|
Line 605 Several areas can be cleaned up to make mandoc even fa |
|
* CGI issues |
* CGI issues |
************************************************************************ |
************************************************************************ |
|
|
|
- Inspect httpd(8) logs on man.openbsd.org and consider |
|
whether logging can be improved, where bad syntax comes from, |
|
and what needs to be done to get rid of COMPAT_OLDURI. |
- Enable HTTP compression by detecting gzip encoding and filtering |
- Enable HTTP compression by detecting gzip encoding and filtering |
output through libz. |
output through libz. |
- Sandbox (see OpenSSH). |
- Privilege separation (see OpenSSH). |
- Enable caching support via HTTP 304 and If-Modified-Since. |
- 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. |
|
|
|
************************************************************************ |
************************************************************************ |
* to improve in the groff_mdoc(7) macros |
* to improve in the groff_mdoc(7) macros |
************************************************************************ |
************************************************************************ |
|
|
|
- delete OS release verification from .Dx, .Fx, .Nx, .Ox etc. |
|
https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=629161 |
|
also Branden Robinson 18 Dec 2019 00:59:52 +1100 |
|
|
|
- Can the distinction between .Vt and .Va be made stricter, |
|
recommending .Vt extern char * Ns Va optarg ; ? |
|
What about the block macro properties of .Vt in the SYNOPSIS? |
|
zeurkous 25 Dec 2019 08:48:36 +0100 |
|
|
|
- .Cd # arch1, arch2 in section 4 pages: |
|
find better way to indicate multiple architectures, maybe: |
|
allow .Dt vgafb 4 "macppc sparc64" |
|
already shown as "Device Drivers Manual (macppc sparc64)" |
|
for apropos, make that "vgafb(4) - macppc # sparc64" instead of "- all" |
|
groff can be made to show multiple arches, too, but it is |
|
tedious to do the string parsing in roff code... |
|
jmc@ 23 Apr 2018 07:24:52 +0100 [man for vgafb(4)...] |
|
loc ** exist ** algo * size * imp *** |
|
|
- use uname(1) to set doc-default-operating-system at install time |
- use uname(1) to set doc-default-operating-system at install time |
tobimensch Mon, 1 Dec 2014 00:25:07 +0100 |
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? |