mainPDF publishing add-on for GNU roff - Summary

 
 
Membership Info
Group Admin:
1 active member

Group identification
Id: 12402
System Name: groff-pdfmark
Name: PDF publishing add-on for GNU roff
Group Type: non-GNU software and documentation

Search in this Group


 

This group is not part of the GNU Project.

The groff⁠-⁠pdfmark package provides a suite of GNU roff macro packages, together with a Bourne shell driver script, designed to facilitate the creation of PDF files, using GNU roff as the primary typesetting engine.  The suite comprises⁠:⁠—

  • The pdfmark.tmac macro package.  This is a GNU roff macro package, providing for the insertion of PDF markup into the GNU roff postscript output data stream, with particular emphasis on  the creation of active reference links to locations within the document, to locations within other PDF documents, or to internet URL resources.
  • The supporting pdfroff driver program.  This is a Bourne shell script, which invokes GNU roff as required, to properly interpret the markup inserted by pdfmark.tmac, and ultimately process the GNU roff postscript output data stream through the Ghostscript interpreter, to produce a finished PDF document file.
  • Several supplementary macro packages, also in GNU roff .tmac format, which facilitate the operation of pdfroff, and the implementation of the pdfmark.tmac macros, whilst also providing potential utility beyond the immediate groff⁠-⁠pdfmark context.
  • An autonomously generated user guide, in PDF format; this remains under active development.
  • Documentation for the pdfroff program, and for each of the provided macro packages, in Unix manual page format.

A copy of the most recently published edition of the user guide, "Portable Document Format Publishing with GNU Troff", may be found, as the file named pdfmark.pdf, in the download area which is associated with this groff⁠-⁠pdfmark project group; it may be read on-line, or downloaded, by following this document reference link.  Additionally, related Unix manual pages, typeset as individual PDF files, are available for reading on⁠-⁠line, or for direct download; see pdfroff(1), groff_mspdf(7), groff_omit(7), groff_opmode(7), groff_pdfhref(7), groff_pdfmark(7), groff_pdfnote(7), groff_sanitize(7), groff_toc(7), pdfroff(7)

Formal releases of groff⁠-⁠pdfmark are identified, according to their year and month of publication, by release numbers of the form "YY.MM"; this is expressed, within the names of the individual package files which comprise the release, in the expanded form "YYYYMMDD.N", (with "DD.N" representing a daily serialisation index, to facilitate safe replacement of any prematurely published, malformed release, within the same day).

Each formal release of groff⁠-⁠pdfmark comprises the package files⁠:⁠—

  • groff⁠-⁠pdfmark⁠-⁠YYYYMMDD.N⁠-⁠src.tar.xz: this is the primary source code distribution of groff⁠-⁠pdfmark.
  • groff⁠-⁠pdfmark⁠-⁠YYYYMMDD.N⁠-⁠posix⁠-⁠bin.tar.xz: this provides an installation-ready variant of the pdfroff program, suitable for deployment on POSIX compliant operating systems, (including the Cygwin environment, on MS⁠-⁠Windows).
  • groff⁠-⁠pdfmark⁠-⁠YYYYMMDD.N⁠-⁠win32⁠-⁠bin.tar.xz: this provides an alternative installation⁠-⁠ready variant of the pdfroff program, suitable for deployment on MS⁠-⁠Windows, with a non⁠-⁠Cygwin Bourne shell interpreter, (such as that provided by MinGW/MSYS).
  • groff⁠-⁠pdfmark⁠-⁠YYYYMMDD.N⁠-⁠tmac.tar.xz: this provides installation⁠-⁠ready copies of the collection of GNU roff macro files, which implement the groff⁠-⁠pdfmark capabilities.
  • groff⁠-⁠pdfmark⁠-⁠YYYYMMDD.N⁠-⁠man.tar.xz: this provides documentation, in Unix manual page format, describing how the pdfroff program, and the groff⁠-⁠pdfmark macros, are used.
  • groff⁠-⁠pdfmark⁠-⁠YYYYMMDD.N⁠-⁠doc.tar.xz: this provides copies of the aforementioned user guide, and each of the groff⁠-⁠pdfmark manual pages, typeset as PDF files, together with a collection of usage example files.
  • groff⁠-⁠pdfmark⁠-⁠YYYYMMDD.N⁠-⁠shasum.gpg: this GPG signed file enumerates the SHA512 checksums for each of the preceding package files.

The integrity of downloaded groff⁠-⁠pdfmark package files may be verified by also downloading the SHA512 checksum enumeration, and running the command⁠:⁠—

  gpg --decrypt groff-pdfmark-YYYYMMDD.N-shasum.gpg | shasum --check --ignore-missing

(with the current working directory set to that in which all of the downloaded files have been collected).

This command will both verify the signature of the checksum file itself, (using a signing key from the keyring identified below), and indicate an OK or FAILED checksum for each downloaded package file; (the use of the -⁠-⁠ignore⁠-⁠missing flag, within the command, is optional, but recommended to avoid error diagnostics relating to package files which may not have been downloaded).

Registration Date: Wed 16 Apr 2025 07:29:23 PM UTC
License: GNU General Public License v3 or later
Development Status: 5 - Production/Stable

 


Back to the top

Powered by Savane 3.15-64aa.
Corresponding source code