mandoc/TODO - diff

Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/TODO between version 1.85 and 1.164

version 1.85, 2011/01/25 15:17:18

version 1.164, 2014/02/14 23:05:20

Line 4

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

* parser bugs

* crashes

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

- .TP before .SH is still FATAL in man(7)

None known.

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

- The mdoc(7) parser should handle `\.' as punctuation:

.Ql .if ${VAR} op something \.

should produce

`.if ${VAR} op something'.

not

`.if ${VAR} op something .'

as seen in make(1).

To escape the dot, one would use `\&.'.

- the roff parser doesn't tolerate additional characters between

a macro and the \} terminating a conditional block, e.g.

.if n \{

.br \}

reported by ulrich spoerlein Tue, 19 Oct 2010 20:39:50 +0200

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

* formatter bugs

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

* missing features

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

Line 44

Line 24

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

- .ce (center N lines)

generated by DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>

found by naddy@ in xloadimage(1)

reported by brad@ Sat, 15 Jan 2011 15:48:18 -0500

found by Juan Francisco Cantero Hurtado <iam at juanfra dot info>

in lang/racket(1) Thu, 20 Jun 2013 03:19:11 +0200

- .fc (field control)

found by naddy@ in xloadimage(1)

- .ll (line length)

found by naddy@ in textproc/enchant(1) Sat, 12 Oct 2013 03:27:10 +0200

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

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

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

- pod2man expects `tr' to be implemented for \*(-- to work

- .ti (temporary indent)

found by naddy@ in xloadimage(1)

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

- \c (interrupted text) occurs in chat(8)

- .while and .shift

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

- \c (interrupted text) should prevent the line break

even inside .Bd literal; that occurs in chat(8)

also found in cclive(1) - DocBook output

- \h horizontal move

found in cclive(1) DocBook output

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

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

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

- 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

Line 95

Line 100

- explicitly disallow nested `Bl -column', which would clobber internal

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

Line 110

Line 125

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

- bashbug(1) complains "line scope broken" after

.SM

.B something

should either just work or be a warning

reported by naddy@

- groff an-ext.tmac macros (.UR, .UE) occur in xine(5)

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

also occur in freeciv-client(6) freeciv-server(6) freeciv-modpack(6)

reported by bentley@ Tue, 30 Oct 2012 01:05:57 -0600

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

- italic correction (\/) in PostScript mode

Werner LEMBERG on groff at gnu dot org Sun, 10 Nov 2013 12:47:46

- The whatis(1) utility looks for whole words in Nm.

If the file name of a page does not agree with the contents of any

of its Nm macros (e.g. pool(9)), add the file name as an Nm entry

to the mandoc.db as well, such that whatis(1) finds it.

If there is a page with a file name that does not appear as a substring

neither in Nm nor in Nd, the same fix would allow finding that page

with apropos(1) using the file name as a key, as well.

Issue reported by tedu@ Fri, 05 Jul 2013 21:15:23 -0400

- 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

Line 136

Line 173

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.

Line 151

Line 180

noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200

reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100

- look at pages generated from Texinfo source by yat2m, e.g. security/gnupg

First impression is not that bad.

- check compatibility with Plan9:

http://swtch.com/usr/local/plan9/tmac/tmac.an

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

Line 160

Line 192

* formatting issues: ugly output

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

- double quotes inside double quotes are escaped by doubling them

- a column list with blank `Ta' cells triggers a spurrious

implement this in mdoc(7), too

start-with-whitespace printing of a newline

so far, we only have it in roff(7) and man(7)

reminded by millert@ Thu, 09 Dec 2010 17:29:52 -0500

- perl(1) SYNOPSIS looks bad; reported by deraadt@

1) man(7) seems to need SYNOPSIS .Nm blocks, too

- In .Bl -column,

.It Em Authentication<tab>Key Length

ought to render "Key Length" with emphasis, too,

see OpenBSD iked.conf(5).

reported again Nicolas Joly via wiz@ Wed, 12 Oct 2011 00:20:00 +0200

- empty phrases in .Bl column produce too few blanks

try e.g. .Bl -column It Ta Ta

Line 186

Line 214

of in_line() - put trailing punctuation out of scope.

Found in mount_nfs(8) and exports(5), search for "Appendix".

- Trailing punctuation after .%T triggers EOS spacing, at least

outside .Rs (eek!). Simply setting ARGSFL_DELIM for .%T is not

the right solution, it sends mandoc into an endless loop.

reported by Nicolas Joly Sat, 17 Nov 2012 11:49:54 +0100

- in enclosures, mandoc sometimes fancies a bogus end of sentence

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

- 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

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

* formatting issues: gratuitious differences

* formatting issues: gratuitous differences

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

- .Rv (and probably .Ex) print different text if an `Nm' has been named

Line 201

Line 238

is just "o\bo".

see for example OpenBSD ksh(1)

- The characters "|" and "\*(Ba" should never be bold,

- .Pp between two .It in .Bl -column should produce one,

not even in the middle of a word, e.g. ".Cm b\*(Bac" in

not two blank lines, see e.g. login.conf(5).

"mknod [-m mode] name b|c major minor"

reported by jmc@ Sun, 17 Apr 2011 14:04:58 +0059

in OpenBSD ksh(1)

reported again by sthen@ Wed, 18 Jan 2012 02:09:39 +0000 (UTC)

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

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

Line 221

Line 251

in between, see for example tmux(1).

reported by nicm@ 13 Jan 2011 00:18:57 +0000

- Trailing punctuation after .It should trigger EOS spacing.

reported by Nicolas Joly Sat, 17 Nov 2012 11:49:54 +0100

Probably, this should be fixed somewhere in termp_it_pre(), not sure.

- .Nx 1.0a

should be "NetBSD 1.0A", not "NetBSD 1.0a",

see OpenBSD ccdconfig(8).

- The space character joining .Dx .Fx .Nx .Ox (are these all?) to its

argument is non-breaking. See the cdio(1) HISTORY and many others.

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

Line 237

Line 268

.Bl -tag -width ".Dv message"

in magic(5), located in src/usr.bin/file, is the same

as -width 7n, not -width 11n.

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

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.

- 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

- .Ns should only be effective when called by another macro,

not as a stand-alone macro at the beginning of a line;

see for example the awk(1) SYNOPSIS.

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

regular text

.RS

.IP

should have a blank line between the text and the beginning of the

indented paragraph, see for example sudo(1).

- At least sometimes, .sp is ignored right after .SH; see named.conf(5).

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

see for example

makes

Line 288

Line 291

in dig(1).

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

* error reporting issues

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

* performance issues

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

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

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

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

* 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

CVSweb