version 1.11, 2010/05/31 15:42:09 |
version 1.125, 2011/11/17 17:41:07 |
|
|
************************************************************************ |
************************************************************************ |
|
* Official mandoc TODO. |
|
* $Id$ |
|
************************************************************************ |
|
|
|
************************************************************************ |
|
* parser bugs |
|
************************************************************************ |
|
|
|
- ".\}" on its own line gets translated to bare ".\&" |
|
which forces pset() into man(7) |
|
and then triggers an unknown macro error |
|
reported by naddy@ Sun, 3 Jul 2011 21:52:24 +0200 |
|
|
|
- .It is parsed in general, except in .Bl -diag |
|
deraadt@ Mon, 07 Nov 2011 11:10:52 -0700 |
|
|
|
************************************************************************ |
|
* formatter bugs |
|
************************************************************************ |
|
|
|
- tbl(7): Horizontal and vertical lines are formatted badly: |
|
With the box option, there is too much white space at the end of cells. |
|
Horizontal lines from "=" lines are a bit too long. |
|
yuri dot pankov at gmail dot com Thu, 14 Apr 2011 05:45:26 +0400 |
|
|
|
************************************************************************ |
* missing features |
* missing features |
************************************************************************ |
************************************************************************ |
|
|
- explicit blocks with missing end macro should be implicitely closed |
--- missing roff features ---------------------------------------------- |
at the end of the enclosing block, e.g. .Bl It (El) Sh |
|
reminded by stsp@ in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200 |
|
|
|
|
- .if n \{ |
|
.br\} |
|
should cause an extra space to be raised. |
|
|
|
- .ad (adjust margins) |
|
.ad l -- adjust left margin only (flush left) |
|
.ad r -- adjust right margin only (flush right) |
|
.ad c -- center text on line |
|
.ad b -- adjust both margins (alias: .ad n) |
|
.na -- temporarily disable adjustment without changing the mode |
|
.ad -- re-enable adjustment without changing the mode |
|
Adjustment mode is ignored while in no-fill mode (.nf). |
|
|
|
- .it (line traps) occur in mysql(1), yasm_arch(7) |
|
generated by DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/> |
|
reported by brad@ Sat, 15 Jan 2011 15:48:18 -0500 |
|
|
|
- .ns (no-space mode) occurs in xine-config(1) |
|
reported by brad@ Sat, 15 Jan 2011 15:45:23 -0500 |
|
|
|
- xloadimage(1) wants .ti (temporary indent), rep by naddy@ |
|
|
|
- .ta (tab settings) occurs in ircbug(1) and probably gnats(1) |
|
reported by brad@ Sat, 15 Jan 2011 15:50:51 -0500 |
|
|
|
- \c (interrupted text) occurs in chat(8) |
|
|
|
- using undefined strings or macros defines them to be empty |
|
wl@ Mon, 14 Nov 2011 14:37:01 +0000 |
|
|
|
--- missing mdoc features ---------------------------------------------- |
|
|
|
- fix bad block nesting involving multiple identical explicit blocks |
|
see the OpenBSD mdoc_macro.c 1.47 commit message |
|
|
- .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 |
|
|
lib/libc/gen/signal.3 |
lib/libc/gen/signal.3 |
lib/libc/sys/sigaction.2 |
lib/libc/sys/sigaction.2 |
|
|
- .Bk / .Ek is broken, e.g. |
- edge case: decide how to deal with blk_full bad nesting, e.g. |
$ man ssh |
.Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1) |
[...] |
from jmc@ Wed, 14 Jul 2010 18:10:32 +0100 |
ssh [-1246AaCfgKkMNnqsTtVvXxYy] [-b bind_address] [-c cipher_spec] [-D |
|
[bind_address:]port] [-e escape_char] [-F configfile] [-I pkcs11] |
|
reminded by Ludo Smissaert Mon, 10 May 2010 12:15:11 +0200 |
|
also reported by jmc@ earlier |
|
|
|
- implement \\ |
- \\ is now implemented correctly |
in plain text, identical to \e |
* when defining strings and macros using .ds and .de |
as a macro argument, identical to \ i.e. escaping the next character |
* when parsing roff(7) and man(7) macro arguments |
We do not have macro definitions yet; if we implement them, |
It does not yet work in mdoc(7) macro arguments |
\\ must behave in a macro def like in a macro argument, |
because libmdoc does not yet use mandoc_getarg(). |
and when using the macro, it must expand yet again. |
Also check what happens in plain text, it must be identical to \e. |
|
|
- look at bsd.lv tbl(1) |
- .Bd -filled should not be the same as .Bd -ragged, but align both |
from kristaps@ Fri, 11 Sep 2009 17:10:53 +0200 |
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). |
|
|
- 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 |
|
roff stuff. Figure out to what extent we can cope. |
|
noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200 |
|
reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100 |
|
|
|
|
|
- FIXED OpenBSD term.h 1.16 term.c 1.30 mdoc_term.c 1.75 schwarze 23.4.10 |
|
handle tab characters outside literal context, e.g. usb(4) |
|
reported by jmc@ Mon, 19 Apr 2010 07:42:12 +0100 |
|
NEEDS MERGING TO bsd.lv |
|
|
|
- FIXED OpenBSD man.h 1.15 libman.h 1.16 man_hash.c 1.9 |
|
man.c 1.25 man_macro.c 1.15 man_validate.c 1.19 man_action.c 1.15 |
|
man_term.c 1.28 man_html.c 1.9 schwarze 25.4. |
|
implement .if .ie .el |
|
noticed by espie@ Fri, 23 Apr 2010 17:10:35 +0200 |
|
NEEDS MERGING TO bsd.lv |
|
|
|
- implement blank `Bl -column', such as |
- implement blank `Bl -column', such as |
.Bl -column |
.Bl -column |
.It foo Ta bar |
.It foo Ta bar |
|
|
|
|
- explicitly disallow nested `Bl -column', which would clobber internal |
- explicitly disallow nested `Bl -column', which would clobber internal |
flags defined for struct mdoc_macro |
flags defined for struct mdoc_macro |
|
|
|
- In .Bl -column .It, the end of the line probably has to be regarded |
|
as an implicit .Ta, if there could be one, see the following mildly |
|
ugly code from login.conf(5): |
|
.Bl -column minpasswordlen program xetcxmotd |
|
.It path Ta path Ta value of Dv _PATH_DEFPATH |
|
.br |
|
Default search path. |
|
reported by Michal Mazurek <akfaew at jasminek dot net> |
|
via jmc@ Thu, 7 Apr 2011 16:00:53 +0059 |
|
|
|
- inside `.Bl -column' phrases, punctuation is handled like normal |
|
text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -." |
|
|
|
- inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf' |
|
is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab." |
|
but should give "ab ." |
|
|
|
- set a meaningful default if no `Bl' list type is assigned |
|
|
|
- have a blank `It' head for `Bl -tag' not puke |
|
|
|
- prohibit `Nm' from having non-text HEAD children |
|
(e.g., NetBSD mDNSShared/dns-sd.1) |
|
(mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified) |
|
|
|
- When there is free text in the SYNOPSIS and that free text contains |
|
the .Nm macro, groff somehow understands to treat the .Nm as an in-line |
|
macro, while mandoc treats it as a block macro and breaks the line. |
|
No idea how the logic for distinguishing in-line and block instances |
|
should be, needs investigation. |
|
uqs@ Thu, 2 Jun 2011 11:03:51 +0200 |
|
uqs@ Thu, 2 Jun 2011 11:33:35 +0200 |
|
|
|
--- 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 |
|
|
|
- -T[x]html doesn't stipulate non-collapsing spaces in literal mode |
|
|
|
--- missing tbl features ----------------------------------------------- |
|
|
|
- implement basic non-parametric .de to support e.g. sox(1) |
|
reported by naddy@ Sat, 16 Oct 2010 23:51:57 +0200 |
|
*** sox(1) still doesn't work, tbl(1) errors need investigation |
|
|
|
- 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 |
|
|
|
--- missing misc features ---------------------------------------------- |
|
|
|
- clean up escape sequence handling, creating three classes: |
|
(1) fully implemented, or parsed and ignored without loss of content |
|
(2) unimplemented, potentially causing loss of content |
|
or serious mangling of formatting (e.g. \n) -> ERROR |
|
see textproc/mgdiff(1) for nice examples |
|
(3) undefined, just output the character -> perhaps WARNING |
|
|
|
- The \t escape sequence is the same as a literal tab, see for example |
|
the ASCII table in hexdump(1) where |
|
.Bl -column \&000_nu \&001_so \&002_st \&003_et \&004_eo |
|
.It \&000\ nul\t001\ soh\t002\ stx\t003\ etx\t004\ eot\t005\ enq |
|
produces |
|
000 nul 001 soh 002 stx 003 etx 004 eot 005 enq |
|
and the example in oldrdist(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 |
|
roff stuff. Figure out to what extent we can cope. |
|
For details, see http://docutils.sourceforge.net/rst.html |
|
noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200 |
|
reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100 |
|
|
|
- check compatibility with Plan9: |
|
http://swtch.com/usr/local/plan9/tmac/tmac.an |
|
http://swtch.com/plan9port/man/man7/man.html |
|
"Anthony J. Bentley" <anthonyjbentley@gmail.com> 28 Dec 2010 21:58:40 -0700 |
|
|
************************************************************************ |
************************************************************************ |
* formatting issues: ugly output |
* formatting issues: ugly output |
************************************************************************ |
************************************************************************ |
|
|
- outside list context, text following .Sm off |
- a column list with blank `Ta' cells triggers a spurrious |
seems to follow without a blank (TERM_NOBLANK reset late?) e.g. |
start-with-whitespace printing of a newline |
.Sm off |
|
.Xo |
|
.Op Ar bind_address No / |
|
.Ar port |
|
.Xc |
|
.Sm on |
|
or by enclosing |
|
reported by jmc Tue, 13 Apr 2010 08:48:14 +0100 |
|
|
|
- do not break the line after "--", it's probably a long option |
- double quotes inside double quotes are escaped by doubling them |
reminded by stsp in net/pptp pptp.8 Fri, 23 Apr 2010 20:32:39 +0200 |
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 |
|
|
- URGENT, this is making many kernel manuals look bad: |
- perl(1) SYNOPSIS looks bad; reported by deraadt@ |
.Ft/.Fn should MAYBE behave in custom section like in SYNOPSIS? |
1) man(7) seems to need SYNOPSIS .Nm blocks, too |
autoconf.9: |
|
.Sh DIRECT CONFIGURATION |
|
.nr nS 1 |
|
.Ft "struct device *" |
|
.Fn config_found_sm "struct device *parent" |
|
groff: |
|
DIRECT CONFIGURATION |
|
struct device * |
|
config_found_sm(struct device *parent, ... |
|
reported by sthen Tue, 20 Apr 2010 13:42:51 +0100 |
|
|
|
- indentation got lost in SYNOPSIS, e.g. |
- In .Bl -column, |
SYNOPSIS |
.It Em Authentication<tab>Key Length |
date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format] |
ought to render "Key Length" with emphasis, too, |
- [[[[[[cc]yy]mm]dd]HH]MM[.SS]] |
see OpenBSD iked.conf(5). |
+ [[[[[[cc]yy]mm]dd]HH]MM[.SS]] |
reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200 |
reminded by Ludo Smissaert Mon, 10 May 2010 12:15:11 +0200 |
|
|
|
- empty phrases in .Bl column produce too few blanks |
- empty phrases in .Bl column produce too few blanks |
try e.g. .Bl -column It Ta Ta |
try e.g. .Bl -column It Ta Ta |
reported by millert Fri, 02 Apr 2010 16:13:46 -0400 |
reported by millert Fri, 02 Apr 2010 16:13:46 -0400 |
|
|
- nroff inserts a space before :, mandoc doesn't: |
- .%T can have trailing punctuation. Currently, it puts the trailing |
.Dl expr "/$a" Li : '.*/\e(.*\e)' |
punctuation into a trailing MDOC_TEXT element inside its own scope. |
|
That element should rather be outside its scope, such that the |
|
punctuation does not get underlines. This is not trivial to |
|
implement because .%T then needs some features of in_line_eoln() - |
|
slurp all arguments into one single text element - and one feature |
|
of in_line() - put trailing punctuation out of scope. |
|
Found in mount_nfs(8) and exports(5), search for "Appendix". |
|
|
|
- in enclosures, mandoc sometimes fancies a bogus end of sentence |
|
reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059 |
|
|
************************************************************************ |
************************************************************************ |
* formatting issues: gratuitious differences |
* formatting issues: gratuitous differences |
************************************************************************ |
************************************************************************ |
|
|
- FIXED OpenBSD mdoc.c 1.52 schwarze 16.5.10 |
- .Rv (and probably .Ex) print different text if an `Nm' has been named |
lines containing blank characters, and nothing else, |
or not (run a manual without `Nm blah' to see this). I'm not sure |
in literal context (.Bd -literal): |
that this exists in the wild, but it's still an error. |
groff outputs just blank lines "\n" |
|
mandoc outputs blanks to the left margin, |
|
then the number of balnks minus one |
|
NEEDS MERGING TO bsd.lv |
|
|
|
|
- In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet |
|
is just "o\bo". |
|
see for example OpenBSD ksh(1) |
|
|
|
- The characters "|" and "\*(Ba" should never be bold, |
|
not even in the middle of a word, e.g. ".Cm b\*(Bac" in |
|
"mknod [-m mode] name b|c major minor" |
|
in OpenBSD ksh(1) |
|
|
|
- A bogus .Pp between two .It must not produce a double blank line, |
|
see between -R and -r in OpenBSD rm(1), before "update" in mount(8), |
|
or in DIAGNOSTICS in init(8), or before "is always true" in ksh(1). |
|
The same happens with .Pp just before .El, see bgpd.conf(5). |
|
Also have `It' complain if `Pp' is invoked at certain times (not |
|
-compact?). |
|
|
|
- .Pp between two .It in .Bl -column should produce one, |
|
not two blank lines, see e.g. login.conf(5). |
|
reported by jmc@ Sun, 17 Apr 2011 14:04:58 +0059 |
|
|
|
- If the *first* line after .It is .Pp, break the line right after |
|
the tag, do not pad with space characters before breaking. |
|
See the description of the a, c, and i commands in sed(1). |
|
|
|
- If the first line after .It is .D1, do not assert a blank line |
|
in between, see for example tmux(1). |
|
reported by nicm@ 13 Jan 2011 00:18:57 +0000 |
|
|
|
- .Nx 1.0a |
|
should be "NetBSD 1.0A", not "NetBSD 1.0a", |
|
see OpenBSD ccdconfig(8). |
|
|
|
- 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). |
|
|
|
- When the -width string contains macros, the macros must be rendered |
|
before measuring the width, for example |
|
.Bl -tag -width ".Dv message" |
|
in magic(5), located in src/usr.bin/file, is the same |
|
as -width 7n, not -width 11n. |
|
|
|
- The \& zero-width character counts as output. |
|
That is, when it is alone on a line between two .Pp, |
|
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" |
|
|
|
- .Ns should work when called at the end of an input line, see |
|
the following code in vi(1): |
|
.It Xo |
|
.Op Ar line |
|
.Cm a Ns Op Cm ppend Ns |
|
.Op Cm !\& |
|
.Xc |
|
The input text is appended after the specified line. |
|
|
|
- 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 |
|
|
|
- In man(7), the sequence |
|
.HP |
|
one line of regular text |
|
.SH |
|
should not produce two blank lines before the .SH, |
|
see for example named-checkconf(8). |
|
|
|
- In man(7), the sequence |
|
.SH HEADER |
|
<blank line> |
|
.PP |
|
regular text |
|
should not produce any blank lines between the header and the text, |
|
see for example rsync(1). |
|
Reported by naddy@ Mon, 28 Mar 2011 20:45:42 +0200 |
|
|
|
- In man(7), the sequence |
|
regular text |
|
.IP |
|
.IP "tag" |
|
indented text |
|
should produce one, not four blank lines between the regular text |
|
and the tag, see for example rsync(1). |
|
Likewise, |
|
regular text |
|
.IP |
|
indented text |
|
should produce one, not two blank lines in between, and |
|
regular text |
|
.IP |
|
.RS |
|
.IP tag |
|
indented text |
|
should produce one, not three blank lines. |
|
Reported by naddy@ Mon, 28 Mar 2011 20:45:42 +0200 |
|
|
|
- trailing whitespace must be ignored even when followed by a font escape, |
|
see for example |
|
makes |
|
\fBdig \fR |
|
operate in batch mode |
|
in dig(1). |
|
|
************************************************************************ |
************************************************************************ |
* parser errors without any effect on formatting |
* error reporting issues |
************************************************************************ |
************************************************************************ |
|
|
- OpenBSD::PackageName(3p) has "if (block) 90:1" in the parse tree |
|
|
|
************************************************************************ |
************************************************************************ |
* performance issues |
* performance issues |
************************************************************************ |
************************************************************************ |
|
|
Several areas can be cleaned up to make mandoc even faster. These are |
Several areas can be cleaned up to make mandoc even faster. These are |
|
|
- cache `Bd' display types as `Bl' types are cached (this primarily |
|
improves code-size by removing the a2disp type functions) |
|
|
|
- improve caching mechanism to handle other per-element arguments so |
|
that they need not be recalculated between front- and back-ends (also |
|
reduces code size and complexity) |
|
|
|
- improve hashing mechanism for macros (quite important: performance) |
- improve hashing mechanism for macros (quite important: performance) |
|
|
- improve hashing mechanism for characters (not as important) |
- 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 |
|
|
|
************************************************************************ |
|
* structural issues |
|
************************************************************************ |
|
|
|
- We use the input line number at several places to distinguish |
|
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 |
|
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. |
|
Triggered by Tim van der Molen Tue, 22 Feb 2011 20:30:45 +0100 |