]> git.cameronkatri.com Git - mandoc.git/log
mandoc.git
4 years agoPut the code handling \} into a new function roff_cond_checkend()
Ingo Schwarze [Mon, 3 Aug 2020 11:02:57 +0000 (11:02 +0000)]
Put the code handling \} into a new function roff_cond_checkend()
and call that function not only from both places where copies
existed - when processing text lines and when processing request/macro
lines in conditional block scope - but also when closing a macro
definition request, such that this construction works:

.if n \{.de macroname
macro content
.. \} ignored arguments
.macroname

This fixes a bug reported by John Gardner <gardnerjohng at gmail dot com>.

While here, avoid a confusing decrement of the line scope counter
in roffnode_cleanscope() for conditional blocks that do not have
line scope in the first place (no functional change for this part).
Also improve validation of an internal invariant in roff_cblock()
and polish some comments.

4 years agotrivial sync with OpenBSD
Ingo Schwarze [Thu, 30 Jul 2020 21:42:27 +0000 (21:42 +0000)]
trivial sync with OpenBSD
in parts of these files that are not used by -portable;
consequently, no functional change

4 years agotrivial adjustment of the desired test results
Ingo Schwarze [Tue, 21 Jul 2020 15:17:21 +0000 (15:17 +0000)]
trivial adjustment of the desired test results
after getting rid of the "copyless" crutch

4 years agoadjust test framework to not require a tty
Ingo Schwarze [Tue, 21 Jul 2020 15:14:20 +0000 (15:14 +0000)]
adjust test framework to not require a tty

4 years agoundocumented options -O outfilename and -O tagfilename
Ingo Schwarze [Tue, 21 Jul 2020 15:10:01 +0000 (15:10 +0000)]
undocumented options -O outfilename and -O tagfilename
to support regression testing without a tty;
no user visible change intended

4 years agoSwitch the default pager from "more -s" to "less".
Ingo Schwarze [Mon, 20 Jul 2020 16:57:29 +0000 (16:57 +0000)]
Switch the default pager from "more -s" to "less".

POSIX explicitly allows using a different default pager if that is
documented.  Nowadays, the pager provided in most operating systems
is less(1).  Our man(1) implementation uses less(1) features that
traditional more(1) did not provide, in particular tagging.  Besides,
as noted by deraadt@, the user interface of less(1) is slightly
more refined and preferable over the user inferface of more(1).
This switch was originally suggested by Ian Ropers.

In ./configure, test whether less(1) is available.  If not, fall
back to more(1).  In ./configure.local, support overriding the
automatic test by setting BINM_PAGER.

As explained by jmc@ and deraadt@, the -s flag was added a very
long time ago when an antique version of groff(1) had an annoying
bug in terminal output that would randomly display blank lines in
the middle of pages.  Clearly, -s has no longer been needed for
many years, so drop it from the default pager invocation.

OK deraadt@ jmc@ martijn@ job@ on the OpenBSD version of this patch.

4 years agoSupport the "powerpc64" architecture name.
Ingo Schwarze [Mon, 29 Jun 2020 19:22:09 +0000 (19:22 +0000)]
Support the "powerpc64" architecture name.
The first file using it in .Dt was just committed by kettenis@.

4 years agoBriefly mention groff_mdoc(7) below SEE ALSO. While both authoritative
Ingo Schwarze [Thu, 25 Jun 2020 20:45:09 +0000 (20:45 +0000)]
Briefly mention groff_mdoc(7) below SEE ALSO.  While both authoritative
manual pages document the same content, comparing can occasionally help
in cases of doubt, and some people may prefer one style, some the other.
While here, modernize a few .Lks from http:// to https://.
OK jmc@

4 years agomore details about ASCII control characters
Ingo Schwarze [Wed, 24 Jun 2020 12:09:29 +0000 (12:09 +0000)]
more details about ASCII control characters

4 years agoProvide a real feature test for __attribute__().
Ingo Schwarze [Mon, 22 Jun 2020 20:00:38 +0000 (20:00 +0000)]
Provide a real feature test for __attribute__().
Looking at version numbers like __GNUC__ is always a bad idea.
Believe it or not, this even makes ./configure shorter by one line.

4 years agoBecause mandoc_aux.h and mandoc.h use __attribute__, all files that
Ingo Schwarze [Mon, 22 Jun 2020 19:20:40 +0000 (19:20 +0000)]
Because mandoc_aux.h and mandoc.h use __attribute__, all files that
include mandoc_aux.h or mandoc.h need to include config.h, too.
It is suspected that for example IRIX needs this, or it is likely
to throw errors in these files because the system compiler doesn't
understand __attribute__.
Issue reported by Kazuo Kuroi <kazuo at irixnet dot org>.

4 years agoJohn Gardner: handling of ASCII control characters during input
Ingo Schwarze [Mon, 22 Jun 2020 18:00:30 +0000 (18:00 +0000)]
John Gardner: handling of ASCII control characters during input

4 years agoManually tag the section option.
Ingo Schwarze [Wed, 17 Jun 2020 19:42:32 +0000 (19:42 +0000)]
Manually tag the section option.
Automatic tagging does not work because the [-s] flag is optional.
Patch from Martin Vahlensieck.

4 years agoSync stringlist implementation with NetBSD.
Ingo Schwarze [Mon, 15 Jun 2020 21:48:09 +0000 (21:48 +0000)]
Sync stringlist implementation with NetBSD.
Various improvements of security, functionality, and style.

