]> git.cameronkatri.com Git - mandoc.git/log
mandoc.git
6 years agoimplement the GNU man-ext .TQ macro in man(7),
Ingo Schwarze [Thu, 16 Aug 2018 23:43:37 +0000 (23:43 +0000)]
implement the GNU man-ext .TQ macro in man(7),
used for example by groff_diff(7)

6 years agoDo not calculate a pointer to a memory location before the beginning of
Ingo Schwarze [Thu, 16 Aug 2018 15:05:34 +0000 (15:05 +0000)]
Do not calculate a pointer to a memory location before the beginning of
a static array.  Christos Zoulas, Robert Elz, and Andreas Gustafsson
point out that is undefined behaviour by the C standard even if we
never access the pointer.

6 years agoDocument \*(.T.
Ingo Schwarze [Thu, 16 Aug 2018 14:07:11 +0000 (14:07 +0000)]
Document \*(.T.
While here, delete the section about predefined strings.
For manual pages, the concept is not important enough to be discussed
in such a prominent place, and some aspects of the text were also
misleading.  Add a shorter version of the relevant parts to the
description of the \* escape sequence instead.

6 years agoImplement the \*(.T predefined string (interpolate device name)
Ingo Schwarze [Thu, 16 Aug 2018 13:54:06 +0000 (13:54 +0000)]
Implement the \*(.T predefined string (interpolate device name)
by allowing the preprocessor to pass it through to the formatters.
Used for example by the groff_char(7) manual page.

6 years agoprocess UTF-8 input even in ASCII output mode,
Ingo Schwarze [Thu, 16 Aug 2018 12:25:32 +0000 (12:25 +0000)]
process UTF-8 input even in ASCII output mode,
and provide a way to specify additional diff(1) options

6 years agofix incomplete variable renaming in previous;
Ingo Schwarze [Wed, 15 Aug 2018 15:37:25 +0000 (15:37 +0000)]
fix incomplete variable renaming in previous;
found by Thomas Klausner <wiz at NetBSD> via a compiler warning

6 years agoChange comment: NetBSD just fixed their headers; but leave the
Ingo Schwarze [Wed, 15 Aug 2018 14:37:41 +0000 (14:37 +0000)]
Change comment: NetBSD just fixed their headers; but leave the
workaround in place for now for the benefit of older systems,
and other systems might contain similar problems.

6 years agoNULL requires <stddef.h>
Ingo Schwarze [Wed, 15 Aug 2018 02:48:51 +0000 (02:48 +0000)]
NULL requires <stddef.h>

6 years agoAutodetect whether _GNU_SOURCE or _OPENBSD_SOURCE are needed; the
Ingo Schwarze [Wed, 15 Aug 2018 02:15:52 +0000 (02:15 +0000)]
Autodetect whether _GNU_SOURCE or _OPENBSD_SOURCE are needed; the
latter is a NetBSD idiosyncrasy reported by wiz@.  Also take into
account that NetBSD declares getsubopt(3) in the wrong header.

6 years agosupport tail arguments on the .ME and .UE macros,
Ingo Schwarze [Tue, 14 Aug 2018 01:27:48 +0000 (01:27 +0000)]
support tail arguments on the .ME and .UE macros,
used for example in the ditroff(7) manual of the groff package

6 years agoerror message for invalid -S argument
Ingo Schwarze [Fri, 10 Aug 2018 22:43:20 +0000 (22:43 +0000)]
error message for invalid -S argument

6 years agohandle the non-portable GNU-style \[charNN], \[charNNN] character
Ingo Schwarze [Fri, 10 Aug 2018 22:12:44 +0000 (22:12 +0000)]
handle the non-portable GNU-style \[charNN], \[charNNN] character
escape sequences, used for example in the groff_char(7) manual page

6 years agoThe groff man-ext macros define fonts CB, CI, and CR,
Ingo Schwarze [Fri, 10 Aug 2018 20:40:45 +0000 (20:40 +0000)]
The groff man-ext macros define fonts CB, CI, and CR,
and some groff manual pages actually use them in .ft requests.
It's easy enough to handle these .ft requests in mandoc, too.

6 years agoImplement the roff(7) .nop (no operation) request.
Ingo Schwarze [Fri, 10 Aug 2018 04:41:25 +0000 (04:41 +0000)]
Implement the roff(7) .nop (no operation) request.
Examples of manual pages (ab)using it
include groff(7), chem(1), groff_mom(7), and groff_hdtbl(7).

6 years agoIf somebody asks "man 3 chmod",
Ingo Schwarze [Thu, 9 Aug 2018 17:30:36 +0000 (17:30 +0000)]
If somebody asks "man 3 chmod",
don't respond with the lie: "No entry for chmod in the manual."
Instead, say "No entry for chmod in section 3 of the manual."
Came up after a question from kn@; OK kn@.

6 years agosome fixes for the "www" and "www-install" maintainer targets
Ingo Schwarze [Thu, 9 Aug 2018 17:28:23 +0000 (17:28 +0000)]
some fixes for the "www" and "www-install" maintainer targets

6 years agorelease 1.14.4 VERSION_1_14_4
Ingo Schwarze [Wed, 8 Aug 2018 14:47:38 +0000 (14:47 +0000)]
release 1.14.4

6 years agoEven though we strongly discourage escaping hyphens in manual pages
Ingo Schwarze [Wed, 8 Aug 2018 14:30:48 +0000 (14:30 +0000)]
Even though we strongly discourage escaping hyphens in manual pages
in general, when introducing the *typographic* term "hyphen",
actually display a real hyphen in output modes supporting it.

6 years agoReorder the text in the "Dashes and Hyphens" subsection to keep the
Ingo Schwarze [Wed, 8 Aug 2018 14:16:08 +0000 (14:16 +0000)]
Reorder the text in the "Dashes and Hyphens" subsection to keep the
simplest and most important instructions together and at the
beginning.  No text change.
Suggested by jmc@.

6 years agoClarify the confusing "(text)" annotation in the character lists.
Ingo Schwarze [Wed, 8 Aug 2018 14:03:27 +0000 (14:03 +0000)]
Clarify the confusing "(text)" annotation in the character lists.
In some cases, it meant "render as an ASCII character in output
modes that have a notion of codepoints" (e.g. UTF-8, HTML); in other
cases, "render in the text font in output modes that also provide
a special font for mathematical symbols" (e.g. PostScript, PDF).
Also explicitly annotate the escape sequences that use a special
font if available.
OK bentley@

6 years agoAfter years of deliberation, finally provide a clear recommendation
Ingo Schwarze [Wed, 8 Aug 2018 13:54:05 +0000 (13:54 +0000)]
After years of deliberation, finally provide a clear recommendation
for hyphens and minus signs in manual pages.
Since there is consensus that a typographically perfect solution is
impossible, let's KISS - just write "-", don't bother with "\-", all
currently relevant manual page formatters can handle "-" reasonably.
OK jmc@ bentley@

6 years agoscanned to groff manual pages for todo items;
Ingo Schwarze [Mon, 6 Aug 2018 14:16:30 +0000 (14:16 +0000)]
scanned to groff manual pages for todo items;
the sheer number of issues is amazing,
but they all look feasible

6 years agoFix an off-by-one string read access that could happen if an empty
Ingo Schwarze [Wed, 1 Aug 2018 16:00:58 +0000 (16:00 +0000)]
Fix an off-by-one string read access that could happen if an empty
string argument preceded a string argument beginning with "--".
Found by Leah Neukirchen <leah at vuxu dot org> with -Wpointer-compare.

6 years agoAfter rewriting the parse buffer from scratch, we also have to reset
Ingo Schwarze [Wed, 1 Aug 2018 15:40:17 +0000 (15:40 +0000)]
After rewriting the parse buffer from scratch, we also have to reset
the parse point to the beginning of the new buffer or we risk out
of bounds accesses.  Bug found by Leah Neukirchen <leah at vuxu dot
org> with valgrind on Void Linux.

6 years agoAvoid a read access one byte beyond the end of an allocated string
Ingo Schwarze [Wed, 1 Aug 2018 13:46:15 +0000 (13:46 +0000)]
Avoid a read access one byte beyond the end of an allocated string
which occurred in situations like ".Fl a Cm --"; found by
Leah Neukirchen <leah at vuxu dot org> with valgrind on Void Linux.

6 years agomore 1.14.4 release preparations:
Ingo Schwarze [Tue, 31 Jul 2018 15:34:00 +0000 (15:34 +0000)]
more 1.14.4 release preparations:
autodetect whether the compiler can use -W and -static,
clearer output from ./configure,
and adjust some configuration instructions

6 years agomakewhatis -p complains about language subdirectories
Ingo Schwarze [Tue, 31 Jul 2018 15:25:55 +0000 (15:25 +0000)]
makewhatis -p complains about language subdirectories

6 years agohtml.c now uses ohash, and new file compat_strndup.c
Ingo Schwarze [Tue, 31 Jul 2018 10:25:33 +0000 (10:25 +0000)]
html.c now uses ohash, and new file compat_strndup.c

6 years agofirst steps toward the 1.14.4 release
Ingo Schwarze [Tue, 31 Jul 2018 10:18:15 +0000 (10:18 +0000)]
first steps toward the 1.14.4 release

6 years agoIssue a STYLE message when normalizing the date format in .Dd/.TH.
Ingo Schwarze [Sat, 28 Jul 2018 18:34:15 +0000 (18:34 +0000)]
Issue a STYLE message when normalizing the date format in .Dd/.TH.
Leah Neukirchen pointed out that mdoclint(1) used to warn about a
leading zero before the day number, so we know that both NetBSD and
Void Linux want the message.  It does no harm on OpenBSD because
Mdocdate always does the right thing anyway.
jmc@ agrees that it makes sense in contexts not using Mdocdate.

6 years agoremove two entries that were done
Ingo Schwarze [Sat, 28 Jul 2018 18:32:17 +0000 (18:32 +0000)]
remove two entries that were done

6 years agogarbage collect the unused "#define INDENT"
Ingo Schwarze [Fri, 27 Jul 2018 17:49:31 +0000 (17:49 +0000)]
garbage collect the unused "#define INDENT"

6 years agoRemove more redundant element selectors where the class selector
Ingo Schwarze [Mon, 23 Jul 2018 22:51:26 +0000 (22:51 +0000)]
Remove more redundant element selectors where the class selector
is already sufficient.  John Gardner tells me that "CSS selectors
should only contain what's necessary to target their subjects".

6 years agoreplace the last instances of ex units by em;
Ingo Schwarze [Mon, 23 Jul 2018 22:33:56 +0000 (22:33 +0000)]
replace the last instances of ex units by em;
recommended by John Gardner <gardnerjohng at gmail dot com>

6 years agonew todos, mostly from Pali Rohar, mostly tbl(7)
Ingo Schwarze [Mon, 16 Jul 2018 15:22:35 +0000 (15:22 +0000)]
new todos, mostly from Pali Rohar, mostly tbl(7)

6 years agoDelete substantial amounts of code
Ingo Schwarze [Mon, 25 Jun 2018 16:54:59 +0000 (16:54 +0000)]
Delete substantial amounts of code
now that we no longer use variable style= attributes.

6 years agoGet rid of the last explicit length in HTML style= attributes.
Ingo Schwarze [Mon, 25 Jun 2018 14:53:58 +0000 (14:53 +0000)]
Get rid of the last explicit length in HTML style= attributes.
Even though style=height is not particularly harmful for responsive
design except for very large arguments which don't really occur in
practice, it is not useful either: nobody should use .sp in manual
pages, in particular not with an argument.  Even if somebody does,
ignoring the argument will likely make the output look better rather
than worse.  Consequently, simplify by dropping a useless feature.

6 years agoDelete support for style=margin-left attributes, which are no longer used.
Ingo Schwarze [Mon, 25 Jun 2018 14:13:54 +0000 (14:13 +0000)]
Delete support for style=margin-left attributes, which are no longer used.

6 years agoDrop explicit, constant style=margin-left attribute on .Bf blocks.
Ingo Schwarze [Mon, 25 Jun 2018 14:06:07 +0000 (14:06 +0000)]
Drop explicit, constant style=margin-left attribute on .Bf blocks.
Since <div> uses HTML_NLAROUND, it is no longer needed.

6 years agoDelete support for style=width attributes, which are no longer used.
Ingo Schwarze [Mon, 25 Jun 2018 14:00:28 +0000 (14:00 +0000)]
Delete support for style=width attributes, which are no longer used.

6 years agoDo not write <colgroup> elements. Their only purpose is to enforce
Ingo Schwarze [Mon, 25 Jun 2018 13:45:57 +0000 (13:45 +0000)]
Do not write <colgroup> elements.  Their only purpose is to enforce
author-specified column widths, which can harm responsive design and
provide no real benefit: HTML rendering engines usually do just
fine automatically selecting appropriate column widths.

6 years agoIgnore author-specified indentation for .RS; it harms responsive
Ingo Schwarze [Mon, 25 Jun 2018 13:33:04 +0000 (13:33 +0000)]
Ignore author-specified indentation for .RS; it harms responsive
design.  Use the existing @media-dependent indent instead.
This removes the last style= attribute from man(7) output.

6 years agoDelete support for the style=text-indent attribute, which is no longer used.
Ingo Schwarze [Mon, 25 Jun 2018 13:26:57 +0000 (13:26 +0000)]
Delete support for the style=text-indent attribute, which is no longer used.

6 years agoFor -man -Thtml, ignore author-specified .HP widths because they
Ingo Schwarze [Mon, 25 Jun 2018 13:01:19 +0000 (13:01 +0000)]
For -man -Thtml, ignore author-specified .HP widths because they
harm responsive design; use @media-dependent defaults instead.

6 years agoRevert previous: style=height is still used by roff_html.c, and it
Ingo Schwarze [Mon, 18 Jun 2018 01:49:15 +0000 (01:49 +0000)]
Revert previous: style=height is still used by roff_html.c, and it
doesn't actually harm responsive design, so keep it for now.
Bug reported in de.comp.os.unix.bsd via naddy@, thanks.

6 years agodelete support for the HTML style=height property, which is no longer used
Ingo Schwarze [Sun, 10 Jun 2018 16:47:15 +0000 (16:47 +0000)]
delete support for the HTML style=height property, which is no longer used

6 years agoIn HTML output, for lists that have an -indent argument, just use
Ingo Schwarze [Sun, 10 Jun 2018 16:15:43 +0000 (16:15 +0000)]
In HTML output, for lists that have an -indent argument, just use
a uniform indentation in CSS adapted to the viewport width and
ignore the value of the argument taken from mdoc(7).  While
author-specified widths somewhat work as a micro-optimization in
terminal and typeset output, they are nothing but harmful in HTML
style= attributes because they break responsive design, whereas
using a reasonable default indent almost never results in ugly
output.  Admittedly, the author-specified width might occasionally
look even better, but only slightly so, and only for some viewport
sizes.
Based on guidance provided by John Gardner.

6 years agoWhen formatting man(7) documents that do not contain .SH macros
Ingo Schwarze [Sun, 10 Jun 2018 15:12:35 +0000 (15:12 +0000)]
When formatting man(7) documents that do not contain .SH macros
with -Tps or -Tpdf, do not squeeze the whole text beyond the right
margin.  Bug reported by Will Backman during BSDCan.

6 years agoRemove redundant value= attributes from option elements,
Ingo Schwarze [Tue, 29 May 2018 20:32:45 +0000 (20:32 +0000)]
Remove redundant value= attributes from option elements,
and use type=search rather than type=text for the input element
because it tends to better support autocompletion.
Both suggested by John Gardner <gardnerjohng at gmail dot com>.

6 years agoDelete support for the print_otag(sw) * and - modifiers,
Ingo Schwarze [Tue, 29 May 2018 02:10:10 +0000 (02:10 +0000)]
Delete support for the print_otag(sw) * and - modifiers,
which are no longer used because we write fewer style= attributes.

6 years agoIgnore author-specified -width arguments for -tag and -hang lists
Ingo Schwarze [Tue, 29 May 2018 01:55:50 +0000 (01:55 +0000)]
Ignore author-specified -width arguments for -tag and -hang lists
in HTML output.  For terminal and typeset output, such arguments
kind of work to achieve presentational micro-optimization.
But for HTML, they only do harm.

Large increases usually look ugly.  Large reductions are impossible
since the default is not large in the first place.  Small tweaks in
either direction are not important; at least not important enough
to justify making responsive design impossible.

Triggered by John Gardner's suggestion to further reduce style=
attributes in the HTML code, in particular those containing hard-coded
lengths.

6 years agoJohn Gardner tells me that among frontend developers, gratuitous use
Ingo Schwarze [Mon, 28 May 2018 15:39:25 +0000 (15:39 +0000)]
John Gardner tells me that among frontend developers, gratuitous use
of double selectors like "element.class" is considered poor style.
When doing selection mainly by elements is not appropriate because
most elements require several different styles, exclusively selecting
by class is less cumbersome, more concise, and more flexible.
So drop the elements from the selectors, except where they are
required for disambiguation and except where they add clarity due
to the presence of child selectors.

6 years agoURL-fragment strings can only contain certain characters.
Ingo Schwarze [Mon, 28 May 2018 14:13:36 +0000 (14:13 +0000)]
URL-fragment strings can only contain certain characters.
Fixing HTML syntax violations e.g. in pf.conf(5) and ifconfig(8)
reported by Anton Lazarov <lists at wrant dot com>.

6 years agoStart with baby steps towards responsive design:
Ingo Schwarze [Sat, 26 May 2018 20:04:41 +0000 (20:04 +0000)]
Start with baby steps towards responsive design:
Use a @media width query to select a set of default indentations.
Suggested by John Gardner <gardnerjohng at gmail dot com>.

6 years agoUse em units rather than ex units for horizontal lengths.
Ingo Schwarze [Sat, 26 May 2018 17:38:01 +0000 (17:38 +0000)]
Use em units rather than ex units for horizontal lengths.
John Gardner and others tell me it produces more predictable results
and is generally considered better style.
Also use 0em instead of 0ex, in general.

6 years agoDo not write duplicate id= attributes, they violate HTML syntax.
Ingo Schwarze [Fri, 25 May 2018 20:23:51 +0000 (20:23 +0000)]
Do not write duplicate id= attributes, they violate HTML syntax.
Append suffixes for disambiguation.  Issue first reported by Jakub
Klinkovsky <j dot l dot k at gmx dot com> (Arch Linux).

6 years agoUse <span> for .Ms rather than <b>; discussed with John Gardner.
Ingo Schwarze [Mon, 21 May 2018 01:11:31 +0000 (01:11 +0000)]
Use <span> for .Ms rather than <b>; discussed with John Gardner.

6 years agoUse <span> for .Ad rather than <i>; also suggested by John Gardner.
Ingo Schwarze [Mon, 21 May 2018 00:30:23 +0000 (00:30 +0000)]
Use <span> for .Ad rather than <i>; also suggested by John Gardner.

6 years agoUse <span> rather than abusing <i> for .Pa;
Ingo Schwarze [Mon, 21 May 2018 00:00:37 +0000 (00:00 +0000)]
Use <span> rather than abusing <i> for .Pa;
suggested by John Gardner <gardnerjohng at gmail dot com>.

6 years agovarious minor improvements
Ingo Schwarze [Sun, 20 May 2018 21:48:44 +0000 (21:48 +0000)]
various minor improvements

6 years agoProtect against malicious manual pages containing .ll requests with
Ingo Schwarze [Sun, 20 May 2018 21:37:34 +0000 (21:37 +0000)]
Protect against malicious manual pages containing .ll requests with
excessive arguments: apply the same cutoff as for the -O width=
command line argument.

While here, also place some assertions at strategical places to
prevent excessive indentations from being printed in case of bugs.
In the past, we had more than one bug that caused mandoc to print
effectively infinite output, filling up people's /tmp/ file system,
which is not funny.  We cannot prevent bugs from crashing the
program, but we can at least make filling up the disk less likely.

Triggered by a remark from sthen@ on source-changes@.

6 years agoIn a nutshell, all mobile browsers are broken.
Ingo Schwarze [Fri, 18 May 2018 14:23:00 +0000 (14:23 +0000)]
In a nutshell, all mobile browsers are broken.
By default, no matter the physical screen size, they use a fixed
viewport width of about 1000px, then scale down the rendered page
to make that huge viewport fit on the physical screen.
That results in poor rendering for bad websites which assume a
large fixed-size viewport (typically requiring zooming in to be able
to actually read any text), but in atrocious rendering for good
websites that make no assumption about the screen size (unreadably
small text in the top left corner, most of the screen empty).

A standard way to disable that insane behaviour and just render
normally on the actual physical screen size does not exist.
The closest thing is the CSS3 Device Adaptation Module Level 1
https://drafts.csswg.org/css-device-adapt/
but https://caniuse.com/#feat=css-deviceadaptation tells me
that basically no browser implements it, not even on mobile.

The next closest thing is the HTML meta viewport element - even though
the problem has nothing to do with HTML and is purely a CSS issue.
Standardization is not even planned for that one:
* HTML 5.2 mentions it in passing without specifying it:
https://www.w3.org/TR/html/document-metadata.html#the-meta-element
* The Web Hypertext Application Technology Working Group
provides very incomplete information:
https://wiki.whatwg.org/wiki/MetaExtensions
* CSS3 Device Adaptation Module Level 1 already wants to deprecate it,
explaining mostly how to migrate *away* from it to some castle in
the sky that no browser implements:
https://drafts.csswg.org/css-device-adapt/#viewport-meta

While i strongly believe in sticking to well-established standards,
in the absence of standards and with atrocious behaviour being
universal, there appears to be no alternative to using whatever
works.  The meta viewport element appears to be the only way to
make real-world mobile browsers decently render any HTML page that
does not have a fixed-width layout of 1000px.  So use it, grudgingly.

Originally suggested by xcv at dr dot com.
Direction supported by espie@.

6 years agoSome broken terminal emulators (e.g. sakura) do the equivalent
Ingo Schwarze [Mon, 14 May 2018 14:10:23 +0000 (14:10 +0000)]
Some broken terminal emulators (e.g. sakura) do the equivalent
of "stty cols 0".  Ignore that insanity rather than setting
conf.output.width to an invalid value and embarking on infinite loops.
Issue reported by Jesper Wallin <jesper at ifconfig dot se>, thanks!

6 years agoFix a long-standing issue:
Ingo Schwarze [Wed, 9 May 2018 00:46:10 +0000 (00:46 +0000)]
Fix a long-standing issue:
Some macros (Nd, Oo) can contain blocks but rendered as elements that
can only contain phrasing content, resulting in invalid HTML nesting.
Switch them to <div>.
Also move the related "display: inline" style from the HTML to the CSS.

Reminded during a conversation with John Gardner.

6 years agoEliminate the class=It-* attributes.
Ingo Schwarze [Tue, 8 May 2018 21:42:34 +0000 (21:42 +0000)]
Eliminate the class=It-* attributes.
Cleaner HTML, more idiomatic CSS, and minus 30 lines of C code.
Suggested by John Gardner <gardnerjohng at gmail dot com>.

6 years agoSwitch the emitted HTML element from <b> to <code> for the fixed
Ingo Schwarze [Tue, 8 May 2018 17:52:55 +0000 (17:52 +0000)]
Switch the emitted HTML element from <b> to <code> for the fixed
syntax element macros .Nm, .Fl, .Cm, .Ic, .In, .Fd, .Fn, and .Cd.
Adjust both the internal and external style sheets such that
rendering remains unchanged in typical browsers.

Based on feedback from John Gardner <gardnerjohng at gmail dot com>.

6 years agoMinor correction: we render HTML character references hexadecimal,
Ingo Schwarze [Thu, 3 May 2018 14:21:46 +0000 (14:21 +0000)]
Minor correction: we render HTML character references hexadecimal,
not decimal; bentley@ changed that in html.c on July 14, 2017.

6 years agoskip printing the embedded style sheet if an external style is referenced
Ingo Schwarze [Tue, 1 May 2018 23:36:55 +0000 (23:36 +0000)]
skip printing the embedded style sheet if an external style is referenced

6 years agoSimpler description of output formats, shortening the manual page by 15 lines.
Ingo Schwarze [Sun, 29 Apr 2018 14:29:53 +0000 (14:29 +0000)]
Simpler description of output formats, shortening the manual page by 15 lines.
Avoid the double redirection from -Tutf8 via -Tlocale to -Tascii.
Add LC_CTYPE to the ENVIRONMENT section.
While here, also correct a few inaccuracies and tweak some wordings.
Triggered by a question from Laura Morales <lauretas at mail dot com>.

6 years agoBetter mandoc(1) -I and -T options for Heirloom comparisons.
Ingo Schwarze [Tue, 24 Apr 2018 13:58:30 +0000 (13:58 +0000)]
Better mandoc(1) -I and -T options for Heirloom comparisons.
Filter through col(1) -b for Heirloom because it produces double encoding.
Switch on mandoc(1) -Wall in groff comparisons.
Update usage.

6 years agomultiple new entries from various sources
Ingo Schwarze [Tue, 24 Apr 2018 13:30:59 +0000 (13:30 +0000)]
multiple new entries from various sources

6 years agoreplace my vague and idiosyncratic term "selflink"
Ingo Schwarze [Tue, 24 Apr 2018 00:36:52 +0000 (00:36 +0000)]
replace my vague and idiosyncratic term "selflink"
with the clearer and more usual "permalink";
suggested by John Gardner <gardnerjohng at gmail dot com>

6 years agodedup issues
Ingo Schwarze [Fri, 20 Apr 2018 14:02:32 +0000 (14:02 +0000)]
dedup issues

6 years agoTweak the description of -l:
Ingo Schwarze [Thu, 19 Apr 2018 23:41:16 +0000 (23:41 +0000)]
Tweak the description of -l:

Avoid the misunderstanding that the essential purpose of -l is
similar to the purpose of the -a option in mandoc(1), which is not
the point: the fact that -l implies -a is merely a minor detail.
The point of -l is to make man(1) behave like mandoc(1).
Move the mention of -a to the end to de-emphasize it.

Nate Bargmann reported that this seriously confused him,
and i can see why.

6 years agoCompatibility with man-db:
Ingo Schwarze [Thu, 19 Apr 2018 16:25:24 +0000 (16:25 +0000)]
Compatibility with man-db:
In page name mode (= man(1) default mode), also try to interpret
names containing slashes as absolute or relative file names.

Missing feature reported by Nate Bargmann on <groff at gnu dot org>,
and the man-db maintainer Colin Watson <cjwatson at debian dot org>
kindly explained to me how this is supposed to work.

6 years agoUse TIOCGWINSZ to reduce the default -Owidth during interactive use
Ingo Schwarze [Fri, 13 Apr 2018 19:55:30 +0000 (19:55 +0000)]
Use TIOCGWINSZ to reduce the default -Owidth during interactive use
on terminals narrower than 79 columns and the default -Oindent on
terminals narrower than 66 columns.
Requested by and feedback from pirofti@;
mpi@ and juanfra@ also like the general direction.

6 years agoMake sure that mandoc only goes into UTF-8 mode if the user really
Ingo Schwarze [Fri, 13 Apr 2018 18:31:00 +0000 (18:31 +0000)]
Make sure that mandoc only goes into UTF-8 mode if the user really
selected UTF-8, not some other multibyte locale.  This obviously
makes no difference on OpenBSD but improves portability.
Issue reported by <Nakayama at NetBSD> via wiz@.

6 years agopreserve comments before .Dd and .TH (typically Copyright and license)
Ingo Schwarze [Fri, 13 Apr 2018 16:28:07 +0000 (16:28 +0000)]
preserve comments before .Dd and .TH (typically Copyright and license)
in full HTML output, but not with -Ofragment, e.g. in man.cgi(8);
suggested by Thomas Klausner <wiz at NetBSD>

6 years agopreserve comments before .Dd when converting mdoc(7) to man(7)
Ingo Schwarze [Wed, 11 Apr 2018 17:11:13 +0000 (17:11 +0000)]
preserve comments before .Dd when converting mdoc(7) to man(7)
with mandoc -Tman; suggested by Thomas Klausner <wiz at NetBSD>

6 years agoTwo new low-level roff(7) features:
Ingo Schwarze [Tue, 10 Apr 2018 00:52:30 +0000 (00:52 +0000)]
Two new low-level roff(7) features:
* .nr optional third argument (auto-increment step size)
* \n+ and \n- numerical register auto-increment and -decrement
bentley@ reported on Dec 9, 2013 that lang/sbcl(1) uses these.

6 years agoWhen accessing an undefined number register, define it to be zero, like
Ingo Schwarze [Mon, 9 Apr 2018 22:27:04 +0000 (22:27 +0000)]
When accessing an undefined number register, define it to be zero, like
the previous commit for strings and macros, only technically simpler.
Desired behaviour also mentioned by Werner Lemberg in 2011.
This diff adds functionality but is -21 +19 LOC.  :-)

6 years agoUsing an undefined string or macro will cause it to be defined as empty.
Ingo Schwarze [Mon, 9 Apr 2018 02:31:42 +0000 (02:31 +0000)]
Using an undefined string or macro will cause it to be defined as empty.
Observed by Werner Lemberg on Nov 14, 2011
and rotting on my TODO list ever since.

6 years agoStop documenting the non-portable .R man(7) macro. Neither groff
Ingo Schwarze [Thu, 5 Apr 2018 22:12:33 +0000 (22:12 +0000)]
Stop documenting the non-portable .R man(7) macro.  Neither groff
nor the heirloom-doctools support it.  Adding it was a mistake in
the first place.

6 years agoDo not use a non-portable .R man(7) macro. Neither groff nor the
Ingo Schwarze [Thu, 5 Apr 2018 22:05:08 +0000 (22:05 +0000)]
Do not use a non-portable .R man(7) macro.  Neither groff nor the
heirloom-doctools support it.  Work around the gap by using .BR
with an empty first argument.  This was noticed more than once in
the past, but i always forgot to fix it.

6 years agouse the portable \(lq and \(rq internally rather than \(Lq and \(Rq
Ingo Schwarze [Thu, 5 Apr 2018 09:17:26 +0000 (09:17 +0000)]
use the portable \(lq and \(rq internally rather than \(Lq and \(Rq

6 years agoFor .Do/.Dq, use the documented and portable \(lq and \(rq
Ingo Schwarze [Thu, 5 Apr 2018 08:47:16 +0000 (08:47 +0000)]
For .Do/.Dq, use the documented and portable \(lq and \(rq
character escape sequences rather than the undocumented and
non-portable \(Lq and \(Rq.

Bug reported by Tim L <darkxst at github>
via Thomas Klausner <wiz at NetBSD>;
see https://github.com/nih-at/libzip/pull/42

6 years agoOuch, fix previous: In the edge case of a single-character string
Ingo Schwarze [Fri, 16 Mar 2018 20:41:41 +0000 (20:41 +0000)]
Ouch, fix previous:  In the edge case of a single-character string
containing nothing but a single hyphen, the pointer got incremented
twice at one point, causing a read overrun found by naddy@.

6 years agoStyle message about bad input encoding of em-dashes as -- instead of \(em.
Ingo Schwarze [Fri, 16 Mar 2018 15:05:44 +0000 (15:05 +0000)]
Style message about bad input encoding of em-dashes as -- instead of \(em.
Suggested by Thomas Klausner <wiz at NetBSD>; discussed with jmc@.

6 years agoSoften the language discouraging special character escape sequences.
Ingo Schwarze [Thu, 15 Mar 2018 18:10:31 +0000 (18:10 +0000)]
Soften the language discouraging special character escape sequences.
After i improved their ASCII renderings in groff and mandoc some time
ago, mathematical symbols can now be used in specialised mathematical
manual pages like libm and some X libraries.
Tweaks and OK jmc@.

6 years agoAdd strndup(3) compat implementation.
Ingo Schwarze [Tue, 27 Feb 2018 11:16:23 +0000 (11:16 +0000)]
Add strndup(3) compat implementation.
Jan Stary reports that MacOS X Snow Leopard and older lacks it.

6 years agoAfter opening a file with gzdopen(3), we have to call gzclose(3) or
Ingo Schwarze [Fri, 23 Feb 2018 21:35:19 +0000 (21:35 +0000)]
After opening a file with gzdopen(3), we have to call gzclose(3) or
we leak memory internally used by zlib to keep compression state.
Bug reported by Wolfgang Mueller <vehk at vehk dot de> who also
provided an incomplete patch, part of which i'm using in this commit.

6 years agoclarify documentation of macro keys
Ingo Schwarze [Fri, 23 Feb 2018 18:54:02 +0000 (18:54 +0000)]
clarify documentation of macro keys

6 years agoLogically, the following are are type names - just like .Vt,
Ingo Schwarze [Fri, 23 Feb 2018 18:25:57 +0000 (18:25 +0000)]
Logically, the following are are type names - just like .Vt,
some of them with an optional variable name following:
- .Ft
- .Fa in the SYNOPSIS
- .Fn second and later arguments in the SYNOPSIS
So add these to the .Vt macro table in the mandoc.db(5) database.
During my LibreSSL work, i'm getting really tired of typing
$ man -k Vt,Ft,Fa=some_type_name
over and over again; now, this becomes just:
$ man -k Vt=some_type_name

6 years agoInvalidate the tag_files.tfd after fclose(3)ing the stram associated
Ingo Schwarze [Fri, 23 Feb 2018 16:47:10 +0000 (16:47 +0000)]
Invalidate the tag_files.tfd after fclose(3)ing the stram associated
with it.  In main() assert that the tfd was actually invalidated.
This avoids closing an invalid fd.
From tb@; OK deraadt@ on an earlier version.

6 years agoIn man(7) and cat pages, cut off excessive one line descriptions.
Ingo Schwarze [Wed, 7 Feb 2018 20:31:39 +0000 (20:31 +0000)]
In man(7) and cat pages, cut off excessive one line descriptions.
An extreme example of how rogue files could mess up apropos(1) output
was reported by bentley@: qwtlicense(3) in the x11/qwt port.

6 years agoFix the mandoc_strndup() utility function. All existing callers seem
Ingo Schwarze [Wed, 7 Feb 2018 20:04:57 +0000 (20:04 +0000)]
Fix the mandoc_strndup() utility function.  All existing callers seem
safe so far, but implementing it with an unchecked memcpy(3) is just
wrong and quite dangerous.

6 years agofix wrong date
Ingo Schwarze [Wed, 7 Feb 2018 19:58:42 +0000 (19:58 +0000)]
fix wrong date

6 years agoDelete the "no blank before trailing delimiter" check from the
Ingo Schwarze [Tue, 6 Feb 2018 16:29:57 +0000 (16:29 +0000)]
Delete the "no blank before trailing delimiter" check from the
partial explicit macros.  Leah Neukirchen <leah at vuxu dot org>
rightfully points out that the check makes no sense for these macros.

7 years agoRemove the implicit display feature of .Lk because it was inconsistent
Ingo Schwarze [Sat, 13 Jan 2018 05:23:18 +0000 (05:23 +0000)]
Remove the implicit display feature of .Lk because it was inconsistent
across output devices, counter-intuitive, and resulted in ugly
output for many real-world manual pages.  Always format even long
links in-line.  I already committed a similar change to groff.

OK jmc@, bentley@, and the original author
of the feature, Werner Lemberg <wl@gnu.org>.

7 years agotypo; from Alexander Kuleshov <kuleshovmail at gmail dot com>
Ingo Schwarze [Fri, 15 Dec 2017 23:39:07 +0000 (23:39 +0000)]
typo; from Alexander Kuleshov <kuleshovmail at gmail dot com>