[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 105/122: pdfroff(1): Use empty requests consistently.
From: |
G. Branden Robinson |
Subject: |
[groff] 105/122: pdfroff(1): Use empty requests consistently. |
Date: |
Wed, 11 Nov 2020 02:59:38 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit d6ca27904a0eda67a8270a468a6cd8a87e00d723
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Nov 9 23:59:43 2020 +1100
pdfroff(1): Use empty requests consistently.
---
contrib/pdfmark/pdfroff.1.man | 42 ++++++++++++++++++++++++++++++++++++++++++
1 file changed, 42 insertions(+)
diff --git a/contrib/pdfmark/pdfroff.1.man b/contrib/pdfmark/pdfroff.1.man
index 7cf6950..5965900 100644
--- a/contrib/pdfmark/pdfroff.1.man
+++ b/contrib/pdfmark/pdfroff.1.man
@@ -117,6 +117,7 @@ this allows for the definition of content which is required
to precede
the table of contents,
in the published document.
.
+.
.P
For each invocation of
.IR pdfroff ,
@@ -126,6 +127,7 @@ output stream is post-processed by the Ghostscript
.IR gs (1)
interpreter to produce a finished PDF document.
.
+.
.P
.I pdfroff
makes no assumptions about,
@@ -245,12 +247,14 @@ however,
are handled specially by
.IR pdfroff .
.
+.
.TP
.B \-h
Same as
.BR \-\-help ;
see below.
.
+.
.TP
.B \-i
Process standard input,
@@ -270,6 +274,7 @@ in the multiple-pass
processing context of
.IR pdfroff .
.
+.
.TP
.BI \-T \ dev
Only
@@ -281,6 +286,7 @@ Attempting to specify any other device causes
.I pdfroff
to abort.
.
+.
.TP
.B \-v
Same as
@@ -311,6 +317,7 @@ passed on to
.IR groff ,
unless otherwise stated below.
.
+.
.TP
.B \-\-help
Causes
@@ -319,6 +326,7 @@ 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,
@@ -333,6 +341,7 @@ such as
for example,
in place of the default Ghostscript PDF writer.
.
+.
.TP
.B \-\-keep\-temporary\-files
Suppresses the deletion of temporary files,
@@ -342,11 +351,13 @@ after
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
.IR pdfroff .
.
+.
.TP
.B \-\-no\-pdf\-output
May be used with the
@@ -357,6 +368,7 @@ to eliminate the overhead of PDF formatting when running
.I pdfroff
to create a reference dictionary for use in a different document.
.
+.
.TP
.B \-\-no\-reference\-dictionary
May be used to eliminate the overhead of creating a reference
@@ -367,6 +379,7 @@ created by the
.B pdfhref
macro.
.
+.
.TP
.B \-\-no\-toc\-relocation
May be used to eliminate the extra
@@ -377,6 +390,7 @@ and relocate it to the start of the PDF document,
when processing any document which lacks an automatically
generated table of contents.
.
+.
.TP
.B \-\-no\-kill\-null\-pages
While preparing for simulation of the manual collation step,
@@ -393,6 +407,7 @@ this option forces
.I pdfroff
to leave them in place.
.
+.
.TP
.BI \-\-pdf\-output= name
Specifies the name to be used for the resultant PDF document;
@@ -404,6 +419,7 @@ A future version of
may use this option,
to encode the document name in a generated reference dictionary.
.
+.
.TP
.BI \-\-reference\-dictionary= name
Specifies the name to be used for the generated reference dictionary
@@ -420,6 +436,7 @@ be specified,
if it is desired to save the reference dictionary,
for use in references placed in other PDF documents.
.
+.
.TP
.B \-\-report\-progress
Causes
@@ -429,6 +446,7 @@ at the start of each
.I groff
processing pass.
.
+.
.TP
.BI \-\-stylesheet= name
Specifies the name of an
@@ -439,6 +457,7 @@ which is to be placed
the table of contents,
in the formatted PDF document.
.
+.
.TP
.B \-\-version
Causes
@@ -466,11 +485,13 @@ and exported,
to modify the behaviour of
.IR pdfroff .
.
+.
.TP
.I PDFROFF_COLLATE
Specifies the program to be used
for collation of the finished PDF document.
.
+.
.IP
This collation step may be required to move
.I tables of contents
@@ -491,6 +512,7 @@ uses
by default,
which normally suffices.
.
+.
.IP
If
.I \%PDFROFF_COLLATE
@@ -503,12 +525,14 @@ whence it is piped to the
.IR \%PDFROFF_POSTPROCESSOR_COMMAND ,
to produce the finished PDF output.
.
+.
.IP
When specifying
.IR \%PDFROFF_COLLATE ,
it is normally necessary to also specify
.IR \%PDFROFF_KILL_NULL_PAGES .
.
+.
.IP
.I \%PDFROFF_COLLATE
is ignored,
@@ -518,12 +542,14 @@ is invoked with the
.B \%\-\-no\-kill\-null\-pages
option.
.
+.
.TP
.I PDFROFF_KILL_NULL_PAGES
Specifies options to be passed to the
.I \%PDFROFF_COLLATE
program.
.
+.
.IP
It should not normally be necessary to specify
.IR \%PDFROFF_KILL_NULL_PAGES .
@@ -545,6 +571,7 @@ then it is likely that a corresponding alternative
specification for
.I \%PDFROFF_KILL_NULL_PAGES
is required.
.
+.
.IP
As in the case of
.IR \%PDFROFF_COLLATE ,
@@ -556,6 +583,7 @@ is invoked with the
.B \%\-\-no\-kill\-null\-pages
option.
.
+.
.TP
.I PDFROFF_POSTPROCESSOR_COMMAND
Specifies the command to be used for the final document conversion
@@ -570,6 +598,7 @@ with the special case of
.RB \[lq] \- \[rq]
representing the standard input stream.
.
+.
.IP
If unspecified,
.I \%PDFROFF_POSTPROCESSOR_COMMAND
@@ -582,6 +611,7 @@ gs \-dBATCH \-dQUIET \-dNOPAUSE \-dSAFER \-sDEVICE=pdfwrite
\e
.EE
.RE
.
+.
.TP
.I GROFF_TMPDIR
Identifies the directory in which
@@ -604,6 +634,7 @@ If none of these are set,
then temporary files are created
in the current directory.
.
+.
.TP
.I GROFF_GHOSTSCRIPT_INTERPRETER
Specifies the program to be invoked when
@@ -634,6 +665,7 @@ if no Ghostscript interpreter can be found,
.I pdfroff
aborts.
.
+.
.TP
.I GROFF_AWK_INTERPRETER
Specifies the program to be invoked when
@@ -664,6 +696,7 @@ however,
in this case,
no reference dictionary is created.
.
+.
.TP
.I OSTYPE
Typically defined automatically by the operating system,
@@ -677,6 +710,7 @@ which is used when parsing the process
.I PATH
to search for external helper programs.
.
+.
.TP
.I PATH_SEPARATOR
If set,
@@ -690,6 +724,7 @@ which is used when parsing the process
.I PATH
to search for external helper programs.
.
+.
.TP
.I SHOW_PROGRESS
If this is set to a non-empty value,
@@ -741,6 +776,7 @@ the temporary files will be placed within it,
otherwise they will be placed directly in the directory
nominated in the environment.
.
+.
.P
All temporary files themselves
are named according to the convention
@@ -757,6 +793,7 @@ represents any of the extensions used by
.I pdfroff
to identify the following temporary and intermediate files.
.
+.
.TP
.IR pdf $$ .tmp
A scratch pad file,
@@ -766,6 +803,7 @@ during the
.I reference dictionary
compilation phase.
.
+.
.TP
.IR pdf $$ .ref
The
@@ -781,6 +819,7 @@ it contains the
entries,
as collected in the preceding pass).
.
+.
.IP
If the
.BR \%\-\-reference\-dictionary =\c
@@ -792,6 +831,7 @@ and is named
rather than
.IR pdf $$ .ref .
.
+.
.TP
.IR pdf $$ .cmp
Used to collect
@@ -817,6 +857,7 @@ and the
is appended to this intermediate file,
for inclusion in the final formatting passes.
.
+.
.TP
.IR pdf $$ .tc
An intermediate
@@ -828,6 +869,7 @@ on ultimate output to the
.I Ghostscript
postprocessor.
.
+.
.TP
.IR pdf $$ .ps
An intermediate
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 105/122: pdfroff(1): Use empty requests consistently.,
G. Branden Robinson <=