4 years agosync with OpenBSD, no functional change intended
Ingo Schwarze [Mon, 15 Jun 2020 20:49:57 +0000 (20:49 +0000)]
sync with OpenBSD, no functional change intended

4 years agoupdate millert@'s email address
Ingo Schwarze [Mon, 15 Jun 2020 20:19:39 +0000 (20:19 +0000)]
update millert@'s email address

4 years agodocument -T html -O tag as implemented in main.c rev. 1.350
Ingo Schwarze [Mon, 15 Jun 2020 18:05:18 +0000 (18:05 +0000)]
document -T html -O tag as implemented in main.c rev. 1.350

4 years agoSupport -T html -O tag by passing a file:// URI to the pager.
Ingo Schwarze [Mon, 15 Jun 2020 17:25:42 +0000 (17:25 +0000)]
Support -T html -O tag by passing a file:// URI to the pager.
Feature suggested by and implementation based on a patch
from Abel Romero Perez <romeroperezabel at gmail dot com>.

4 years agoadd missing compat_stringlist.o to ALL_COBJS, useful for make clean
Ingo Schwarze [Mon, 15 Jun 2020 16:58:24 +0000 (16:58 +0000)]
add missing compat_stringlist.o to ALL_COBJS, useful for make clean

4 years agoOnly compile compat_*.c implementations that are actually needed.
Ingo Schwarze [Mon, 15 Jun 2020 01:37:14 +0000 (01:37 +0000)]
Only compile compat_*.c implementations that are actually needed.
That's cleaner and it is supposed to fix compiler warnings with gcc 10
reported by Wynn Wolf Arbor <wolf at oriole dot systems> on discuss@.

4 years agoMake the ./configure script simpler, more robust, and 23 lines shorter:
Ingo Schwarze [Sun, 14 Jun 2020 23:40:31 +0000 (23:40 +0000)]
Make the ./configure script simpler, more robust, and 23 lines shorter:
* three rather than four arguments for singletest()
* let runtest() support testing two variants of compiler flags
* always report a failed test, even when another test follows
* run all tests before detecting fatal conditions
* rename HAVE_CMSG_XPG42 to NEED_XPG4_2 for consistency
* consistently use braces for shell variable interpolation
* drop archaic "X${" syntax and unusual "==" in string comparisons

4 years agomerge rev. 1.58 from OpenBSD (deraadt@):
Ingo Schwarze [Sun, 14 Jun 2020 23:08:35 +0000 (23:08 +0000)]
merge rev. 1.58 from OpenBSD (deraadt@):
recallocarray() the string buffer, to avoid leaving such contents
around in the address space.  Don't bother doing so for the buffer
which contains aslr'd pointers...
OK millert@

4 years agoGive the fts_compar struct member a real prototype.
Ingo Schwarze [Sun, 14 Jun 2020 22:49:36 +0000 (22:49 +0000)]
Give the fts_compar struct member a real prototype.
This adds clarity and avoids compiler warnings.

4 years agoFix a regression in rev. 1.319 (2019/03/03):
Ingo Schwarze [Sun, 14 Jun 2020 16:24:18 +0000 (16:24 +0000)]
Fix a regression in rev. 1.319 (2019/03/03):
Pass the right object to html_reset() or it will crash
when rendering more than one manual page to HTML in a row.
Bug reported by Abel Romero Perez <romeroperezabel at gmail dot com>.
Patch from otto@.

4 years agoWhile we do not recommend the idiom ".Fl Fl long" for long options
Ingo Schwarze [Sun, 26 Apr 2020 21:41:07 +0000 (21:41 +0000)]
While we do not recommend the idiom ".Fl Fl long" for long options
because it is an abuse of semantic macros for device-specific
presentational effects, this idiom is so widespread that it makes
sense to convert it to the recommended ".Fl \-long" during the
validation phase.  For example, this improves HTML formatting
in pages where authors have used the dubious .Fl Fl.

Feature suggested by Steffen Nurpmeso <steffen at sdaoden dot eu>
on freebsd-hackers.

4 years agoResurrect the documentation of the print_otag() 's' attribute specifier,
Ingo Schwarze [Fri, 24 Apr 2020 13:13:06 +0000 (13:13 +0000)]
Resurrect the documentation of the print_otag() 's' attribute specifier,
reverting a minor part of rev. 1.21.  Contrary to what i thought, that
attribute *is* still supported for a small number of unusual cases.

4 years agoprovide a STYLE message when mandoc knows the file name and the extension
Ingo Schwarze [Fri, 24 Apr 2020 12:02:33 +0000 (12:02 +0000)]
provide a STYLE message when mandoc knows the file name and the extension
disagrees with the section number given in the .Dt or .TH macro;
feature suggested and patch tested by jmc@

4 years agoIn fragment identifiers, use ~%d for ordinal suffixes,
Ingo Schwarze [Mon, 20 Apr 2020 13:07:24 +0000 (13:07 +0000)]
In fragment identifiers, use ~%d for ordinal suffixes,
and reserve the character '~' for that purpose.

Bug found by validator.w3.org in openssl(1), which contains both a
tag "tls1_2" and a second instance of a tag "tls1", which also resulted
in "tls1_2", causing a clash.  Now, the second instance of "tls1" is
rendered as "tls1~2" instead, employing the newly reserved '~'.

