[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 94/122: pdfroff(1): Update man page cross-references.
From: |
G. Branden Robinson |
Subject: |
[groff] 94/122: pdfroff(1): Update man page cross-references. |
Date: |
Wed, 11 Nov 2020 02:59:34 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit b4cc236996ae5778cd721a8be5178c266a20be62
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Nov 9 23:09:21 2020 +1100
pdfroff(1): Update man page cross-references.
---
contrib/pdfmark/pdfroff.1.man | 166 +++++++++++++++++++++---------------------
1 file changed, 83 insertions(+), 83 deletions(-)
diff --git a/contrib/pdfmark/pdfroff.1.man b/contrib/pdfmark/pdfroff.1.man
index bd8e565..f172779 100644
--- a/contrib/pdfmark/pdfroff.1.man
+++ b/contrib/pdfmark/pdfroff.1.man
@@ -98,14 +98,14 @@ pdfroff \- construct files in Portable Document Format
using groff
.SH Description
.\" ====================================================================
.
-.B pdfroff
+.I pdfroff
is a wrapper program for the GNU text processing system,
-.BR groff .
+.IR groff .
.
It transparently handles the mechanics of multiple pass
-.B groff
+.I groff
processing, when applied to suitably marked up
-.B groff
+.I groff
source files,
such that tables of contents and body text are formatted separately,
and are subsequently combined in the correct order,
@@ -120,23 +120,23 @@ in the published document.
.
.P
For each invocation of
-.BR pdfroff ,
+.IR pdfroff ,
the ultimate
-.B groff
+.I groff
output stream is post-processed by the GhostScript interpreter,
to produce a finished PDF document.
.
.P
-.B pdfroff
+.I pdfroff
makes no assumptions about, and imposes no restrictions on, the use of
any
-.B groff
+.I groff
macro packages which the user may choose to employ,
in order to achieve a desired document format;
however, it
.I does
include specific built in support for the
-.B pdfmark
+.I pdfmark
macro package, should the user choose to employ it.
.
Specifically, if the
@@ -145,9 +145,9 @@ macro, defined in the
.I pdfmark.tmac
package, is used to define public reference marks, or dynamic links to
such reference marks, then
-.B pdfroff
+.I pdfroff
performs as many preformatting
-.B groff
+.I groff
passes as required, up to a maximum limit of
.IR four ,
in order to compile a document reference dictionary, to resolve
@@ -175,9 +175,9 @@ be abbreviated to their minimum length unambiguous initial
substring.
.
.P
Otherwise,
-.B pdfroff
+.I pdfroff
usage closely mirrors that of
-.B groff
+.I groff
itself.
.
Indeed, with the exception of the
@@ -187,19 +187,19 @@ and
.BI \-T \ dev
short form options, and all long form options, which are parsed
internally by
-.BR pdfroff ,
+.IR pdfroff ,
all options and file name arguments specified on the command line are
passed on to
-.BR groff ,
+.IR groff ,
to control the formatting of the PDF document.
.
Consequently,
-.B pdfroff
+.I pdfroff
accepts all options and arguments, as specified in
-.BR groff (@MAN1EXT@),
+.IR groff (@MAN1EXT@),
which may also be considered as the definitive reference for all
standard
-.B pdfroff
+.I pdfroff
options and argument usage.
.
.
@@ -207,16 +207,16 @@ options and argument usage.
.SH Options
.\" ====================================================================
.
-.B pdfroff
+.I pdfroff
accepts all of the short form options (i.e., those introduced by a
single hyphen), which are available with
-.B groff
+.I groff
itself.
.
In most cases, these are simply passed transparently to
-.BR groff ;
+.IR groff ;
the following, however, are handled specially by
-.BR pdfroff .
+.IR pdfroff .
.
.TP
.B \-h
@@ -229,26 +229,26 @@ see below.
Process standard input, after all other specified input files.
.
This is passed transparently to
-.BR groff ,
+.IR groff ,
but, if grouped with other options, it
.I must
be the first in the group.
.
Hiding it within a group breaks standard input processing, in the
multiple pass
-.B groff
+.I groff
processing context of
-.BR pdfroff .
+.IR pdfroff .
.
.TP
.BI \-T \ dev
Only
.B \-T\ ps
is supported by
-.BR pdfroff .
+.IR pdfroff .
.
Attempting to specify any other device causes
-.B pdfroff
+.I pdfroff
to abort.
.
.TP
@@ -260,35 +260,35 @@ see below.
.
.P
See
-.BR groff (@MAN1EXT@)
+.IR groff (@MAN1EXT@)
for a description of all other short form options, which are
transparently passed through
-.B pdfroff
+.I pdfroff
to
-.BR groff .
+.IR groff .
.
.
.P
All long form options (i.e., those introduced by a double hyphen) are
interpreted locally by
-.BR pdfroff ;
+.IR pdfroff ;
they are
-.B not
+.I not
passed on to
-.BR groff ,
+.IR groff ,
unless otherwise stated below.
.
.TP
.B \-\-help
Causes
-.B pdfroff
+.I pdfroff
to display a summary of the its usage syntax, and supported options,
and then exit.
.
.TP
.B \-\-emit\-ps
Suppresses the final output conversion step, causing
-.B pdfroff
+.I pdfroff
to emit PostScript output instead of PDF.
.
This may be useful, to capture intermediate PostScript output, when
@@ -303,14 +303,14 @@ PDF writer.
.B \-\-keep\-temporary\-files
Suppresses the deletion of temporary files, which normally occurs
after
-.B pdfroff
+.I pdfroff
has completed PDF document formatting; this may be useful, when
debugging formatting problems.
.
.IP
See section \[lq]Files\[rq] below for a description of the temporary
files used by
-.BR pdfroff .
+.IR pdfroff .
.
.TP
.B \-\-no\-pdf\-output
@@ -318,7 +318,7 @@ May be used with the
.BI \%\-\-reference\-dictionary= name
option (described below) to eliminate the overhead of PDF formatting,
when running
-.B pdfroff
+.I pdfroff
to create a reference dictionary, for use in a different document.
.
.TP
@@ -334,7 +334,7 @@ macro.
.TP
.B \-\-no\-toc\-relocation
May be used to eliminate the extra
-.B groff
+.I groff
processing pass,
which is required to generate a table of contents,
and relocate it to the start of the PDF document,
@@ -347,7 +347,7 @@ While preparing for simulation of the manual collation step,
which is traditionally required to relocate a
.I "table of contents"
to the start of a document,
-.B pdfroff
+.I pdfroff
accumulates a number of empty page descriptions
into the intermediate
.I PostScript
@@ -355,7 +355,7 @@ output stream.
During the final collation step,
these empty pages are normally discarded from the finished document;
this option forces
-.B pdfroff
+.I pdfroff
to leave them in place.
.
.TP
@@ -363,7 +363,7 @@ to leave them in place.
Specifies the name to be used for the resultant PDF document;
if unspecified, the PDF output is written to standard output.
A future version of
-.B pdfroff
+.I pdfroff
may use this option,
to encode the document name in a generated reference dictionary.
.
@@ -374,7 +374,7 @@ file;
if unspecified,
the reference dictionary is created in a temporary file,
which is deleted when
-.B pdfroff
+.I pdfroff
completes processing of the current document.
.
This option
@@ -385,10 +385,10 @@ for use in references placed in other PDF documents.
.TP
.B \-\-report\-progress
Causes
-.B pdfroff
+.I pdfroff
to display an informational message on standard error,
at the start of each
-.B groff
+.I groff
processing pass.
.
.TP
@@ -404,17 +404,17 @@ in the formatted PDF document.
.TP
.B \-\-version
Causes
-.B pdfroff
+.I pdfroff
to display a version identification message.
.
The entire command line is then passed transparently to
-.BR groff ,
+.IR groff ,
in a
.I one
pass operation
.IR only ,
in order to display the associated
-.B groff
+.I groff
version information, before exiting.
.
.
@@ -424,7 +424,7 @@ version information, before exiting.
.
The following environment variables may be set, and exported,
to modify the behaviour of
-.BR pdfroff .
+.IR pdfroff .
.
.TP
.I PDFROFF_COLLATE
@@ -441,9 +441,9 @@ which print them at the end.
However, users should not normally need to specify
.IR \%PDFROFF_COLLATE ,
(and indeed, are not encouraged to do so). If unspecified,
-.B pdfroff
+.I pdfroff
uses
-.BR sed (@MAN1EXT@)
+.IR sed (@MAN1EXT@)
by default,
which normally suffices.
.
@@ -471,7 +471,7 @@ it is normally necessary to also specify
.I \%PDFROFF_COLLATE
is ignored,
if
-.B pdfroff
+.I pdfroff
is invoked with the
.I \%\-\-no\-kill\-null\-pages
option.
@@ -487,16 +487,16 @@ It should not normally be necessary to specify
.IR \%PDFROFF_KILL_NULL_PAGES .
.
The internal default is a
-.BR sed (@MAN1EXT@)
+.IR sed (@MAN1EXT@)
script,
which is intended to remove completely blank pages
from the collated output stream,
and which should be appropriate in most applications of
-.BR pdfroff .
+.IR pdfroff .
.
However,
if any alternative to
-.BR sed (@MAN1EXT@)
+.IR sed (@MAN1EXT@)
is specified for
.IR \%PDFROFF_COLLATE ,
then it is likely that a corresponding alternative specification for
@@ -508,7 +508,7 @@ As in the case of
.IR \%PDFROFF_COLLATE ,
.I \%PDFROFF_KILL_NULL_PAGES
is ignored, if
-.B pdfroff
+.I pdfroff
is invoked with the
.I \%\-\-no\-kill\-null\-pages
option.
@@ -546,7 +546,7 @@ gs \-dBATCH \-dQUIET \-dNOPAUSE \-dSAFER \-sDEVICE=pdfwrite
\e
.TP
.I GROFF_TMPDIR
Identifies the directory in which
-.B pdfroff
+.I pdfroff
should create temporary files.
.
If
@@ -565,9 +565,9 @@ in the current directory.
.TP
.I GROFF_GHOSTSCRIPT_INTERPRETER
Specifies the program to be invoked, when
-.B pdfroff
+.I pdfroff
converts
-.B groff
+.I groff
PostScript output to PDF.
.
If
@@ -582,33 +582,33 @@ overriding any explicit setting specified in the
environment.
If
.I \%GROFF_GHOSTSCRIPT_INTERPRETER
is not specified, then
-.B pdfroff
+.I pdfroff
searches the process
.IR PATH ,
looking for a program with any of the well known names
for the GhostScript interpreter;
if no GhostScript interpreter can be found,
-.B pdfroff
+.I pdfroff
aborts.
.
.TP
.I GROFF_AWK_INTERPRETER
Specifies the program to be invoked, when
-.B pdfroff
+.I pdfroff
is extracting reference dictionary entries from a
-.B groff
+.I groff
intermediate message stream.
.
If
.I \%GROFF_AWK_INTERPRETER
is not specified, then
-.B pdfroff
+.I pdfroff
searches the process
.IR PATH ,
looking for any of the preferred programs, \[oq]gawk\[cq],
\[oq]mawk\[cq], \[oq]nawk\[cq], and \[oq]awk\[cq], in this order; if
none of these are found,
-.B pdfroff
+.I pdfroff
issues a warning message, and continue processing;
however, in this case, no reference dictionary is created.
.
@@ -641,7 +641,7 @@ to search for external helper programs.
.TP
.I SHOW_PROGRESS
If this is set to a non-empty value, then
-.B pdfroff
+.I pdfroff
always behaves as if the
.B \%\-\-report\-progress
option is specified, on the command line.
@@ -652,13 +652,13 @@ option is specified, on the command line.
.\" ====================================================================
.
Input and output files for
-.B pdfroff
+.I pdfroff
may be named according to any convention of the user's choice.
Typically, input files may be named according to the choice of the
principal formatting macro package, e.g.,
.RI file .ms
might be an input file for formatting using the
-.B ms
+.I ms
macros
.RI ( s.tmac );
normally, the final output file should be named
@@ -667,13 +667,13 @@ normally, the final output file should be named
.
.P
Temporary files, created by
-.BR pdfroff ,
+.IR pdfroff ,
are placed in the file system hierarchy,
in or below the directory specified by environment variables
(see section \[lq]Environment\[rq] above).
.
If
-.BR mktemp (@MAN1EXT@)
+.IR mktemp (@MAN1EXT@)
is available,
it is invoked to create a private subdirectory of
the nominated temporary files directory,
@@ -690,18 +690,18 @@ are named according to the convention
where
.I $$
is the standard shell variable representing the process ID of the
-.B pdfroff
+.I pdfroff
process itself, and
.I *
represents any of the extensions used by
-.B pdfroff
+.I pdfroff
to identify the following temporary and intermediate files.
.
.TP
.IR pdf $$ .tmp
A scratch pad file,
used to capture reference data emitted by
-.BR groff ,
+.IR groff ,
during the
.I reference dictionary
compilation phase.
@@ -797,36 +797,36 @@ Keith Marshall
.\" ====================================================================
.
See
-.BR groff (@MAN1EXT@)
+.IR groff (@MAN1EXT@) \" XXX 7?
for the definitive reference to document formatting with
-.BR groff .
+.IR groff .
.
Since
-.B pdfroff
+.I pdfroff
provides a superset of all
-.B groff
+.I groff
capabilities,
-.BR groff (@MAN1EXT@)
+.IR groff (@MAN1EXT@)
may also be considered to be the definitive reference to all
.I standard
capabilities of
-.BR pdfroff ,
+.IR pdfroff ,
with this document providing the reference to
-.BR pdfroff 's
+.IR pdfroff 's
extended features.
.
.
.P
While
-.B pdfroff
+.I pdfroff
imposes neither any restriction on, nor any requirement for,
the use of any specific
-.B groff
+.I groff
macro package, a number of supplied macro packages,
and in particular those associated with the package
.IR pdfmark.tmac ,
are best suited for use with
-.B pdfroff
+.I pdfroff
as the preferred formatter.
.
Detailed documentation on the use of these packages may be found,
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 94/122: pdfroff(1): Update man page cross-references.,
G. Branden Robinson <=