Up to [cvs.NetBSD.org] / pkgsrc / textproc / groff
Request diff between arbitrary revisions
Keyword substitution: kv
Default branch: MAIN
groff: Remove duplicate rcsid.
groff: Enable new compatibility wrappers option. Adam's update also broke groff on illumos by dropping a patch required to avoid the non-GNU system macros. Upstream now provides a new compatibility wrappers argument that has a "manual" option which will install the wrappers with "-os" suffixes, rather than doing the previous renaming dance. This helps to simplify the install a lot. The groff-native an.tmac, m.tmac, etc files can now be specified directly in the PLIST, and any -os.tmac wrapper files installed to site-tmac will be picked up by the existing PLIST-local. While here add TEST_TARGET, I guess they haven't been ran for recent updates.
groff: updated to 1.24.1
VERSION 1.24.1
==============
This release corrects bugs in the groff 1.24.0 release, adds automated
test scripts, revises a misleading diagnostic message, and improves
documentation. There are no new features.
VERSION 1.24.0
==============
Noteworthy incompatible changes
-------------------------------
* If your roff(7) documents follow any of the requests `cf`, `hpf`,
`hpfa`, `mso`, `msoquiet`, `nx`, `open`, `opena`, `so`, `soquiet`, or
`trf` with a comment after their file name argument, and did not
place that comment immediately after the file name, you are likely to
get a diagnostic message resembling the following.
warning: cannot open macro file 'e.tmac ': No such file or directory
Or, less likely, the formatter will open the wrong file, one with
spaces at the end of its name. That is because these requests are
now able to process file names containing space characters. (This
change also makes the request syntax consistent with that of `ds`,
`as`, and others.) A quick fix is to place the comment escape
sequence as early as possible. For example, we would change:
.mso e.tmac \" Load Eric Allman's package.
to:
.mso e.tmac\" Load Eric Allman's package.
to tell the formatter to load the "e.tmac" file rather than
"e.tmac ". See the items below for further details.
* If your roff(7) documents specify a file name that starts with a
neutral double quote (") to any of the requests `cf`, `hpf`,
`hpfa`, `mso`, `msoquiet`, `nx`, `open`, `opena`, `so`, `soquiet`, or
`trf`, you are likely to get a diagnostic message, or the formatter
will open a file of the same name except for the leading neutral
double quote. That is because these requests are now able to process
file names containing leading space characters. (This change also
makes the request syntax consistent with that of `ds`, `as`, and
others.) The solution is to add an additional neutral double quote
to the start of the file name argument. For example, we would
change:
.so "5150".lrc
to:
.so ""5150".lrc
to tell the formatter to read a file named '"5150".lrc', where the
neutral single quotes bracket the file name.
* groff mdoc(7)'s font customization feature, undocumented but
analogous to that of 4.4BSD mdoc, now expects the strings that
designate font names to be precisely that: font _names_ (or abstract
styles, or mounting positions), rather than arbitrary *roff syntax.
(String interpolations remain acceptable, as long as what they
interpolate is a valid argument to the `ft` request or `\f[xxx]`
escape sequence.)
* Support for terminal devices using the CCSID 1047 (EBCDIC) encoding
has been withdrawn. See below for motivation and a workaround.
troff
-----
* troff now recognizes an -S option, which "locks" safer mode,
rejecting any subsequent specification of -U on the command line with
an error diagnostic.
* The `cf` request is now disabled in safer mode; as with `pi` and
`sy`, you must specify troff's "unsafe mode" option `-U` to use it.
Alternatively, use the `trf` request, available since groff 0.6
(circa 1990), to embed a file in GNU troff's output while discarding
characters (most C0 and C1 controls) that are invalid as GNU troff
input--and incidentally also undefined in GNU troff output.
* The `hpfcode` request now emits an error when used, advising of its
planned withdrawal, but then proceeds with normal behavior. The
documented replacement mechanism, the `hcode` request, has existed
since groff 1.02 (June 1991) at the latest.
* The `mso` request no longer attempts to open a macro file named, say,
"tmac.s" if "s.tmac" was specified as the argument and not found, nor
vice versa. This feature was a convenience for some old AT&T troff
installations, but few of those remain in the field, and of those
that we know to survive, few use a macro file naming convention for
which this feature is any help. (DWB 3.3 and Solaris do not, and we
think other System V troffs don't, either. Only Plan 9 troff does.)
`mso` now simply processes the macro search path for a file name
matching the request argument, and succeeds or fails depending on an
exact match.
If you desire this functionality for portability (keeping in mind
that `mso` is itself a groff extension), consider the following.
.\" Load the ms package, whatever it might be named.
.\" troffs without groff extensions must know its full path.
.if !\n(.g .so /path/to/tmac.s
.\" The following requests do nothing on non-GNU troffs.
.do msoquiet s.tmac\" If file present, defines `LP` macro.
.do if !d LP .msoquiet tmac.s
* GNU troff no longer accepts nonpositive page lengths. Attempting to
set one with the `pl` request clamps the page length to the vertical
motion quantum as `ll` does with the horizontal motion quantum in
AT&T and GNU troffs.
* GNU troff no longer accepts a newline as a delimiter for the
parameterized escape sequences `\A`, `\b`, `\o`, `\w`, `\X`, and
`\Z`.
* GNU troff no longer accepts C0 controls or Latin-1 Supplement
characters in identifiers. We prohibit C0 controls to make the
language less tolerant of unreadable input, and Latin-1 Supplement
code points to enable us to pivot to reading UTF-8-encoded input in a
future release. (Thus, we plan for Latin-1 Supplement characters to
again be accepted in identifiers, but only as components of multibyte
UTF-8 sequences.)
* The `color`, `cp`, `kern`, `linetabs`, and `vpt` requests now
interpret arguments with negative values as instructions to disable
the corresponding feature, using the *roff integer-to-Boolean
conversion idiom instead of the C/C++ one. Thus, if you invoke these
requests with a register interpolation as an argument, the outcome
agrees with an `if` test of the register's value.
* GNU troff now implements saturating rather than wrapping integer
arithmetic. Where before overflow would cause an error diagnostic
and abort evaluation of the expression, the formatter now emits a
warning diagnostic in the "range" category and continues evaluation.
* GNU troff now strips a leading neutral double quote from the argument
to the `cf`, `hpf`, `hpfa`, `lf`, `mso`, `msoquiet`, `nx`, `pi`,
`pso`, `so`, `soquiet`, `sy`, and `trf` requests, and the second
argument to the `open` and `opena` requests, allowing it to contain
embedded leading spaces.
* GNU troff now accepts space characters in the argument to the `cf`,
`hpf`, `hpfa`, `lf`, `mso`, `msoquiet`, `nx`, `so`, `soquiet`, and
`trf` requests, and the second argument to the `open` and `opena`
requests. See "soelim" below.
* The foregoing two changes make the syntax of the listed requests
consistent with that of `ds`, `as`, and others that take arguments
that the formatter reads to the next newline.
* The "number" warning category has been withdrawn. The diagnostic
that formerly used it has been promoted to an error.
* The "el" warning category has been withdrawn. If enabled (which it
was not by default), the formatter would emit a diagnostic if it
inferred an imbalance between `ie` and `el` requests. Unfortunately
its technique wasn't reliable and sometimes spuriously issued these
warnings, and making it perfectly reliable did not look tractable.
We recommend using brace escape sequences `\{` and `\}` to ensure
that your control flow structures remain maintainable.
* The "right-brace" warning category has been withdrawn. If enabled
(which it was not by default), the formatter would emit a diagnostic
in exactly one circumstance: when a numeric expression was expected
(as, for instance, the second argument to an `nr` request) but a
right brace escape sequence `\}` was encountered instead. This
diagnostic still issues, but it is now an error.
* GNU troff now performs some limited processing/transformation of the
argument to the `\X` escape sequence and its counterpart `device`
request, to address the requirement that some documents have to pass
metadata that must encode non-ASCII characters in device extension
commands. (For example, a document author may desire a document's
section headings containing non-ASCII code points to appear correctly
in PDF bookmarks. Further, GNU troff encodes its output page
description language only in ASCII.) This change is expected to be
of significance mainly to developers of output drivers for groff;
groff_diff(7) describes the transformations. If you have been using
`\X` or `.device` to pass ASCII data to the output driver as a device
extension command and require that it remain precisely as-is, use the
`\!` escape sequence or `output` request, and prefix your data with
"x X ", the device-independent troff means of expressing a device
extension command (see groff_out(5)).
* In nroff mode (in other words, when producing output for devices that
claim to be terminals), the formatter now reports warning diagnostics
regarding certain output problems using units of lines (vertically)
and character cells [ens] (horizontally) instead of inches (or the
unit configured with the `warnscale` request) to describe the drawing
position where the problem occurred.
* The device-independent page description language produced by GNU
troff now reports unbreakable spaces (those produced with the `\~`
escape sequence) as word boundaries with the documentary 'w' command,
just as it does for regular breakable spaces.
* A new request, `hydefault`, and read-only register, `.hydefault`,
manage the default automatic hyphenation mode of an environment.
This resolves a long-standing problem of *roff formatting.
When processing input like this,
.nh
and we temporarily shut off automatic hyphenation,
.hy
the foregoing request would not do exactly what we expect.
AT&T and other troffs apply a hyphenation mode of 1 to the final
input line (and subsequent ones), rather than restoring the mode in
use before the `nh` request. Apart from overturning user
expectations, for GNU troff "1" is not an appropriate mode for its
English hyphenation patterns. (For example, "alibi" would break as
"ali-bi" instead of "al-ibi" after this argumentless `hy`
invocation.) With updates to groff's localization files accompanying
this release, the foregoing input now works as desired.
* A new read-only, string-valued register, `.trap`, interpolates the
name of the next page location trap after the drawing position.
* New registers `.it`, `.itc`, and `.itm` are available. These
read-only (and, in the case of `.itm`, string-valued) registers
report the number of lines remaining in a pending input trap, a
Boolean indication of whether that pending input trap honors output
line continuation (cf. the `it` and `itc` requests), and the name of
the macro associated with the pending input trap, respectively.
* A new request, `pchar`, reports to the standard error stream details
of any class or ordinary, special, or indexed character arguments.
* A new request, `pcolor`, reports to the standard error stream details
of each color name specified as an argument, including its color
space identifier and channel value assignments. Without arguments,
all defined colors are listed. (A device's default stroke and/or
fill colors, "default", are not listed since they are immutable and
their details unknown to the formatter.)
* A new request, `pcomposite`, reports to the standard error stream the
list of configured composite character mappings.
* A new request, `pfp`, reports to the standard error stream the
list of occupied font mounting positions and the corresponding
abstract style name or font information.
* A new request, `pftr`, reports to the standard error stream the
list of configured font translations.
* A new request, `phw`, reports to the standard error stream the
list of hyphenation exceptions associated with the current
hyphenation language.
* A new request, `pline`, reports to the standard error stream the list
of output nodes (an internal data structure) corresponding to the
pending output line. The list is empty if no such nodes exist.
* The `pm` request now interprets any arguments as a sequence of macro,
string, or diversion names, and reports their contents.
* The `pnr` request now additionally reports the autoincrementation
amount and interpolation format of each register (if it is not
string-valued).
* The `pnr` request now accepts arguments. It treats each as
identifying a register and reports its properties to the standard
error stream.
* A new request, `pstream`, reports to the standard error stream the
name of each stream opened with the `open` or `opena` requests, the
name of the file backing it, and its mode (writing or appending).
* The `ptr` request has been renamed to `pwh` (mnemonic: "Print WHen
traps will spring"). As a rule, debugging requests starting with `p`
correspond to a request name that manipulates the objects reported on
when the `p` is removed. However, `ptr` had nothing to do with the
`tr` request. The only exceptions to the stated rule of `p`-removal
are now `line`, `m`, and `stream`, none of which are request names.
* The `hla` request, when invoked with no arguments, now clears the
hyphenation language, disabling automatic hyphenation.
* The read-only registers `.m` and `.M` now interpolate "default" when
the default color is selected as the stroke or fill color,
respectively, rather than interpolating nothing.
* Numeric expression contexts that accept the `z` and `u` scaling
units, such as the `ps` request and `\s` escape sequence, now also
accept `p` and `s`.
* troff's `-c` command-line option now also removes the `color`
request's ability to enable multi-color output.
eqn
---
* The "gifont" primitive replaces "gfont" as the means of configuring
the global italic face in preprocessed equations. "gfont" remains
recognized as a synonym for backward compatibility. The new name is
intended to ease acquisition of the eqn language in light of GNU
eqn's thirty-year-old extensions "gbfont" and "grfont".
* New parameters tunable with the GNU eqn "set" primitive, "half_space"
and "full_space", enable a document to configure the space widths
produced by the eqn tokens '^' and '~', respectively. Previously,
their widths were determined by the "thin_space" and "thick_space"
parameters used to tune GNU eqn's automatic spacing computations.
* The new "reset" primitive restores a named parameter to its default.
groff
-----
* The groff command now encodes the fate of failing processes in the
pipeline it constructs and runs so that this information cannot be
confused with groff's own error conditions (such as a usage error,
which now produces an exit status of 2). See the section "Exit
status" of groff(1) for details.
* groff now passes the -S option to pic and troff if it is specified.
nroff
-----
* nroff now recognizes the -a, -D, -I, and -Z options and passes them
to groff.
* nroff now supports clustered options ("-tzms", for example) as groff,
troff, and other GNU getopt-using programs do.
pic
---
* A new command, `polygon`, supports drawing polygons using arbitrary
vertices. The command furthermore accepts the `fill[ed]` modifier.
You can address a polygon's vertices and the midpoints of its edges
with the new `.v[er[tex]]` and `.mid[point]` syntax suffixed to an
object identifier, analogously to the existing compass point and
`.c[enter]` feature. Thanks to Duncan Losin.
* pic's -S option now "locks" safer mode, rejecting any subsequent
specification of -U on the command line with an error diagnostic.
soelim
------
* soelim no longer requires embedded space characters in `so` arguments
to be backslash-escaped. (It continues to support that syntax, even
though neither the AT&T nor GNU troff formatters ever have.) You can
now embed a sequence of leading spaces in the argument by prefixing
it with a with a neutral double quote character ("), which the
program discards. These changes are to better align this program's
parsing rules with the language of the formatter; consider the `ds`
and `as` requests.
Macro packages
--------------
* Keith Marshall's pdfmark package is no longer distributed with groff,
but is now separately maintained. Please visit
<https://savannah.nongnu.org/projects/groff-pdfmark> for the latest
version.
* mom version 2.6 is distributed with this release. It supports
multi-line headings. Thanks to Peter Schaffter.
* The device-specific macro files loaded by "troffrc" automatically on
startup, such as "html.tmac", no longer perform font translations for
some font names used by varieties of AT&T troff ('C', 'Hb', 'HX', and
several others).
These names are not portable: in AT&T troff, the font repertoire,
like the special character repertoire, was device-dependent. Since
groff 1.23.0, GNU troff diagnoses attempts to use nonexistent font
names. We recommend addressing such portability issues wherever
suits you: (1) in a document, perhaps by using `ie` and `el` requests
and the `.g` register to test whether the formatter claims support
for groff extensions, then `ie` and `el` again with the `F` groff
conditional expression operator to check for font availability, and
to perform font remappings with the groff `ftr` request as desired;
(2) doing so in your "troffrc" file; or (3) by modifying these macro
files similarly. Users of the "dvi" and "lbp" output devices should
be aware that these devices don't supply full families of monospaced
fonts (and never have). See grodvi(1) and grolbp(1) for lists of
font names supported by each device.
The legacy names are retained for the "pdf" and "ps" devices for this
release; however, use of them prompts one warning in the "font"
category from the formatter per deprecated name. We expect to
withdraw support for the names completely in a future groff release.
See gropdf(1) and grops(1) for lists of font names supported by each
device.
* Hyperlink support is now enabled by default on PDF and terminal
devices for an (man) and doc (mdoc) documents. Instructions and
commented code for disabling it are in the "man.local" and
"mdoc.local" files.
* The `PDFPIC` macro implemented in the "pdfpic.tmac" macro file now
uses identify(1) (from ImageMagick/GraphicsMagick) and file(1), if
available, to attempt to determine the dimensions of an image to be
embedded in a PDF document. See also the item regarding gropdf(1)
below. Thanks to Deri James.
* The an (man) package now supports use of its hyperlink macros (`UR`,
`UE`, `MT`, and `ME`) in paragraph tags (that is, on the next line
after a `TP` macro call). Use of the `MR` man page cross reference
macro in a tag was already supported in groff 1.23.0.
* The behavior of the an (man) package's `SY` and `YS` macros has been
expanded to enable greater user control over vertical spacing and to
make them convenient for synopsizing C language functions, not just
commands. `SY` no longer puts vertical space on the output, and
initially breaks the output line _only_ if it is encountered
repeatedly without a preceding `YS` call. The computed indentation
of synopsis lines after the first now also includes the width of
anything already on the output line, so that you can precede the `SY`
call with, for instance, the C language data type used for the return
value in a function prototype. The `SY` macro now accepts an
optional second argument. This second argument is typeset in bold,
replaces the fixed-width space that is appended to the synopsis
keyword in `SY`'s single-argument form, and is used in computation of
the indentation of non-initial synopsis lines. However, this
computed indentation can now also be overridden with that of the
previous synopsis item. To do this, give any argument to the `YS`
macro call "closing" the synopsis whose indentation you want to
reuse. When you're done with such a grouped synopsis, leave the
argument off the final `YS` call.
In a "Synopsis" section of a man page, existing synopses consisting
of a single item require no migration. This is the most common case.
For others, where before you would write...
.SY mv
.I source
.I destination
.YS
.
.SY mv
.I source
\&.\|.\|.\&
.I destination-directory
.YS
...you would now write the following.
.SY mv
.I source
.I destination
.YS
.
.P
.SY mv
.I source
\&.\|.\|.\&
.I destination-directory
.YS
(That is, simply add a paragraphing macro.)
And where before you would write...
.SY mv
.B \-h
.
.SY mv
.B \-\-help
.YS
...you would now write the following.
.SY mv
.B \-h
.YS
.
.SY mv
.B \-\-help
.YS
(That is, simply add `YS` after the first synopsis item.)
Likely the biggest benefit of these changes is that it is now much
easier to format C function prototypes with these macros. Here's how
we would synopsize a somewhat complex standard C library function.
.B "#include <stdio.h>"
.P
.B void *\c
.SY bsearch (
.BI const\~void\~*\~ key ,
.BI const\~void\~*\~ base ,
.BI size_t\~ nmemb ,
.BI int\~(* compar )\c
.B (const\~void\~*, const\~void\~*));
.YS
* The an (man), doc (mdoc), and doc-old (mdoc-old) macro packages have
changed the default line length when formatting on terminals from 78n
to 80n. The latter is a vastly more common device configuration, but
that line length had been avoided since the groff 1.18 release in
July 2002 (prior to that, the line length was 65n, as in AT&T nroff),
for an undocumented reason. That reason appears to have been the
interaction of bugs in GNU tbl(1) with an aspect of grotty(1)'s
design. Those bugs have been resolved. A man(1) program can still
instruct groff to format for any desired line length by setting the
`LL` register on {g,n,t}roff's command line.
* The an (man) and doc (mdoc) macro packages use slightly different
vertical margins than previously, to align more closely with the
traditional implementations of these packages. Per man(7) in the
AT&T Unix System III manual (June 1980), the text area was 6.5 by 10
inches (on typesetters). When formatting for terminals with
continuous rendering disabled (by default, it is enabled), the page
footer now sets one line higher than before.
* The an (man) and doc (mdoc) macro packages have added additional
registers `BP`, `PO`, and `TS` for user configuration of man page
rendering at formatting time. As noted in groff_man(7) and
groff_mdoc(7), documents should never manipulate these.
* The an (man) and doc (mdoc) macro packages now support a `BP`
register to configure the ("base") paragraph inset amount; that is
the amount used by man(7) for paragraphs not within an `RS`/`RE`
relative inset, and in mdoc(7) for all paragraphs. Formerly, the
`IN` register configured this amount with other indentation and inset
amount parameters used by man(7). (In mdoc(7), it had no other
purpose.) The base paragraph indentation default is now 5n,
corresponding to that used by historical man(7) and mdoc(7)
implementations going back to Unix Version 7 (1979) and 4.3BSD-Reno
(1990), respectively.
* The an (man) and doc (mdoc) macro packages now support a `PO`
register to configure the page offset used by the formatter.
* The an (man) macro package now supports a `TS` register to configure
the minimum space required between the tag of a `TP` paragraph and
its body. (If the width of the tag's formatted text plus this space
exceeds the paragraph indentation, the line is broken after the tag.)
This parameter, formerly hard-coded as `1n`, now defaults to `2n`.
* The an (man) macro package's `IP` macro no longer honors the formerly
hard-coded 1n tag separation noted in the previous item. This means
that the first argument to the `IP` macro can abut the text of the
paragraph with no intervening space. If you use a word instead of
punctuation or a list enumerator for `IP`'s first argument, consider
migrating to `TP`.
* The "an-ext.tmac" macro file, loaded automatically by the an (man)
macro package, no longer defines `DS` and `DE` macros. It had
defined them as empty (undocumentedly) since groff 1.20 (2009).
* The doc (mdoc) macro package's `Mt` macro now sets its argument in
roman, not italics (or whatever the string `doc-Pa-font` was
configured to use). A new string, `doc-Mt-font`, for use in
"mdoc.local" files and similar, supports configuration of this face.
* The doc (mdoc) macro package now performs font family switches
inline (that is, on the same output line) to Courier much less
frequently when formatting for typesetters, affecting the `Ar`, `Cm`,
`Er`, `Fa`, `Fd`, `Fl`, `Fn`, `Ft`, `Ic`, `Li`, and `Nm` macros.
This change was made to reduce the ambiguity of space widths when
typesetting the monospaced Courier and proportional Times fonts
adjacently. Bear in mind that you can use the "mdoc.local" file to
customize the font used to render nearly any mdoc(7) macro's
arguments; this mechanism has been in place since 1992.
* The doc (mdoc) macro package's `Ql` macro now operates more simply;
it no longer (ever) quotes its arguments when formatting for
typesetters. In practice, it does not seem difficult to distinguish
even single characters in Courier from those in Times. (If it is, an
_explicit_ quoting macro like `Sq` or `Dq` should be used.)
* The doc (mdoc) macro package's `Lk`, `Mt`, and `Xr` macros now
produce hyperlinks on HTML, PDF, and terminal devices. See above
regarding hyperlink support being enabled by default.
* The doc (mdoc) macro package now honors the `U` register and `MF`
string as the an (man) package does.
* The new macro file "koi8-r.tmac" supports the KOI8-R character
encoding, which supports the new Russian locale for groff.
* The m (mm) macro package now uses a 3v bottom margin rather than 2v.
(Using the default type size and vertical spacing, the result is a
half-inch margin, just like the existing top margin.) When
formatting for terminals, content aligned to the bottom of the page
(footers, footnotes, `BS`/`BE` bottom blocks, and similar) now sets
one line higher than before. Further, the margin between the body
text and any page footers is now 2v, like that between the body text
and page headers, not 1v.
* The m (mm) macro package's `Limsp` register (a GNU extension) has
been removed; see the item regarding the `LI` macro below.
* The m (mm) macro package's `Le` register now defaults to `1`,
consistently with the `Lf`, `Lt`, and `Lx` registers of similar
purpose, but inconsistently with DWB 3.3 mm. Explicitly assigning
the `Le` register in a document's preamble works as it always has.
* The m (mm) macro package's `AST` macro (a GNU extension) is
deprecated, warns upon usage, and is slated for withdrawal in a
future release. Assign to the new string `Abstract` instead.
* The m (mm) macro package's `ISODATE` macro (a GNU extension) is
deprecated, warns upon usage, and is slated for withdrawal in a
future release. Assign to the new register `Isodate` instead.
* The m (mm) macro package's `EPIC` macro (a GNU extension) now
interprets its "width" argument in ens by default, and its "height"
argument in vees, instead of basic units, for consistency with the
rest of the package.
* Similarly, the m (mm) macro package's `PIC` macro (a GNU extension)
now interprets an argument to its `-I` option in ens instead of ems
by default.
* The m (mm) macro package no longer superscripts _and_ brackets a
reference mark (the `Rf` string). Instead, the new `Rfstyle`
register controls its formatting. The default, 0, selects bracketing
in nroff mode and superscripting in troff mode. Set `Rfstyle` to 3
in a document to obtain groff mm's previous mark formatting behavior.
* The m (mm) macro package's `Li` register now defaults to 5 ens (not
6) to align with the `Pi` register default.
* The m (mm) macro package's `Li` register now configures the text
indentation of items in `RL` lists (as it long has for `AL` lists)
instead of hard-coding a value of 6 ens as DWB 3.3 mm does.
* The m (mm) macro package's `BVL` (a GNU extension) and `VL` macros'
first arguments are now optional. If omitted, the paragraph
indentation amount (register `Pi`) is used for list items' text
indentations.
* The m (mm) macro package's `DL` macro now uses the `EM` string as the
mark instead of an em dash special character literal. (The latter
remains the default definition of the `EM` string.)
* The m (mm) macro package's `DS` macro now interprets its third
argument (a right-hand indentation) in ens by default, for
consistency with the rest of the package. This is a difference from
DWB mm (which passed the value unprocessed to the `ll` request, which
itself uses ems), and groff mm's own historical behavior, which used
basic units.
* The m (mm) macro package's `HU` macro now supports an optional second
argument as a GNU extension. It corresponds to the optional third
argument of the `H` macro.
* The m (mm) macro package's `IND` macro (a GNU extension), now calls
`SK` only if no `TXIND` macro is defined, instead of performing this
action as part of the fallback when no `TYIND` macro is defined.
* The m (mm) macro package now supports a user-definable hook macro
`AFX`, which if defined is called by `AF` in lieu of the latter's
normal operation. Applications include customization of letterhead.
* The m (mm) macro package now supports a user-definable hook macro
`RPX`, which if defined is called by `RP` in lieu of the latter's
normal operation (breaking the page [potentially], and formatting the
reference list caption string `Rp`).
* The m (mm) macro package's `LI` macro now interprets its second
argument as a Boolean value indicating whether a space should
separate the list item mark from its prefix (the first argument).
Thus, where you formerly specified "2" to indicate no such
separation, you would now use "0", matching the semantics of the
former `Limsp` register. "2" continues to be recognized and handled
as before, but prompts a warning; migrate your documents.
* The m (mm) macro package now supports an `Aumt` string to suppress
the appearance of positional arguments to the `AU` macro in the
document heading used by memorandum types 0-3 and 6. By default, all
such arguments appear, except the second (author initials). For
example, a value of "3 4" more accurately reproduces London &
Reiser's 1978 paper describing the porting of Unix to the VAX-11/780.
* The m (mm) macro package now supports an `Rpfmt` string specifying
the `LB` macro arguments that the package uses to format the items in
an `RP` reference list.
* The m (mm) macro package now supports the `E` register as DWB mm did.
* The m (mm) macro package now supports DWB mm's `Rg` string.
* The m (mm) macro package's `nP` macro now behaves more like DWB mm's.
It applies a temporary indentation to the second output line of a
paragraph to align it with the start of the paragraph text (not the
tag/label) in the first, and resets the paragraph counter when the
first- or second-level section heading number increments.
* The m (mm) macro package's `Iso` register is now named `Isodate` to
make its meaning less ambiguous. The old name remains as an alias.
* The m (mm) macro package's `Rpe` register is now named `Rpej` for
better symmetry with `Ej`. The old name remains as an alias.
* The m (mm) macro package has renamed several strings to make their
purposes less obscure; they determine the content of captions, not
list items.
`Licon` -> `Captc`
`Liec` -> `Capec`
`Liex` -> `Capex`
`Lifg` -> `Capfg`
`Litb` -> `Captb`
The old names remain as aliases.
* The m (mm) macro package has renamed the `Tcst` string to `Tcstatus`
to make its purpose less obscure. The old name remains as an alias.
* The m (mm) macro package recognizes new register names `Ftnum` and
`Rfnum` for the automatically incrementing footnote and reference
counters. The old, DWB-compatible but cryptic, names `:p` and `:R`
remain supported.
* The s (ms) macro package now sets the vertical spacing register
defaults for normal (`VS`) and footnote (`FVS`) text to 120% of the
type size configured in the `PS` and `FPS` registers, respectively,
rather than 2 points larger, to comport with generally accepted
typesetting principles. Thus, when formatting a document with a type
size of 20 points, the vertical spacing now defaults to 24 points
rather than 22.
* The s (ms) macro package now subtracts one vee from the footer trap
location computed using the `FM` register. When using the default
`FM` value of `1i`, this makes the size of the margin from the footer
baseline to the bottom of the page 3 vees or one half-inch,
consistently with that between the header baseline and the page top.
While a bug fix, and consistent with DWB 3.3 ms, this computation is
inconsistent with Seventh Edition Unix ms and Heirloom Doctools ms.
When formatting for terminals, footers now set one line higher than
before. The size of the footnote area is not affected; instead there
is a 1v smaller margin between its bottom and the footer baseline.
Output drivers
--------------
* grohtml(1), the (X)HTML output driver, supports a new `-k` command-
line option that takes a mandatory argument, either "ascii" or
"utf-8", which it recognizes case-insensitively. This feature
configures representation of character entities in the output. Based
on work by TANAKA Takuji.
* gropdf(1), the PDF output driver, now allows embedding of JFIF/JPEG
and JPEG 2000 image file formats. If PerlMagick is installed, many
more image file formats, including PNG, PAM, and GIF, can be
embedded. See also the item regarding `PDFPIC` above. Thanks to
Deri James.
* gropdf now supplies its own "SS" (slanted symbol) font to improve
rendering of documents requiring slanted lowercase Greek letters,
such as those employing the eqn(1) preprocessor. groff supplies the
font in PFB format, and gropdf automatically embeds it, as it is not
a standard PDF font. Formerly, groff's "pdf.tmac" file defined
fallback characters for lowercase Greek letters, applying a slant of
16 degrees to the upright glyphs available in the standard symbol
font "S". That technique produced glyphs slightly larger than those
in grops's "SS" font. Thanks to Deri James.
* gropdf now subsets embedded fonts by default, meaning that it stores
only the glyphs a document actually uses. Font subsetting usually
reduces the size of the PDF gropdf creates. Thanks to Deri James.
* gropdf supports a new `--opt` command-line option, permitting a few
features, including font subsetting, to be selectively enabled.
Thanks to Deri James.
* gropdf now emits PDFs that conform to the PDF 1.7 standard (also
known as ISO 32000). Its new `--pdfver` command-line option permits
production of PDF 1.4-conformant output instead. Thanks to Deri
James.
* gropdf supports a new `pdf: pagenumbering` device extension command
and `pdfpagenumbering` convenience macro, allowing control of the
page numbers in a PDF reader's overview panel. It is common for a
document to number early pages with Roman numerals and then restart
page enumeration at decimal 1 for its main matter. Thanks to Deri
James.
* gropdf now offers its own implementations of the "pdfmark" macro
package's "pdfhref" and other macros, supporting internal (bookmarks,
named destinations) and external (URL) hyperlinks, and the
specification of hotspots for link text. For example, when bundling
multiple man pages into a collection, as the supplied
groff-man-pages.pdf document and the Linux man-pages project do,
references to man pages within the collection are supported with
internal hyperlinks, and those outside with external ones. Thanks to
Deri James.
* gropdf now supports characters outside the Unicode Basic Latin subset
in bookmarks, named destinations, and external hyperlinks. (They
must be encoded using groff's Unicode special character escape
sequences; the preconv preprocessor is helpful to simply this
requirement.) Thanks to Deri James.
* gropdf now recognizes a `GROPDF_OPTIONS` environment variable,
interpreting it as a space-separated list of command-line options.
Explicit command-line options override any settings from this
environment variable. You can use this variable to obviate passing
options to gropdf via groff's `-P` option. Thanks to Deri James.
* grops(1), the PostScript output driver, now supports fonts encoded
using UTF-16. Indicate the encoding by including the string
"-UTF16-" within the font's name as specified by the "internalname"
directive in its font description file. Thanks to TANAKA Takuji.
* The PostScript output driver grops(1) no longer accepts spaces as
field separators in its "download" file; this is so that spaces can
appear in font file names, and to better align the syntax of this
file with that used by gropdf(1). The download file for grops
shipped by groff has long used tabs rather than spaces for field
separation.
* The PostScript output driver grops(1)'s macro file "ps.tmac" no
longer defines fallback special characters `\[S ,]` and `\[S ,]` to
simulate support for what Unicode calls LATIN {CAPITAL,SMALL} LETTER
S WITH COMMA BELOW. The file's definition constructed these glyphs
by overstriking the Basic Latin "S" (or "s") with a cedilla accent,
which is regarded as less orthographically acceptable than in the
past. A user's document or macro file can still do exactly what
"ps.tmac" used to.
.fchar \[S ,] \o'S\[ac]'
.hcode \[S ,]s
.fchar \[s ,] \o's\[ac]'
.hcode \[s ,]s
* The PostScript output driver grops(1) once again accepts a file name
containing slashes as a document prolog or resource (such as a font
to be downloaded into the document). This is a restoration of groff
1.22.4 and earlier behavior; groff's 1.23.0 change of not accepting a
file name containing slashes as an encoding or font description
remains in place. (We impose this restriction because the output
driver interprets the contents of these files; it does not interpret
the PostScript prolog or resource files.)
* grotty(1) now supports devices recognizing ECMA-48/ISO 6429 SGR 38
and 48 escape sequences that select RGB colors using 8 bits per color
channel. A new command-line option, `-t`, configures emission of
these escape sequences instead of the SGR 30-37 and 40-47 sequences
supporting 3- or 4-bit color. Thanks to Deri James.
Example:
$ groff -T utf8 -P -t <<EOF
.defcolor pink rgb #ffc0cb
.defcolor springgreen rgb #00ff7f
Hello, \f[B]\m[pink]colorful \m[springgreen]world\m[default]\f[]!
.pl \n[nl]u
EOF
* gxditview(1), the X11 output driver and document previewer, now
accepts the option `-v` as a synonym of `--version` (and `-version`).
This change aligns it with other groff output drivers, and makes it
work correctly with "groff -vX".
Utilities
---------
* afmtodit now recognizes a '-q' option to suppress diagnostics
reporting duplicate mappings in favor of a count thereof, and the
"BuildFoundries" script uses it. Recent versions of the URW fonts
have tons of duplicate mappings (for groff's purposes) and to our
knowledge these are all harmless.
* grog no longer supports the `--ligatures` and `--run` options.
Simulate the former (which was specific to the "pdf" output device)
with the option sequence "-P -U -P y", and the latter by using the
command substitution feature of your shell; see section "Examples" of
groff(1).
* groff now offers install-font.bash, a shell script that interactively
assists the configuration of fonts for use with the GNU troff
formatter and the gropdf and grops output drivers. For now, it is
provided as an example, as it lacks a man page. You can change to
its directory and run "bash install-font.bash -H" for a man page-like
description of its features and operation.
Miscellaneous
-------------
* The contributed programs gperl and gpinyin no longer accept
abbreviated forms of the long options `--help` and `--version`. The
respective synonymous short options `-h` and `-v` remain.
* Font description files now support a variant of the "charset"
directive: "charset-range" works like the existing "charset"
directive except that the glyph descriptions use a `name` of the form
"uEEEE..uFFFF" (where "EEEE" and "FFFF" are hexadecimal digit
sequences), and apply the metrics identically to all glyphs in the
designated range. Thanks to TANAKA Takuji.
* groff now ships font description files usable with the "ps", "html",
"xhtml", and "utf8" output devices to support East Asian fonts.
(Caveat: with few exceptions, groff does not ship font files
themselves.) These are intended as abstractions of faces to permit
consistent naming while allowing custom font selections, just as with
the 12 text typefaces supported across output devices for Latin
scripts in groff (three families of four styles each). These CJK
font descriptions are not organized into groff font families, but are
similarly arranged.
CSH: Simplified Chinese, Hei style
CSS: Simplified Chinese, Song style
CTH: Traditional Chinese, Hei style
CTS: Traditional Chinese, Song style
JPG: Japanese, Gothic style
JPM: Japanese, Mincho style
KOG: Korean, Gothic style
KOM: Korean, Mincho style
Thanks to TANAKA Takuji.
* The commands addftinfo, grodvi, post-grohtml, grolbp, grolj4, grops,
grotty, eqn, pre-grohtml, gxditview, pic, preconv, refer, soelim,
tbl, groff, troff, hpftodit, indxbib, lkbib, lookbib, tfmtodit, and
xtotroff now exit with status 2 instead of 1 on usage errors. grn
now exits with status 2 on a usage error instead of a successful
status (0).
* Support for terminal devices using the CCSID 1047 (EBCDIC) encoding
has been withdrawn. This change partially clears the way for GNU
troff to interpret UTF-8 input directly (without preconv(1)
preprocessor usage) in the future. Use iconv(1) to convert a code
page 1047 document to US-ASCII or ISO Latin-1 prior to its input to
GNU troff. preconv(1), and therefore groff(1)'s `-k` and `-K`
options, can do this as well if preconv is built with iconv support.
Use `preconv -v` to determine this fact.
* groff's "configure" script now tries harder to determine an
appropriate paper format for the system; its output reports how it
made its determination. Any existing "/etc/papersize" file is one of
the resources it consults.
* groff's "configure" script now supports a "--without-urw-fonts"
option, for use on systems where the URW replacement fonts for
PostScript and PDF standard fonts are unavailable or not desired. It
also silences the lengthy warning the script issues when these fonts
and their metric files are not found. Configuring without URW font
support reduces the gropdf(1) output driver's functionality; see
subsection "Feature service levels and URW font support" of that man
page for details.
* You can now specify any paper format you like--including the file
specification "/etc/papersize" for systems using "libpaper"--as the
default that the groff build writes to generated device description
files ("DESC") for the "dvi", "lbp", "lj4", "pdf", and "ps" output
drivers. (The paper format must still be valid; see groff_font(5).)
Example: ./configure PAGE=/etc/papersize --prefix=/opt/gnu
* Building groff no longer requires the PSUtils package.
* Building groff no longer requires the makeinfo command. Since groff
1.23.0, we ship groff's Texinfo manual in several formats as part of
groff's distribution archive. We ask that distributors provide their
users with all formats appropriate to the platform (GNU Info, HTML,
plain text, TeX DVI, and PDF). Thanks to onf.
* Polish language input documents are now supported, including
hyphenation patterns from the CTAN project and localized strings
for the man, ms, me, mm, and mom packages. Thanks to Dariusz
Chilimoniuk.
* Russian language input documents using the KOI8-R encoding are now
supported, including hyphenation patterns from the ruhyphen project
and localized strings for the man, ms, me, mm, and mom packages.
Thanks to Nikita Ivanov.
* Spanish language input documents are now supported, including
hyphenation patterns from the hyph-utf8 project and localized strings
for the man, ms, me, mm, and mom packages. Thanks to Eloi Monta<F1><E9>s.
* The localization macro files now set up an appropriate hyphenation
mode default. For Chinese and Japanese, this is zero.
* If groff programs have their current time overridden by the
SOURCE_DATE_EPOCH environment variable, then that time is always
displayed in UTC. That environment variable is normally only set
when specifically requesting build systems to produce reproducible
output, and it is useful for reproducibility test harnesses to vary
the TZ environment variable and ensure that it does not affect the
output of the build; those harnesses have no way to set TZ=UTC only
for groff programs. People setting SOURCE_DATE_EPOCH are likely to
be more in the "system programmer" camp as described in the release
notes for 1.23.0, so it is easier to defend time-zone-invariant
output to them. In all other cases, the current time remains
displayed in local time. Thanks to Colin Watson.
* The minimum version of Perl required to build groff is now 5.8 (18
July 2002), incremented from 5.6.1.
* groff now looks for the Netpbm program pamcut(1) rather than
pnmcut(1). Per its developers, the former was introduced in 2001
ago and the latter withdrawn in 2009.
* The Makefile macro `DEVICE` has been renamed to `DEFAULT_DEVICE`; be
aware if your builds don't use "ps" as the default output device.
* The groff_diff(7) man page no longer contains examples. They remain
in groff's Texinfo manual.
* groff's Texinfo manual now adapts its content to the groff command
prefix configured at build time. If the build is configured without
a leading "g"--omitting it has been groff's default for many years,
possibly forever--then our Texinfo manual now omits that prefix when
mentioning the affected commands (all replacements for AT&T troff
commands). This way, if you select a command prefix, say "limbo",
and rebuild the Texinfo manual, the manual reflects the prefix used
by your build configuration, and talks about "limboeqn",
"limbotroff", "limborefer", and so on.
groff: Fix another regression in previous update. Remove pdfmark.pdf from PLIST, it is already in PLIST.docs where it belongs.
groff: Fix regression in previous update.
groff: fix -x11 build.
groff: fixed missing gnu directory and g prefixed commands
groff: update to 1.23.0 - Major documentation overhaul - Many bug fixes and improvements
Update to 1.22.4 Changelog: VERSION 1.22.4 ============== Troff ----- o The `hy' request has been extended. Value 16 enables hyphenation before the last character, and value 32 enables hyphenation after the first character. PDFPIC ------ o PDFPIC has been corrected so the behaviour is the same whether you use the PostScript or PDF drivers. However, this means that any documents which were written using the old behaviour will not be rendered correctly if using the PDF driver with the new version. The change would mean that documents which relied on the previous behaviour are likely to have a gap underneath the image which was not there before. If you see this effect there are three ways you can restore the previous behaviour: Add the line ".nr PDFPIC_NOSPACE 1" to the document before the first call to .PDFPIC. If it is just a single document which exhibits this behaviour you can run groff adding "-rPDFPIC_NOSPACE=1" to the command line. If you have many documents which rely on the previous behaviour you can set an environment variable "export GROFF_PDFPIC_NOSPACE=1" which will restore the previous behaviour for all runs. Note that this change has no effect if you were using .PDFPIC with the PostScript driver--only if you used it with the PDF driver. Gropdf ------ o Type 1 font loading is fixed to handle newer Ghostscript versions. o Handling of glyphs above position 255 is improved to allow many more glyphs to be used. o New macros .pdftransition and .pdfpause are introduced to allow creation of presentation slides. Partially backward-compatible with present.tmac, specifically the PAUSE, BLOCKS and BLOCKE commands. Supports all the transition types introduced in PDF v1.5 (see the gropdf man page). Miscellaneous ------------- o A new 'configure' option --with-compatibility-wrappers controls how groff compatibility wrappers for vendor-provided non-GNU macro sets are installed (see ./configure --help). o eqn2graph, grap2graph, and pic2graph now attempt to adapt to very old installed versions of the ImageMagick and GraphicsMagick programs "convert". They search the output of convert's "-help" option, and use "-trim" if that string is found; otherwise, the old "-crop 0x0" method (which produces incompatible results on versions that _do_ support "-trim") is used. The programs emit a warning to standard error if the search fails and the old method is used. o eqn2graph no longer supports the "-unsafe" option. It did nothing. o groffer now supports the output of XHTML. Use the "--xhtml" or "--mode=xhtml" command-line options to generate it. o Much work has been done, and is ongoing, to make groff's man pages better examples for man page writers to follow. groff_man(7) itself has been expanded and largely rewritten to more precisely document the macro package's behavior and to be more helpful and accessible to man page writers who may never read any other groff documentation.
Update PLIST.{,docs} in order to fix building of groff without the `groff-docs'
option.
Bump PKGREVISION
Noticed by and thanks to Hiroshi Hakoyama via PR pkg/51896.
gnu updates for groff with special fixup for chem.1 manpage not g' prefixed add dependency to gtexinfo when building docs remove special SunOS processing which seems unnecessary now. TODO: there are still some apparent fonts issues indicated in the build logs
Update to 1.22.3:
VERSION 1.22.3
==============
Gxditview
---------
o X11 resources for `gxditview', which were previously installed in
/usr/X11/lib/X11/app-defaults no matter which `prefix' was set, are
now installed in appresdir=$prefix/lib/X11/app-defaults. If
`appresdir' is not a standard X11 resource directory, the environment
variable XFILESEARCHPATH should be set to this path. The standard
default directories depends on the system `libXt'. Common directories
include:
/usr/lib/X11/app-defaults
/usr/share/X11/app-defaults
/etc/X11/app-defaults
Note that if the option `--with-appresdir' is passed to `configure',
the `prefix' will not be added to `appresdir'.
Glilypond
---------
o This new preprocessor (contributed by Bernd Warken) allows embedding of
code for GNU LilyPond (http://www.lilypond.org), a music typesetter. The
data gets automatically processed and embedded as EPS images.
Gperl
-----
o Bernd Warken contributed a new preprocessor to handle Perl code that can
be evaluated and then processed by groff.
Gpinyin
-------
o Another preprocessor from Bernd Warken to pretty-print Pinyin syllables
like `guo2wang2' as `guówáng'.
Pdfroff
-------
o The pdfroff utility script now activates its `--no-toc-relocation' option
by default, unless a request similar to:
.if !\n[PHASE] .tm pdfroff-option:set toc_relocation=enabled
is invoked during input file processing; (`.if !\n[PHASE] ...' ensures
that the effect of the `.tm' request is restricted to the document setup
phase of processing, as pdfroff sets it to 1 or 2 in the output phase,
but leaves it unset in the setup phase).
The bundled `spdf.tmac' macro package, which implicitly activates
`-mpdfmark' for `ms' macro users, ensures that TOC relocation is
appropriately enabled, when the `.TC' macro is invoked.
Macro Packages
--------------
o The -mom macro package now has full support for eqn, pic, and tbl, as well
as captioning and labelling of pdf images and preprocessor output. Lists
of Figures, Equations, and Tables can now be autogenerated. PDF_IMAGE has
a new FRAME option.
o A French introduction to the -me macro package has been added (file
`meintro_fr.me').
o In -mdoc, command %C is now available, providing a city or place
reference.
VERSION 1.22.2
==============
Tbl
---
o The character `#' can now be used as an eqn delimiter within tables.
Eqn
---
o A GNU extension
delim on
has been added to reactivate delimiters which have been disabled with
`delim off'.
VERSION 1.22.1
==============
(There was no release 1.22.)
Groff
-----
o A new option `-j' has been added to call the `chem' preprocessor.
Tbl
---
o Improved line numbering support.
Macro Packages
--------------
o Support for the `refer' preprocessor has been added to the -mm macro
package.
o In -me, the `TH' macro was changed for compatibility with line number
support in tables.
`bl' now works inside of blocks.
The behaviour of centered blocks has been improved.
Line numbering support has been improved.
o The -mom macro package has reached version 2.0, focusing on PDF output
with gropdf (using the new `pdfmom' wrapper script). See the file
`version-2.html' of the -mom documentation for a list of the many changes.
o Some generic Unicode fallback characters (mainly Roman numerals) have been
added.
Gropdf
------
o A new driver for generating PDF output directly, contributed by Deri James
<deri@chuzzlewit.myzen.co.uk>. Note that this driver is written in Perl,
thus you need a working Perl installation to run this output device.
Pdfmom
------
o A new wrapper around groff that facilitates the production of PDF
documents from files formatted with the -mom macros.
VERSION 1.21
============
Troff
-----
o The new `lsm' request specifies a macro to be invoked when leading spaces
in an input line are encountered (which are removed then). Number
registers `lsn' and `lss' hold the number of removed leading spaces and
the corresponding horizontal space, respectively.
o There is a new warning category `file', enabled by default. The `mso'
request emits warnings in this category when the requested macro file does
not exist.
o The new `class' request assigns a short name to a set of characters
which can be referred to in the `cflags' request. This is especially
useful to control line-breaking and hyphenation rules in CJK languages.
o Three new values for the `cflags' request have been added, which are
needed for proper CJK support.
128 prohibit before but allow break after character
256 prohibit after but allow break before character
512 allow break before and after character
Tbl
---
o A new global option `nowarn' suppresses warnings if tables are longer than
the current line width.
Afmtodit
--------
o New option `-o' to specify the name of the output file.
Macro Packages
--------------
o A new macro `%U' has been added to the mdoc package to indicate a URL
reference within an .Rs/.Re environment.
o Rudimentary support for the Japanese script has been added, most suitable
for man page handling as output by grotty. The file `ja.tmac' contains
the necessary setup to allow line breaks before and after CJK characters
(with proper exceptions). Note, however, that no inter-character spacing
is implemented yet -- this usually causes many warnings about bad line
breaks.
Installs chem now, so add it to the PLIST, fix the interpreter path and bump revision.
Bypass a troff check in configure to stop introducing an unneeded g-prefix on SunOS, brings PLIST consistency across operating systems.
Give up trying to code for the various tmac prefix cases and just do that part dynamically.
resolve lib/charset.alias conflicts. PR pkg/42199
Rearrange how the conditional plist substitutions are done to be more flexible. Adjust Solaris case to not expect gan.tmac. Fixes PR 35295. Bump PKGREVISION as a precaution.
Convert @exec/@unexec to @pkgdir or drop it.
Remove @dirrm entries from PLISTs
Update to 1.20.1:
VERSION 1.20.1
==============
A packaging error made it necessary to publish this release. No
user-visible changes.
VERSION 1.20
============
Groff
-----
o XHTML support has been added to grohtml and can be specified by
-Txhtml. This option also utilizes the MathML capability of
eqn and combines the outputs of both in the final XHTML file.
Users can also specify the `-P-V' option together with `-Txhtml'
in groff. This has the effect of creating an XHTML validator
button at the bottom of each page.
o Some options have been added to control a new preprocessor,
`preconv' (see below): `-k' activates it, `-K' sets the input
encoding, and `-D' sets the default encoding.
o A new environment variable `GROFF_ENCODING' sets the encoding
of input files; it implies command option `-k'.
Troff
-----
o Two new requests `device' and `devicem' have been added which are
equivalents to the \X and \Y escapes, respectively.
o A new read-only number register `.br' is available which is set to 1
if a macro is called as .foo and to 0 if called as 'foo. This allows to
reliably modify requests.
.als bp@orig bp
.de bp
. tm before bp
. ie \\n[.br] .bp@orig
. el 'bp@orig
. tm after bp
..
o A new request `fzoom' has been added to adjust the optical size of a
font in relation to the others. The zoom factor is given in integer
multiples of 1/1000th. In the following example, the CR font is
magnified by 10% (the zoom factor is 1.1).
.fam P
.fzoom CR 1100
.ps 12
Palatino and \f[CR]Courier\f[]
The new number register `.zoom' holds the zoom value of the current font,
in multiples of 1/1000th.
o The `cflags' request has been extended with a new flag value 64, to be
used in combination with values 2 (break before character) and 4 (break
after character). If set, the hyphenation codes of the surrounding
characters are ignored.
o A new debugging request, `pev', has been added to print all of the current
known environments to stderr. It first prints the state of the current
environment, then iterates through all of the known environments, printing
each except the one that is current.
o A new escape `\$^' has been added. It represents the parameters of a
macro as if they were an argument to the `ds' request. This is used by
`trace.tmac'.
o A new read-only number register `.O' is available which returns the
current suppression level as set by the `\O' escape.
o The space width emitted by the `\|' and `\^' escape sequences can be
controlled on a per-font basis. If there is a glyph named `\|' or `\^',
respectively (note the leading backslash), defined in the current font
file, use this glyph's width instead of the default value.
This behaviour is not new, but hasn't been documented before.
Nroff
-----
o Two new command line options `-w' and `-W' are accepted and passed to
groff to enable and disable warning messages, respectively.
Preconv
-------
o This is a new preprocessor to convert various input encodings to something
groff understands (this is, ASCII and \[uXXXX] entities, with `XXXX' a
hexadecimal number with 4 to 6 digits, representing a Unicode input code).
Normally, preconv should be invoked with options `-k' and `-K' of groff.
See the preconv man page for details.
Pic
---
o int(x) now really behaves as documented: It truncates the non-integer part
of x, this is, it rounds towards zero and not towards the next integer
less than or equal to x.
o Pic now supports up to 32 macro arguments (and up to 16 on EBCDIC
platforms).
o Heinz-J
`yslanted', which can change the shape of boxes into arbitrary
parallelograms.
Tbl
---
o Latest versions of DWB tbl introduced an `x' column specifier for a single
column expanded to the line width. GNU tbl has now been extended to
support even multiple `x' specifiers within a table.
o To avoid collision with the new `x' specifier, a block formatting macro
must now be selected with specifier letter `m'.
Eqn
---
o Eric S. Raymond has added a new device type to eqn, MathML. When
-TMathML is enabled, eqn now emits MathML formula markup rather than
groff commands. The new groff -Txhtml device uses this.
Chem
----
o The preprocessor `chem' was added. `chem' is a roff language to generate
chemical structure diagrams. It generates `pic' output.
Grops
-----
o The PS font definition files have been regenerated with newer AFM versions
from Adobe's 35 core fonts as present in most Level 2 PS printers. The
changes are minor (most notably, the addition of the `Euro' glyph and an
extended set of kerning values).
For backwards compatibility, the old set of font definition files is still
available; for details please read the man page of grops.
Grotty
------
o \D'p...' is now supported if the polygon consists entirely of horizontal
and vertical lines.
Grohtml
-------
o XHTML support has been added.
o New command line option `-V' (to be used in XHTML mode) to produce an
XHTML validator button.
o New command line option `-y' to produce a right-justified groff signature
at the end of the document (in combination with option `-V').
Gxditview
---------
o Support for keyboard navigation has been improved.
o Similar to other X11 applications, there are now two resource files,
`GXditview' and `GXditview-color'.
Groffer
-------
o `groffer' version 1.* exists now in a shell and a Perl version.
Afmtodit
--------
o New option `-c' to output more font information as comments.
o New option `-k' to suppress output of kerning data.
o New option `-f NAME' to set the internal name of the groff font.
Macro Packages
--------------
o Joachim Walsdorff contributed the `hdtbl' package for the generation of
tables, using a syntax very similar to the HTML table model. For
example, a table with two cells and two rows looks like this:
.TBL cols=2
. TR .TD 1*1 .TD 1*2
. TR .TD 2*1 .TD 2*2
.ETB
Here the same table using a more expanded syntax:
.TBL cols=2
. TR
. TD 1*1
. TD 1*2
. TR
. TD 2*1
. TD 2*2
.ETB
Tables can be nested; `hdtbl' works without a preprocessor so that the
full capability of groff's macro engine is available.
This package currently works with `-Tps' only.
o -mandoc now supports multiple man pages (in either man or mdoc format).
o Fabrice M
possible to get French localization of the main macro packages (-ms, -mm,
-me, and -mom, but not -man and -mdoc which are localized differently) by
appending `-mfr' to the list of macro packages. Example:
groff -ms -mfr foo > foo.ps
Note that latin-9 input encoding is used for French (to support the `oe'
ligature).
o Swedish macro localization (with `-msv') has been added.
o German macro localization (with `-mde' and `-mden' for traditional and
new orthography, respectively) has been added.
o Czech macro localization (with `-mcs') has been added.
Note that latin-2 input encoding is used for Czech.
o A new macro `Dx' has been added to the mdoc package which identifies the
DragonFly OS.
o If mdoc is used to print multiple man pages (together with the -rcR=0
command line option), each man page now starts a new page.
o -mtrace has been considerably improved, now showing number and string
register assignments, among other things. See the groff_trace man page
for details.
o The PSPIC macro now works with all devices (producing a hollow
rectangle on devices which don't support inclusion of PS images) and
is loaded in troffrc at start-up.
o A new auxiliary macro package `62bit' has been added which provides some
macros for adding, multiplying, and dividing signed 62bit integers (mainly
to handle normal groff number operations without risking overflow errors).
o For -ms, Eric S. Raymond contributed support for ancient Bell Labs
localisms `.SC', `.UC', `.P1', and `.P2'. The latter three are enabled
only after .SC is called.
o A new string, `SN-STYLE', has been added to the ms macros, controlling
the formatting of section numbers in headings defined by `.NH'.
o The new macro package `ptx' provides a template definition for the `.xx'
macro as needed by GNU ptx (for creating permuted indices).
Yet another tmac PLIST fix. This whole mess needs to be cleaned up and sanitised.
OSF1 needs getopt_long like IRIX. Add another PLIST conditional for OSF1.
Fix PLIST problem on HP-UX.
Add groff-docs option, enabled by default. When turning it off, you can get rid of the netpbm, psutils, and ghostscript dependencies. Might help in bootstrapping some platforms. Based on a patch from schmonz@. While here, improve PLIST by trying to remove an additional directory and bump PKGREVISION for that.
List info files directly in the PLIST and honor PKG{INFO,MAN}DIR.
(Hopefully) fix Solaris PLIST. Addresses PR 32966 by Neil Hoggarth.
Update to 1.19.2. SunOS PLIST not updated, someone please merge
it into the normal PLIST.
VERSION 1.19.2
==============
Troff
-----
o Analogously to the .ft and \f pair, two new requests `gcolor' and
`fcolor' (which pair with \m and \M, respectively) have been added to
set the glyph and background colours.
o A new read-only, string-valued register `.sty' returns the name of the
current style.
o Two new conditional operators `F <name>' and `S <name>' have been added.
`F' is true if a font <name> exists. `S' is true if a style <name> has
been registered.
o Cyrillic characters have been added to the `utf8' and `html' output
devices.
Pic
---
o The `by' argument in a `for' loop can now be negative if it is additive.
For the multiplicative case, it must be greater than zero.
Eqn
---
o The following keywords aren't new but haven't been documented previously:
undef NAME (to undefine a macro)
copy "FILE" (a synonym for `include')
space n (to modify the vertical spacing before and after
an equation)
o The following macros aren't new but haven't been documented previously:
Alpha, ..., Omega (the same as `ALPHA', ..., `OMEGA')
ldots (three dots on the base line)
dollar (a dollar glyph)
o The following keywords have been extended. Again, this isn't new but
hasn't been documented previously:
col n { ... }
lcol n { ... }
rcol n { ... }
ccol n { ... }
pile n { ... }
lpile n { ... }
rpile n { ... }
cpile n { ... } (set vertical spacing between rows to N)
Grohtml
-------
o This device driver has been raised to beta stage; its set of tags should
be stable now.
o New command line option `-s' to set the base point size.
o New command line option `-S' to set the split level while generating
multiple files.
Grotty
------
o Experimental support for zero-width and double-width characters.
Gxditview
---------
o On platforms which have the X Window System this program is now built and
installed automatically.
Xtotroff
--------
o This program to create font definition files for xditview isn't new but
hasn't been installed previously.
Groffer
-------
o A security problem (reported as CAN-2004-0969) has been fixed.
Gdiffmk
-------
o A new script contributed by Mike Bianchi. It compares two groff, nroff,
or troff documents and creates an output with added margin characters
(using `.mc') to indicate the differences.
Pdfroff
-------
o A new wrapper script contributed by Keith Marshall to easily create PDF
documents with groff.
Macro packages
--------------
o ms.tmac
. Support for fractional point sizes: A value for the `PS', `VS', `FPS',
and `VPS' register larger than or equal to 1000 is always divided by
1000. For example, `.nr PS 10250' sets the document's font size to
10.25 points.
. The `Ds' and `De' macros provided in ms since groff version 1.19 have
been removed; the equivalent `DS' and `DE' macros should be used
instead. X11 documents which actually use `Ds' and `De' always load a
specific macro file from the X11 distribution (`macros.t') which
provides proper definitions for the two macros.
. The following registers have been added for improving layout control:
PORPHANS
Defines number of lines following `LP', `PP', `QP', `IP' or `XP' which
must be kept together, before any automatic page break.
HORPHANS
Sets number of lines of following paragraph which must be kept with a
heading, defined by `NH' or `SH', before any automatic page break.
GROWPS
Sets the first level of heading (set with `NH') which will keep the
same point size as body text.
PSINCR
Sets the point size increment for each level of heading (set with
`NH'), below the threshold level set by `GROWPS'; e.g., if
\n[PS] = 10, \n[GROWPS] = 3 and \n[PSINCR] = 2.0p, then `.NH 1' will
produce 14pt headings, `.NH 2' will produce 12pt, and all other levels
will remain at 10pt (because \n[PS] = 10).
. The `SH' macro now accepts a numeric argument, to make heading size
match that of `NH' with same argument value when the `GROWPS'/`PSINCR'
feature is enabled.
Please refer to the documentation of the ms package for other, minor
improvements.
o me.tmac
The section type set with the `++' request is available in the `_M'
register. This isn't new but hasn't been documented before.
o www.tmac
The `HR' macro no longer causes an empty line for non-HTML devices.
A new macro `HEAD' has been added to directly add data to the
<head>...</head> block.
New macros `OLS' and `OLE' to start and end an ordered list.
New macros `DLS' and `DLE' to start and end a definition list.
Pdfmark
-------
o A new macro package contributed by Keith Marshall which implements PDF
marks. This is in alpha stage currently.
Miscellaneous
-------------
o Two new keywords to the DESC file have been added which are needed for
grohtml: `image_generator' and `unscaled_charwidths'. The former gives
the name of the program which creates PNG images, and the latter makes
troff always use unscaled character widths.
Update to 1.19.1:
Groff
-----
o The argument of the command line option `-I' is now also passed to troff
and grops, specifying a directory to search for files on the command line,
files named in `so' and `psbb' requests, and files named in \X'ps: file'
and \X'ps: import' escapes.
o If option `-V' is used more than once, the commands will be both printed
on standard error and run.
Troff
-----
o Two new read-only, string-valued registers `.m' and `.M' return the
name of the current drawing and background color, respectively.
o New read-only register `.U' which is set to 1 if in safer mode and set
to 0 if in unsafe mode.
o An input encoding file for latin-5 (a.k.a. ISO 8859-9) has been added.
Example use:
groff -Tdvi -mlatin5 my_file > my_file.dvi
Note that some output devices don't support all glyphs of this encoding.
o If the `return' request is called with an argument, it exits twice,
namely the current macro and the macro one level higher. This is
used to define a wrapper macro for `return' in trace.tmac.
o For completeness, two new requests have been added: `dei1' and `ami1'.
They are equivalent to `dei' and `ami', respectively, but the macros
are executed with compatibility mode off (similar to `de1' and `am1').
o New command line option `-I' to specify a directory for files (both
those on the command line and those named in `psbb' requests). This is
also handled by the groff wrapper program.
o Since version 1.19 you can say `.vs 0'. Older versions emit a warning
and convert this to `.vs \n[.V]'.
This hasn't been documented properly. Note that `.vs 0' isn't saved in a
diversion since it doesn't result in vertical motion.
Pic
___
o Dashed and dotted ellipses have been implemented.
Tbl
---
o New key character `x' to make tbl call a user-defined macro on a table
cell. Patch by Heinz-Jürgen Oertel <hj.oertel@surfeu.de>.
Grap2graph
----------
o A new script contributed by Eric S. Raymond <esr@thyrsus.com>. It
converts a grap diagram into a cropped image. Since it uses gs and the
PNM library, virtually all graphics formats are available for output.
[Note that the grap program itself isn't part of the groff package;
see the file MORE.STUFF how to obtain grap.]
Grohtml
-------
o New option `-j' to emit output splitted into multiple files.
Grops
-----
o New command line option `-I' to specify a directory to search for files
on the command line and files named in \X'ps: import' and \X'ps: file'
escapes. This is also handled by the groff wrapper program.
o The default value for the `broken' keyword in the DESC file is now 0.
Grolj4
------
o A new man page `lj4_font(5)' documents how fonts are accessed with
grolj4.
o The built-in fonts for LJ4 and newer PCL 5 devices have been completely
revised, mainly to access as much glyphs as possible. The provided
metric files should be compatible with recent PCL 5 printers also.
Additionally, font description files have been added for the Arial and
Times New Roman family, the MS symbol, and Wingdings fonts.
Afmtodit
--------
o New option `-x' to prevent use of built-in Adobe Glyph List.
Hpftodit
--------
o Completely revised to handle HP TrueType metric files also. See the
hpftodit manual page for more details.
Groffer
-------
o This version is a rewrite of groffer in many parts, but it is kept in
the old single script style.
New options: --text, --mode text, --tty-viewer, --X, --mode X,
--X-viewer, --html, --mode html, --html-view, --apropos-data,
--apropos-devel, --apropos-progs.
New documentation file: README_SH.
Enhancement of the configuration files and the `apropos' handling.
Macro Packages
--------------
o www.tmac: New macro `JOBNAME' to split output into multiple files.
o In mdoc, multiple calls to `.Lb' are now supported in the LIBRARY
section.
Remove info files entries from PLIST.
Pull over some patches from src/ (disabling SGR and a bug fix). Add mdoc.local from src/gnu/usr.bin/groff/tmac. Convert to USE_NEW_TEXINFO. Bump PKGREVISION.
Add BUILD_DEPENDS on netpbm, and add thus installed images to PLIST. Bump PKGREVISION to 1.
Match example data up with reality of whats installed.
Update to 1.19.
Troff
-----
o Input encoding files for latin-9 (a.k.a. latin-0 and ISO 8859-15) and
latin-2 (ISO 8859-2) have been added. Example use:
groff -Tdvi -mlatin9 my_file > my_file.dvi
You still need proper fonts with the necessary glyphs. Out of the box,
the groff package supports latin-9 only for -Tps, -Tdvi, and -Tutf8,
and latin-2 only for -Tdvi and -Tutf8.
o Composite glyphs are now supported. To do this, a subset of the Adobe
Glyph List (AGL) Algorithm as described in
http://partners.adobe.com/asn/developer/typeforum/unicodegn.html
is used to construct glyph names based on Unicode character codes. The
existing groff glyph names are frozen; no glyph names which can't be
constructed algorithmically will be added in the future.
The \[...] escape sequence has been extended to specify multiple glyph
components. Example:
\[A ho]
this accesses a glyph with the name `u0041_0328'.
Some groff glyphs which are useful as composites map to `wrong' Unicode
code points. For example, `ho' maps to U+02DB which is a spacing
ogonek, whereas a non-spacing ogonek U+0328 is needed for composite
glyphs. The new request
.composite from to
will change the mapping while a composite glyph name is constructed.
To make \[A ho] yield the expected result,
.composite ho u0328
is needed. [The new file `composite.tmac' loaded at start-up already
contains proper calls to `.composite'.]
Please refer to the info pages of groff and to the groff_char man page
for more details.
o A new request `fschar' has been added to define font-specific fallback
characters. They are searched after the list of fonts declared with the
`fspecial' request but before the list of fonts declared with `special'.
o Fallback characters defined with `fschar' can be removed with the
new `rfschar' request.
o A new request `schar' has been added to define global fallback
characters. They are searched after the list of fonts declared with the
`special' request but before the already mounted special fonts.
o In groff versions 1.18 and 1.18.1, \D'f ...' didn't move the current
point horizontally. Despite of being silly, this change has been
reverted for backwards compatibility. Consequently, the intermediate
output command `Df' also moves the position horizontally again.
\D'f ...' is deprecated since it depends on the horizontal resolution of
the output device (given with the `hor' parameter in the DESC file).
Use the new \D'Fg ...' escape instead.
o For orthogonality, new \D subcommands to change the fill color are
available:
\D'Fr ...' (rgb)
\D'Fc ...' (cmy)
\D'Fg ...' (gray)
\D'Fk ...' (cmyk)
\D'Fd' (default color)
The arguments are the same as with the `defcolor' request. The current
position is *not* changed.
o The values set with \H and \S are now available in number registers
\n[.height] and \n[.slant], respectively.
o The `.pe' number register isn't new but hasn't been documented before.
It is set to 1 during a page ejection caused by the `bp' request.
o The new glyph symbol `tno' is a textual variant of `no'.
o The new glyph symbol `+e' represents U+03F5, GREEK LUNATE EPSILON SYMBOL.
(Well, it is not really new since it has been previously supported by
grolj4.) The mapping for both the dvi and lj4 symbol font has been
changed accordingly so that Greek small letter epsilon, `*e', has the
same glyph shape as with other devices.
Grops
-----
o The font `freeeuro.pfa' has been added to provide various default glyph
shapes for `eu' and `Eu'.
o It is now possible to access all glyphs in a Type 1 font, not only 256
(provided the font file created by afmtodit has proper entries). grops
constructs additional encoding vectors on the fly if necessary.
o The paper size is now emitted via the %%DocumentMedia and PageSize
mechanisms so that it is no longer required to tell `gv' or `ps2pdf'
about the paper size. The `broken' flag value 16 omits this feature
(the used PostScript command `setpagedevice' is a LanguageLevel 2
extension). Patch by Egil Kvaleberg <egil@kvaleberg.no>.
o Non-slanted PostScript metrics have been changed again; they no longer
contain negative left italic correction values. This assures correct
spacing with eqn.
Grodvi
------
o The font cmtex10 has been added as the special font `SC' to the DVI fonts.
It is used as a font-specific special font for CW and CWI.
o New options -l and -p to set landscape orientation and the paper size.
grodvi now emits a `papersize' special which is understood by DVI drivers
like dvips.
Consequently, the DESC file should contain a `papersize' keyword.
o The glyph shapes for \[*f] and \[*e] have been exchanged with \[+f] and
\[+e], respectively, to be in sync with all other devices.
o Glyphs \[HE] and \[DI] have been replaced with \[u2662] and \[u2661],
respectively, since the former two glyphs have a black (filled) shape
which grodvi doesn't provide by default (it never has actually).
Grolj4
------
o The glyphs \[*e] and \[+e] have been exchanged to be in sync with
all other devices.
o The glyph \[~=] is now called \[|=]. Similar to other devices, \[~=]
is now another name for glyph \[~~].
Grotty
------
o New option `-r'. It is similar to the -i option except it tells grotty to
use the `reverse video' attribute to render italic fonts.
Pic
---
o New command `figname' to set the name of a picture's output box in TeX
mode.
Refer
-----
o The environment variable `REFER' to override the name of the default
database isn't new but hasn't been documented before.
Soelim
------
o New option `-r' to avoid emission of `.lf' lines.
o New option `-t' to emit TeX comment lines (giving current file and the
line number) instead of `.lf' lines.
Afmtodit
--------
o Unencoded glyphs in an AFM file are output also (since grops can now emit
multiple encoding vectors for a single font).
o New option `-m' to prevent negative left italic correction values.
o The mapping and encoding file together with file `DESC' are now searched
in the default font directory also. Please refer to the man page of
afmtodit for more details.
Macro Packages
--------------
o Larry Kollar <kollar@alltel.net> and others made the man macros more
customizable.
. New command line options -rFT, -rIN, and -rSN to set the vertical
location of the footer line, the body text indentation, and the
sub-subheading indentation.
. New command line option -rHY (similar to the ms macros) to control
hyphenation.
. New macros `.PT' and `.BT' to print the header and footer strings.
They can be replaced with a customized version in `man.local'.
. The string `HF' now holds the typeface to print headings and
subheadings.
. Similar to the ms macros, the LT register now defaults to LL if not
explicitly specified on the command line.
o troff's start-up file `troffrc' now includes `papersize.tmac' to set
the paper size with the command line option `-dpaper=<size>'.
Possible values for `<size>' are the same as the predefined `papersize'
values in the DESC file (only lowercase; see the groff_font man page)
except a7-d7. An appended `l' (ell) character denotes landscape
orientation. Examples: `a4', `c3l', `letterl'.
Most output drivers need additional command line switches `-p' and
`-l' to override the default paper length and orientation as set in
the driver specific DESC file.
For example, use the following for PS output on A4 paper in landscape
orientation:
groff -Tps -dpaper=a4l -P-pa4 -P-l -ms foo.ms > foo.ps
Add some images to the PLIST.
Sync PLIST with reality on Solaris. Switch to new automatic PLIST.${OPSYS}
handling.
XXX: Other OSes might need to use the same PLIST as Solaris does but i can't
test it.