4 years agoWhen .Bd, .D1, or .Dl is tagged, attach the permalink
Ingo Schwarze [Sun, 19 Apr 2020 16:36:16 +0000 (16:36 +0000)]
When .Bd, .D1, or .Dl is tagged, attach the permalink
to the first few letters, similar to what was earlier done for .Pp.

4 years agoCorrectly handle non-unique tags even when NODE_ID and NODE_HREF fall
Ingo Schwarze [Sun, 19 Apr 2020 15:16:56 +0000 (15:16 +0000)]
Correctly handle non-unique tags even when NODE_ID and NODE_HREF fall
apart, NODE_ID occurring earlier than NODE_HREF.

4 years agoMajor update:
Ingo Schwarze [Sat, 18 Apr 2020 20:44:09 +0000 (20:44 +0000)]
Major update:
Complete includes, add several functions, no more <?xml?>,
no more style attributes, NODE_HREF flag, mention roff_html.c.

4 years agoWhen a .Tg is attached to a paragraph, attach the permalink
Ingo Schwarze [Sat, 18 Apr 2020 20:40:10 +0000 (20:40 +0000)]
When a .Tg is attached to a paragraph, attach the permalink
to the first word, or the first few words if they are short.

4 years agoUse a separate node->tag attribute rather than abusing the node->string
Ingo Schwarze [Wed, 8 Apr 2020 11:56:03 +0000 (11:56 +0000)]
Use a separate node->tag attribute rather than abusing the node->string
attribute for the purpose.  No functional change intended.
The purpose is to make it possible to later attach tags to text nodes.

