formatting is ugly
+ hints are easy to find on the web, e.g.
+ http://stackoverflow.com/questions/1713048/
+ see also matthew@ Fri, 18 Jul 2014 19:25:12 -0700
+ loc * exist * algo ** size * imp ***
+
+- In -man -Thtml, .nf does not preserve indentation.
+ It should either convert blanks to
+ or use rather than (like .Bd -literal does).
+ Reported by afresh1@ 12 Apr 2016 14:35:45 -0700
+
+- .Bf at the beginning of a paragraph inserts a bogus 1ex horizontal
+ 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
+ reported by deraadt@ Mon, 28 Sep 2015 20:14:13 -0600 (MDT)
+ loc ** exist ** algo ** size * imp *
+
+- jsg on icb, Nov 3, 2014:
+ try to guess Xr in man(7) for hyperlinking
+
+- The tables used to render the three-part page headers actually force
+ the width of the to the max-width given for .
+ Not yet sure how to fix that...
+ Observed by an Anonymous Coward on undeadly.org:
+ http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1
+ loc * exist * algo ** size * imp ***
+
+- consider whether
can be used for Ar Dv Er Ev Fa Va.
+ from bentley@ Wed, 13 Aug 2014 09:17:55 -0600
+
+- generate ![]()
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
+
************************************************************************
-* formatting issues: gratuitious differences
+* formatting issues: gratuitous differences
************************************************************************
-- .Rv (and probably .Ex) print different text if an `Nm' has been named
- or not (run a manual without `Nm blah' to see this). I'm not sure
- that this exists in the wild, but it's still an error.
+- .Fn reopens a new scope after punctuation in mandoc,
+ but closes its scope for good in groff.
+ Do we want to change mandoc or groff?
+ Steffen Nurpmeso Sat, 08 Nov 2014 13:34:59 +0100
+ loc * exist ** algo ** size * imp **
-- In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
- is just "o\bo".
- see for example OpenBSD ksh(1)
+- 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
+ loc * exist ** algo ** size * imp **
-- 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)
+- .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
+ reported again by sthen@ Wed, 18 Jan 2012 02:09:39 +0000 (UTC)
+ loc * exist *** algo ** size * imp **
-- 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).
+ loc * exist ** algo ** size * imp **
- 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
+ loc * exist ** algo ** size * imp **
+- 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.
+ 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
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 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
+ 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.
+ loc * exist * algo * size * imp ***
- 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.
+ loc ** exist ** algo ** size * imp **
-- 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 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
+ loc * exist * algo * size * imp *
-- 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).
+- 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.
-- 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).
-
-- In man(7), the sequence
- .SH HEADER
-
- .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
- .PP
- .RS
- indented text
- should produce one blank line between the regular and indented texts,
- see for example rsync(1), and
- .RE
-
- .PP
- .RS
- should produce two,not one blank lines.
- 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
-
-- 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
+ see for example
makes
\fBdig \fR
operate in batch mode
in dig(1).
+ loc ** exist ** algo ** size * imp **
************************************************************************
-* error reporting issues
+* warning issues
************************************************************************
+- provide a way in mandoc(1) to warn about broken .Xr links;
+ probably cannot be on by default in -Tlint because it needs
+ 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 **
+
+- warn when .Sh or .Ss contain other macros
+ Steffen Nurpmeso, savannah.gnu.org/bugs/index.php?45034
+ loc * exist * algo * size * imp **
+
+- check that MANDOCERR_BADTAB is thrown in the right cases,
+ i.e. when finding a literal tab character in fill mode,
+ 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
+ Steffen Nurpmeso Tue, 11 Nov 2014 22:55:16 +0100
+ Note that formatting is inconsistent in groff.
+ .Fn Po prints "Po()", .Ar Sh prints "file ..." and no "Sh".
+ Relatively hard because the relevant code is scattered
+ 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 **
+
+- 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
+************************************************************************
+
+- 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?
+
+- mention /usr/share/misc/mdoc.template in mdoc(7)?
+
+- Is all the content from http://www.std.com/obi/BSD/doc/usd/28.tbl/tbl
+ covered in tbl(7)?
+
+************************************************************************
* performance issues
************************************************************************
-Several areas can be cleaned up to make mandoc even faster. These are
+- 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
+- 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
************************************************************************
+- POSIX says in the documentation of sysconf(3) that PATH_MAX
+ 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
+ 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
+
+- struct mparse refactoring
+ Steffen Nurpmeso Thu, 04 Sep 2014 12:50:00 +0200
+
+************************************************************************
+* CGI issues
+************************************************************************
+
+ - Enable HTTP compression by detecting gzip encoding and filtering
+ 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.
+
+************************************************************************
+* to improve in the groff_mdoc(7) macros
+************************************************************************
+
+- use uname(1) to set doc-default-operating-system at install time
+ tobimensch Mon, 1 Dec 2014 00:25:07 +0100