4 years agoSeparate the place to put the <a href> permalink (now marked
Ingo Schwarze [Tue, 7 Apr 2020 22:56:02 +0000 (22:56 +0000)]
Separate the place to put the <a href> permalink (now marked
with NODE_HREF) from the target element of the link (still marked
with NODE_ID).  In many cases, use this to move the target to the
beginning of the paragraph, such that readers don't get dropped
into the middle of a sentence.

4 years agoSupport manual tagging of .Pp, .Bd, .D1, .Dl, .Bl, and .It.
Ingo Schwarze [Mon, 6 Apr 2020 10:16:17 +0000 (10:16 +0000)]
Support manual tagging of .Pp, .Bd, .D1, .Dl, .Bl, and .It.
In HTML output, improve the logic for writing inside permalinks:
skip them when there is no child content or when there is a risk
that the children might contain flow content.

4 years agoautomatically tag .SH and .SS in man(7) terminal output
Ingo Schwarze [Sat, 4 Apr 2020 20:33:33 +0000 (20:33 +0000)]
automatically tag .SH and .SS in man(7) terminal output
in the same way as it was done for .Sh and .Ss in mdoc(7)

4 years agoRemove some stray argument names from function prototypes,
Ingo Schwarze [Fri, 3 Apr 2020 11:35:01 +0000 (11:35 +0000)]
Remove some stray argument names from function prototypes,
for consistency with the dominant style used in mandoc.
No functional change.
Patch from Martin Vahlensieck <academicsolutions dot ch>.

4 years ago#include <stdint.h> because that is needed before #include <ohash.h>;
Ingo Schwarze [Fri, 3 Apr 2020 10:30:09 +0000 (10:30 +0000)]
#include <stdint.h> because that is needed before #include <ohash.h>;
fixing a build failure of mandoc-portable on Arch Linux
reported by Stephen Gregoratto <dev at sgregoratto dot me>.

4 years agoWhen the last file formatted yielded no tags, the tags file got
Ingo Schwarze [Thu, 2 Apr 2020 22:12:55 +0000 (22:12 +0000)]
When the last file formatted yielded no tags, the tags file got
deleted before starting the pager, even when earlier input files
had written to it; thanks to weerd@ for reporting that bug.

Since we now generate tags for section headers, we almost always
generate at least some.  Consequently, while fixing the above bug,
simplify the code by never deleting the tags file before the pager
exits, not even in the rare case that the file happens to be empty.
Hence, this patch is -75 +63 LOC even though it fixes two bugs.

While deleting the output files belongs after exit from the pager,
closing them should be done before it is started.  Collect the
related code, which was scattered in various places, to where
it belongs, in a dedicated function in the term_tag.c module.
As a side benefit, never fclose(2) stdout, only dup2(2) to it.

Similarly, when the -O tag argument wasn't found in the last file
formatted, there was a complaint about "no such tag" even when the
argument did occur in earlier files.  Fix that by looking for a
matching tag after every formatted file rather than just once at
the very end.  Given that command line arguments aren't properties
of the file(s) being formatted, that check is a job for the main
program, not for the formatters, so while fixing the check, move
it from term_tag.c to main.c.

4 years agoCopy tagged strings before marking hyphens as breakable.
Ingo Schwarze [Thu, 2 Apr 2020 15:04:36 +0000 (15:04 +0000)]
Copy tagged strings before marking hyphens as breakable.
For example, this makes ":tCo-processes" work in ksh(1).

4 years agoJust like we are already doing it in HTML output, automatically tag
Ingo Schwarze [Wed, 1 Apr 2020 20:21:08 +0000 (20:21 +0000)]
Just like we are already doing it in HTML output, automatically tag
section and subsection headers in terminal output, too.  Even though
admittedly, commands like "/SEE" and "/   Subsec" work, too, there
is no downside, and besides, with the recent improvements in the
tagging framework, implementation cost is negligible.

4 years agoEven though the HTML, man, markdown, PDF, PostScript, and tree formatters
Ingo Schwarze [Sat, 28 Mar 2020 16:18:43 +0000 (16:18 +0000)]
Even though the HTML, man, markdown, PDF, PostScript, and tree formatters
never write a ctags(1) file, using a pager still requires writing the
main output file and passing the file name to the pager.
Recent regression mentioned on IRC and reported by kn@.

4 years agotest skipping of initial hyphens and minus signs in automatic tags;
Ingo Schwarze [Sat, 21 Mar 2020 00:25:19 +0000 (00:25 +0000)]
test skipping of initial hyphens and minus signs in automatic tags;
related to tags.c rev. 1.30

4 years agoWhen setting automatic tags, skip initial hyphens and minus signs,
Ingo Schwarze [Sat, 21 Mar 2020 00:17:31 +0000 (00:17 +0000)]
When setting automatic tags, skip initial hyphens and minus signs,
bringing the behaviour for mdoc(7) closer to what is already done
for man(7).
Triggered by the observation of kn@ that automatic tagging didn't
work very well for find(1) primaries.
OK kn@

4 years agoThe tag file always needs to be closed before starting the pager,
Ingo Schwarze [Thu, 19 Mar 2020 12:21:37 +0000 (12:21 +0000)]
The tag file always needs to be closed before starting the pager,
even when no output formatter was allocated because all pages
shown were preformatted.  Regression in previous reported
by <Andreas dot Kahari at abc dot se> on bugs@.

4 years agoMake the "make depend" maintainer target more convenient
Ingo Schwarze [Fri, 13 Mar 2020 17:31:44 +0000 (17:31 +0000)]
Make the "make depend" maintainer target more convenient
by having it run ./configure with native fts and ohash disabled.

4 years agoProperly reset the validation part of the tagging module between files.
Ingo Schwarze [Fri, 13 Mar 2020 16:16:58 +0000 (16:16 +0000)]
Properly reset the validation part of the tagging module between files.
This fixes a crash in makewhatis(8) encountered by naddy@.

4 years agoSplit tagging into a validation part including prioritization
Ingo Schwarze [Fri, 13 Mar 2020 15:32:28 +0000 (15:32 +0000)]
Split tagging into a validation part including prioritization
in tag.{h,c} and {mdoc,man}_validate.c
and into a formatting part including command line argument checking
in term_tag.{h,c}, html.c, and {mdoc|man}_{term|html}.c.

Immediate functional benefits include:
* Improved prioritization of automatic tags for .Em and .Sy.
* Avoiding bogus automatic tags when .Em, .Fn, or .Sy are explicitly tagged.
* Explicit tagging of .Er and .Fl now works in HTML output.
* Automatic tagging of .IP and .TP now works in HTML output.
But mainly, this patch provides clean earth to build further improvements on.

Technical changes:
* Main program: Write a tag file for ASCII and UTF-8 output only.
* All formatters: There is no more need to delay writing the tags.
* mdoc(7)+man(7) formatters: No more need for elaborate syntax tree inspection.
* HTML formatter: If available, use the "string" attribute as the tag.
* HTML formatter: New function to write permalinks, to reduce code duplication.

Style cleanup in the vicinity while here:
* mdoc(7) terminal formatter: To set up bold font for children,
defer to termp_bold_pre() rather than calling term_fontpush() manually.
* mdoc(7) terminal formatter: Garbage collect some duplicate functions.
* mdoc(7) HTML formatter: Unify <code> handling, delete redundant functions.
* Where possible, use switch statements rather than if cascades.
* Get rid of some more Yoda notation.

The necessity for such changes was first discussed with kn@, but i didn't
bother him with a request to review the resulting -673/+782 line patch.

4 years agoThe HTML standard does not allow self-closing syntax for non-void elements.
Ingo Schwarze [Thu, 27 Feb 2020 22:28:13 +0000 (22:28 +0000)]
The HTML standard does not allow self-closing syntax for non-void elements.
Consequently, write an explicit end tag for <mark> elements.

4 years agoFully support explicit tagging of .Sh and .Ss.
Ingo Schwarze [Thu, 27 Feb 2020 21:43:44 +0000 (21:43 +0000)]
Fully support explicit tagging of .Sh and .Ss.
This fixes the offset of two lines in terminal output
and this improves HTML output by putting the id= attribute
and <a> element into the respective <h1> or <h2> element rather
than writing an additional <mark> element.

To that end, introduce node flags NODE_ID (to make the node a link
target, for example by writing an HTML id= attribute or by calling
tag_put()) and NODE_HREF (to make the node a link source, used only
in HTML output, used only to write an <a class="permalink"> element).

In particular:
* In the validator, generalize the concept of the "next node"
such that it also works before .Sh and .Ss.
* If the first argument of .Tg is empty, don't forget to complain
if there are additional arguments, which will be ignored.
* In the terminal formatter, support writing of explicit tags
for all kinds of nodes, not just for .Tg.
* In deroff(), allow nodes to have an explicit string representation
even when they aren't text nodes.  Use this for explicitly tagged
section headers.  Suprisingly, this is sufficient to make HTML
output work, without explicit code changes in the HTML formatter.
* In syntax tree output, display NODE_ID and NODE_HREF.

4 years agoIntroduce the concept of nodes that are semantically transparent:
Ingo Schwarze [Thu, 27 Feb 2020 01:43:52 +0000 (01:43 +0000)]
Introduce the concept of nodes that are semantically transparent:
they are skipped when looking for previous or following high-level
macros.  Examples include roff(7) .ft, .ll, and .ta, mdoc(7) .Sm
and .Tg, and man(7) .DT and .PD.  Use this concept for a variety
of improved decisions in various validators and formatters.

While here,
* remove a few const qualifiers on struct arguments that caused trouble;
* get rid of some more Yoda notation in the vicinity;
* and apply some other stylistic improvements in the vicinity.

I found this class of issues while considering .Tg patches from kn@.

4 years agoFix this test after the recent Unicode update in OpenBSD base.
Ingo Schwarze [Thu, 27 Feb 2020 00:36:20 +0000 (00:36 +0000)]
Fix this test after the recent Unicode update in OpenBSD base.
The test uses U+07FF NKO TAMAN SIGN because it is the highest
code point having a two-byte UTF-8 representation.
This character is a new single-width punctuation character in
Unicode 11, such that mandoc now does correct horizontal spacing.
We already used the code point for the test before it was assigned,
which resulted in weird spacing because wcwidth(3) returns -1 for
unassigned code points.

4 years agoMarc Espie reported that "man p*ipc" displayed the perlipc(1) manual.
Ingo Schwarze [Mon, 24 Feb 2020 21:16:31 +0000 (21:16 +0000)]
Marc Espie reported that "man p*ipc" displayed the perlipc(1) manual.
The reason was that as a last resort when failing to find a page
name in mandoc.db(5) or at a few well well-defined fully qualified
file names, man(1) uses glob(3) to look for candidate files in
relevant directories, because some operating systems have weird
file name extensions, for example pcap.3pcap and BF_set_key.3ssl
on Linux.  But during that globbing, the metacharacters "*?[" need
to be escaped in the name, section, and path supplied by the user,
or you would get weird false positives and misleading warning
messages and would be unable to use the fallback for path or file
names that actually contain an opening bracket.
Feedback and OK espie@.

4 years agobugfix: indented paragraph macros need a space character
Ingo Schwarze [Thu, 20 Feb 2020 22:55:42 +0000 (22:55 +0000)]
bugfix: indented paragraph macros need a space character
before the width argument

4 years agobugfix: .Tg must be ignored completely in these output modes
Ingo Schwarze [Thu, 20 Feb 2020 00:29:16 +0000 (00:29 +0000)]
bugfix: .Tg must be ignored completely in these output modes

4 years agoMention that .AT, .P, .SB, and .UC are extensions; it really matters
Ingo Schwarze [Tue, 18 Feb 2020 17:31:28 +0000 (17:31 +0000)]
Mention that .AT, .P, .SB, and .UC are extensions; it really matters
because we only retain the language for backward compatibility in
the first place.  Part of the research done by <G dot Branden dot
Robinson at gmail dot com>, see the list <groff at gnu dot org> for
details.

No change to the following conventions: Consider portable whatever
made it into GNU troff no later than 4.4BSD.  For portable extensions,
mention their origin at the end of the description.  For non-portable
extensions, for example from man-ext, usually warn earlier, near
the beginning of the description.

4 years agomention that -T man does not support eqn(7) and tbl(7);
Ingo Schwarze [Sat, 15 Feb 2020 15:28:13 +0000 (15:28 +0000)]
mention that -T man does not support eqn(7) and tbl(7);
triggered by a question from Stephen Gregoratto <dev at sgregoratto dot me>

4 years agotwo new entries: "Fl Fl" to "Fl \-" in validation and eqn/tbl in -T man
Ingo Schwarze [Sat, 15 Feb 2020 14:59:21 +0000 (14:59 +0000)]
two new entries: "Fl Fl" to "Fl \-" in validation and eqn/tbl in -T man

4 years agoMention that the .Dd "date" argument is the date of the last change.
Ingo Schwarze [Thu, 13 Feb 2020 18:32:56 +0000 (18:32 +0000)]
Mention that the .Dd "date" argument is the date of the last change.
Triggered by a question from Jason A. Donenfeld.

While here, delete three COMPATIBILITY entries that i fixed some time ago.

4 years agoDigit-width and narrow spaces are non-breaking.
Ingo Schwarze [Thu, 13 Feb 2020 16:18:29 +0000 (16:18 +0000)]
Digit-width and narrow spaces are non-breaking.
Noticed because Branden Robinson worked on related documentation in groff.

4 years agoIn roff, a space character at the beginning of an input line requires
Ingo Schwarze [Wed, 12 Feb 2020 21:15:53 +0000 (21:15 +0000)]
In roff, a space character at the beginning of an input line requires
starting a new output line, and merely starting a new line of HTML
code isn't sufficient to achieve that.  Solve this in the same way
as mdoc_html.c already does it, by printing a <br/> element.
Fixing a bug reported by Jason A. Donenfeld <Jason at zx2c4 dot com>
in the wg-quick(8) manual page on manpages.debian.org.

4 years agoFinally delete support for the "_whatdb" configuration directive,
Ingo Schwarze [Mon, 10 Feb 2020 14:42:10 +0000 (14:42 +0000)]
Finally delete support for the "_whatdb" configuration directive,
which has a misleading syntax.  It was declared obsolete and
superseded by the "manpath" directive five years ago.

4 years agoReduce the diff to OpenBSD by making FILES a list,
Ingo Schwarze [Mon, 10 Feb 2020 14:13:24 +0000 (14:13 +0000)]
Reduce the diff to OpenBSD by making FILES a list,
even though it has only one entry in the portable version.
Do not add /etc/examples/man.conf for the portable version, though.

4 years agoThe man(1) command was already available in AT&T Version 2 UNIX.
Ingo Schwarze [Mon, 10 Feb 2020 14:04:11 +0000 (14:04 +0000)]
The man(1) command was already available in AT&T Version 2 UNIX.
Jonathan Gray found it in the "Combined Table of Contents" in Doug
McIlroy's "A Research UNIX Reader", which contains a table of which
edition manuals appeared in, and in both the "Table of Contents"
(page vi) and the body (page 89) of the printed UNIX Programmer's
Manual (June 12, 1972) from bitsavers.

4 years agoFor compatibility with the man(1) implementations of the man-1.6
Ingo Schwarze [Mon, 10 Feb 2020 13:49:15 +0000 (13:49 +0000)]
For compatibility with the man(1) implementations of the man-1.6
and man-db packages, print the manpath if the -w option is given
without a following name argument.

This quirk has been in man-1.6 since at least man-1.5e (1998)
and in man-db since 2012.

Using this feature in portable software is a dubious idea because the
internal organization of manual page directories varies in about a
dozen respects among operating systems, so even if you get the answer,
there is no portable way to use it for looking up anything inside.
However, Matej Cepl <mcepl at suse dot cz> made me aware that some
software, for example the manual viewing functionality in the newest
editors/neovim code, unwisely relies on this feature anyway.

No objections were raised when this patch was shown on tech@.

4 years agoMake sure that -l always causes -w to be ignored, as documented
Ingo Schwarze [Thu, 6 Feb 2020 19:41:40 +0000 (19:41 +0000)]
Make sure that -l always causes -w to be ignored, as documented
in the man(1) manual page.  This bugfix is needed to prevent
the command "man -lw" from dereferencing a NULL pointer.

4 years agoNo longer try to ask make(1) what the default compiler is, just use "cc".
Ingo Schwarze [Wed, 5 Feb 2020 15:12:11 +0000 (15:12 +0000)]
No longer try to ask make(1) what the default compiler is, just use "cc".
That line was a bad idea in the first place, it tried to be too clever,
and it failed in different ways on different platforms.  Even when it
succeeded, what make(1) considered the default wasn't always useful.
Having a simple and robust default and asking users to override it
when needed is better.

4 years agoRepair more of the issues that i found in filescan() while investigating
Ingo Schwarze [Sun, 26 Jan 2020 21:25:41 +0000 (21:25 +0000)]
Repair more of the issues that i found in filescan() while investigating
the report from <Andreas dot Kahari at abc dot se> on ports@:

For a symlink, use the first of the following names that is available:
1. In -t mode, the symlink itself (unchanged).
2. When the (unresolved) symlink already resides inside the manpath,
just strip the manpath and use the rest (unchanged).
3. When prefix(es) of the unresolved symlink point to the manpath,
strip the longest such prefix and use the rest (new); this fixes
situations where the manpath or one of its parent directories is a
symlink and at the same time contains symlinks to manual pages.
4. Fall back to the fully resolved symlink, with the manpath stripped
(new); this may for example happen when the command line passes
symlinks from outside the manpath that point to manual pages inside
the manpath, or if manual page trees contain symlinks to symlinks and
not all of them are given on the command line.

The fallback (4) isn't perfect.  You can construct symlink spaghetti
in such a way that this algorithm will not enter all manual page
names into the database that a human would be able to deduce.  But
i do not expect such spaghetti to actually occur in practice (not
even in ports), and a full fix would require re-implementing
realpath(3) in terms of step-by-step readlink(2) calls, repeating
the complicated algorithm (3) after each step.

While here, also stop using PATH_MAX as the size of a static buffer
in filescan(); on some systems, it can be unreasonably large.
Instead, allocate path strings dynamically.

4 years agoFix incorrect file type tests.
Ingo Schwarze [Sun, 26 Jan 2020 11:16:47 +0000 (11:16 +0000)]
Fix incorrect file type tests.
This bug caused sockets and character special devices to be accepted
as manual pages if they appeared inside manpaths, and
it caused incorrect file names to be entered into the database when
the manpath or one of its parent directories was a symbolic link.
This fixes the issues reported by <Andreas dot Kahari at abc dot se>
on ports@, but additional issues remain when symbolic links are
contained in a manpath that involves another symbolic link.

4 years agoMinor cleanup, no functional change:
Ingo Schwarze [Sat, 25 Jan 2020 22:59:22 +0000 (22:59 +0000)]
Minor cleanup, no functional change:
Do not abuse strstr(3) to check whether one long string starts with
another long string.  Instead, use strncmp(3) with the proper length.
In set_basedir(), also reset *basedir in the error brances for extra safety.
While here, invert some more Yoda conditions in the neighbourhood.

4 years agoMake the code more readable by introducing
Ingo Schwarze [Mon, 20 Jan 2020 10:37:15 +0000 (10:37 +0000)]
Make the code more readable by introducing
symbolic constants for tagging priorities.
This review also made me find a minor bug: do not upgrade
TAG_FALLBACK to TAG_WEAK when there is trailing whitespace.

4 years agoIntroduce a new mdoc(7) macro .Tg ("tag") to explicitly mark a place
Ingo Schwarze [Sun, 19 Jan 2020 18:02:00 +0000 (18:02 +0000)]
Introduce a new mdoc(7) macro .Tg ("tag") to explicitly mark a place
as defining a term.  Please only use it when automatic tagging does
not work.  Manual page authors will not be required to add the new
macro; using it remains optional.  HTML output is still rudimentary
in this version and will be polished later.

Thanks to kn@ for reminding me that i have been considering since
BSDCan 2014 whether something like this might be useful.  Given
that possibilities of making automatic tagging better are running
out and there are still several situations where automatic tagging
cannot do the job, i think the time is now ripe.

Feedback and no objection from millert@; OK espie@ inoguchi@ kn@.

4 years agoAlign to the new, sane behaviour of the groff_mdoc(7) .Dd macro:
Ingo Schwarze [Sun, 19 Jan 2020 16:44:50 +0000 (16:44 +0000)]
Align to the new, sane behaviour of the groff_mdoc(7) .Dd macro:
without an argument, use the empty string, and always concatenate
all arguments, no matter their number.
This allows reducing the number of arguments of mandoc_normdate()
and some other simplifications, at the same time polishing some
error messages by adding the name of the macro in question.

4 years agodelete the entry for a crash that was already fixed
Ingo Schwarze [Sun, 19 Jan 2020 16:27:43 +0000 (16:27 +0000)]
delete the entry for a crash that was already fixed

5 years agotest tbl_term.c rev. 1.73 and tbl_data.c rev. 1.53:
Ingo Schwarze [Sat, 11 Jan 2020 21:02:26 +0000 (21:02 +0000)]
test tbl_term.c rev. 1.73 and tbl_data.c rev. 1.53:
incomplete short layout lines followed by longer lines,
and spans at the beginning of layout lines

5 years agoWhen autogenerating one layout cell from a data cell just beyond the
Ingo Schwarze [Sat, 11 Jan 2020 20:48:18 +0000 (20:48 +0000)]
When autogenerating one layout cell from a data cell just beyond the
last layout cell that was explicitly specified, properly initialize
the spacing attribute to indicate that the default is to be used.
Failing to do so and leaving the spacing at zero in this case caused
misformatting when another row further down the table had even more
explicitly specified cells.
Bug found while trying to write regression tests for tbl_term.c rev. 1.73.

5 years agoFix a logic error:
Ingo Schwarze [Sat, 11 Jan 2020 16:26:08 +0000 (16:26 +0000)]
Fix a logic error:
When both the first and the third column are spans, do not use
the number of columns of the span starting in column two
for the span starting in column zero.

With afl, Jan Schreiber <jes at posteo dot de> found cases where
this caused NULL pointer accesses because too many layout cells
were consumed.

While here, make the code more similar at the three places
that iterate over data cells.

5 years agoPrint more tbl(7) details to help debugging:
Ingo Schwarze [Sat, 11 Jan 2020 16:03:42 +0000 (16:03 +0000)]
Print more tbl(7) details to help debugging:
column numbers, options, layout rows, cell types, cell modifiers.

5 years agoautocapitalize=none; also from Tim Baumgard
Ingo Schwarze [Fri, 10 Jan 2020 15:21:19 +0000 (15:21 +0000)]
autocapitalize=none; also from Tim Baumgard

5 years agoSwitch off the useless and annoying "autocomplete" feature;
Ingo Schwarze [Fri, 10 Jan 2020 12:54:43 +0000 (12:54 +0000)]
Switch off the useless and annoying "autocomplete" feature;
issue reported by Tim Baumgard <at bmgrd dot com>.
landry@ and florian@ agree with the general direction.

5 years agoDocument the "delim" syntax and its usage.
Ingo Schwarze [Fri, 10 Jan 2020 11:55:04 +0000 (11:55 +0000)]
Document the "delim" syntax and its usage.
Closing a gap reported by bentley@, who also sent a patch,
but i'm explaining it somewhat differently.
While here, remove duplicate information from the text.
OK bentley@

5 years agoSkip whitespace before tokens, too.
Ingo Schwarze [Wed, 8 Jan 2020 12:16:24 +0000 (12:16 +0000)]
Skip whitespace before tokens, too.
Bug found by bentley@ with input like "delim $$ delim off".

5 years agoImprove the test case by changing the eqn(7) delimiters such that it
Ingo Schwarze [Wed, 8 Jan 2020 11:01:37 +0000 (11:01 +0000)]
Improve the test case by changing the eqn(7) delimiters such that it
actually tests which parts of text lines are processed with eqn(7)
and which are not.

5 years agoEnable generation of the desired delim/basic output with groff(1).
Ingo Schwarze [Wed, 8 Jan 2020 10:54:03 +0000 (10:54 +0000)]
Enable generation of the desired delim/basic output with groff(1).
No functional change for the portable test suite.

5 years agoSimplify maintainer targets in OpenBSD: EQN and TBL variables
Ingo Schwarze [Wed, 8 Jan 2020 10:37:53 +0000 (10:37 +0000)]
Simplify maintainer targets in OpenBSD: EQN and TBL variables
no longer exist and NROFF/NOPTS were replaced with GROFF/GOPTS.
This doesn't change how things work in the protable version
of the test suite.

5 years agoImprove the description of -m/-M/MANPATH/man.conf in multiple respects
Ingo Schwarze [Tue, 7 Jan 2020 11:16:33 +0000 (11:16 +0000)]
Improve the description of -m/-M/MANPATH/man.conf in multiple respects
after kn@ reported that the descriptions were incomplete and somewhat
inaccurate.
OK jmc@ kn@

5 years agoWhen all cells in a tbl(1) column are empty, set the column width
Ingo Schwarze [Tue, 31 Dec 2019 22:58:41 +0000 (22:58 +0000)]
When all cells in a tbl(1) column are empty, set the column width
to 1n rather than to 0n, in the same way as groff does.
This fixes misformatting reported by bentley@ in xkeyboard-config(7).

5 years agoDo not fail an assertion when a high level macro occurs in the body
Ingo Schwarze [Thu, 26 Dec 2019 19:51:51 +0000 (19:51 +0000)]
Do not fail an assertion when a high level macro occurs in the body
of a conditional inside a .ce request block.  Instead, abort the .ce
block just like when there is no conditional in between.

Bug found by espie@ working on the textproc/fstrcmp port.

5 years agodistinction between .Vt and .Va
Ingo Schwarze [Wed, 25 Dec 2019 13:20:33 +0000 (13:20 +0000)]
distinction between .Vt and .Va

5 years agotwo new entries: make .Sh/.Ss parsed in mdoc(7)
Ingo Schwarze [Sun, 22 Dec 2019 13:52:35 +0000 (13:52 +0000)]
two new entries: make .Sh/.Ss parsed in mdoc(7)
and delete release number verification from groff_mdoc(7)

5 years agoIn HTML, display straight quotes, not curly quotes, for Qq/Qo/Qc macros.
Ingo Schwarze [Wed, 11 Dec 2019 18:44:05 +0000 (18:44 +0000)]
In HTML, display straight quotes, not curly quotes, for Qq/Qo/Qc macros.
This is the intended behavior and already the case in terminal output.
Incorrect output noticed by Eldred Habert.
Patch from bentley@.

5 years agoAdd a Content-Security-Policy HTTP header that allows only CSS.
Ingo Schwarze [Sun, 10 Nov 2019 22:35:25 +0000 (22:35 +0000)]
Add a Content-Security-Policy HTTP header that allows only CSS.
This ensures that in a modern browser that understands the header,
mandoc rendering bugs cannot possibly be interpreted as JavaScript.
Patch from bentley@.

5 years agowant to get rid of the last style= attributes, suggested by bentley@
Ingo Schwarze [Sun, 10 Nov 2019 17:38:26 +0000 (17:38 +0000)]
want to get rid of the last style= attributes, suggested by bentley@

5 years ago.ce .if .B crash reported by espie@, and one other bug
Ingo Schwarze [Sat, 9 Nov 2019 17:09:15 +0000 (17:09 +0000)]
.ce .if .B crash reported by espie@, and one other bug

5 years agoIn the past, generating comment nodes stopped at the .TH or .Dd
Ingo Schwarze [Sat, 9 Nov 2019 14:39:49 +0000 (14:39 +0000)]
In the past, generating comment nodes stopped at the .TH or .Dd
macro, which is usually close to the beginning of the file, right
after the Copyright header comments.  But espie@ found horrible
input files in the textproc/fstrcmp port that generate lots of parse
nodes before even getting to the header macro.  In some formatters,
comment nodes after some kinds of real content triggered assertions.

So make sure generation of comment nodes stops once real content is
encountered.

5 years agodraft 1.14.6 release notes
Ingo Schwarze [Sun, 13 Oct 2019 14:45:17 +0000 (14:45 +0000)]
draft 1.14.6 release notes

5 years agoFor invalid queries and for valid queries returning no result,
Ingo Schwarze [Tue, 1 Oct 2019 17:54:14 +0000 (17:54 +0000)]
For invalid queries and for valid queries returning no result,
return the appropriate 40x status code rather than 200.
Improvement suggested and diff tested
by John Gardner <gardnerjohng at gmail dot com>.

5 years agoFix line breaking in no-fill mode (.Bd -unfilled/<pre>),
Ingo Schwarze [Sun, 15 Sep 2019 00:08:55 +0000 (00:08 +0000)]
Fix line breaking in no-fill mode (.Bd -unfilled/<pre>),
which apparently didn't work since the .Pp/<p> reorg.
The new logic is more similar to what the terminal formatter does:

1. Before a node that starts a new mdoc(7) input line,
start a new HTML output line.
2. An empty input line or a .Pp causes an empty output line.
3. Nothing needs to be done at the end of a node.

Severe misformatting was reported in table(5) by
Edgar Pettijohn <edgar at pettijohn dash web dot com> on misc@.

5 years agoImprove validation of function names:
Ingo Schwarze [Fri, 13 Sep 2019 19:26:46 +0000 (19:26 +0000)]
Improve validation of function names:
1. Relax checking to accept function types of the form
"ret_type (fname)(args)" (suggested by Yuri Pankov <yuripv dot net>).
2. Tighten checking to require the closing parenthesis.

5 years agoadapt to print_indent() HTML_NOSPACE fix, html.c rev. 1.261
Ingo Schwarze [Thu, 5 Sep 2019 13:40:34 +0000 (13:40 +0000)]
adapt to print_indent() HTML_NOSPACE fix, html.c rev. 1.261