XPD FRC
XPD FRC
xpdfrc(5)
NAME
xpdfrc - configuration file for Xpdf tools (version 3.04)
DESCRIPTION
All of the Xpdf tools read a single configuration file. If you have a
.xpdfrc file in your home directory, it will be read. Otherwise, a
system-wide configuration file will be read from /usr/local/etc/xpdfrc,
if it exists. (This is its default location; depending on build
options, it may be placed elsewhere.) On Win32 systems, the xpdfrc
file should be placed in the same directory as the executables.
The xpdfrc file consists of a series of configuration options, one per
line. Blank lines and lines starting with a '#' (comments) are
ignored.
Arguments may be quoted, using "double-quote" characters, e.g., for
file names that contain spaces.
The following sections list all of the configuration options, sorted
into functional groups. There is an examples section at the end.
INCLUDE FILES
include config-file
Includes the specified config file. The effect of this is
equivalent to inserting the contents of config-file directly
into the parent config file in place of the include command.
Config files can be nested arbitrarily deeply.
CHARACTER MAPPING
nameToUnicode map-file
Specifies a file with the mapping from character names to Unicode. This is used to handle PDF fonts that have valid encodings but no ToUnicode entry. Each line of a nameToUnicode file
looks like this:
hex-string name
The hex-string is the Unicode (UCS-2) character index, and name
is the corresponding character name. Multiple nameToUnicode
files can be used; if a character name is given more than once,
the code in the last specified file is used. There is a builtin default nameToUnicode table with all of Adobe's standard
character names.
cidToUnicode registry-ordering map-file
Specifies the file with the mapping from character collection to
Unicode. Each line of a cidToUnicode file represents one character:
hex-string
The hex-string is the Unicode (UCS-2) index for that character.
The first line maps CID 0, the second line CID 1, etc. File
size is determined by size of the character collection. Only
one file is allowed per character collection; the last specified
file is used. There are no built-in cidToUnicode mappings.
psEmbedCIDPostScriptFonts yes | no
If set to "no", prevents embedding of CID PostScript fonts in
generated PostScript. For Level 3 PostScript, this generates a
CID font, for lower levels it generates a non-CID composite
font. This defaults to "yes".
POSTSCRIPT CONTROL
psPaperSize width(pts) height(pts)
Sets the paper size for PostScript output. The width and height
parameters give the paper size in PostScript points (1 point =
1/72 inch).
psPaperSize letter | legal | A4 | A3 | match
Sets the paper size for PostScript output to a standard size.
The default paper size is set when xpdf and pdftops are built,
typically to "letter" or "A4". This can also be set to "match",
which will set the paper size to match the size specified in the
PDF file.
psImageableArea llx lly urx ury
Sets the imageable area for PostScript output. The four integers are the coordinates of the lower-left and upper-right corners of the imageable region, specified in points (with the origin being the lower-left corner of the paper). This defaults to
the full paper size; the psPaperSize option will reset the
imageable area coordinates.
psCrop yes | no
If set to "yes", PostScript output is cropped to the CropBox
specified in the PDF file; otherwise no cropping is done. This
defaults to "yes".
psUseCropBoxAsPage
If set to
page size.
as the page
yes | no
"yes", PostScript output treats the CropBox as the
By default, this is "no", and the MediaBox is used
size.
psExpandSmaller yes | no
If set to "yes", PDF pages smaller than the PostScript imageable
area are expanded to fill the imageable area. Otherwise, no
scalling is done on smaller pages. This defaults to "no".
psShrinkLarger yes | no
If set to yes, PDF pages larger than the PostScript imageable
area are shrunk to fit the imageable area. Otherwise, no scaling is done on larger pages. This defaults to "yes".
psCenter yes | no
If set to yes, PDF pages smaller than the PostScript imageable
area (after any scaling) are centered in the imageable area.
Otherwise, they are aligned at the lower-left corner of the
imageable area. This defaults to "yes".
psDuplex yes | no
If set to "yes", the generated PostScript will set the "Duplex"
pagedevice entry. This tells duplex-capable printers to enable
duplexing. This defaults to "no".
psLevel level1 | level1sep | level2 | level2sep | level3 | level3Sep
This defaults to
psPreload yes | no
If set to "yes", PDF forms are converted to PS procedures, and
image data is preloaded. This uses more memory in the PostScript interpreter, but generates significantly smaller PS files
in situations where, e.g., the same image is drawn on every page
of a long document. This defaults to "no".
psOPI yes | no
If set to "yes", generates PostScript OPI comments for all
images and forms which have OPI information. This option is
only available if the Xpdf tools were compiled with OPI support.
This defaults to "no".
psASCIIHex yes | no
If set to "yes", the ASCIIHexEncode filter will be used instead
of ASCII85Encode for binary data. This defaults to "no".
psLZW yes | no
If set to "yes", the LZWEncode filter will be used for lossless
compression in PostScript output; if set to "no", the RunLengthEncode filter will be used instead. LZW generates better compression (smaller PS files), but may not be supported by some
printers. This defaults to "yes".
psUncompressPreloadedImages yes | no
If set to "yes", all preloaded images in PS files will uncompressed. If set to "no", the original compressed images will be
used when possible. The "yes" setting is useful to work around
certain buggy PostScript interpreters. This defaults to "no".
psMinLineWidth float
Set the minimum line width, in points, for PostScript output.
The default value is 0 (no minimum).
psRasterResolution float
Set the resolution (in dpi) for rasterized pages in PostScript
output. (Pdftops will rasterize pages which use transparency.)
This defaults to 300.
psRasterMono yes | no
If set to "yes", rasterized pages in PS files will be monochrome
(8-bit gray) instead of color. This defaults to "no".
psRasterSliceSize pixels
When rasterizing pages, pdftops splits the page into horizontal
"slices", to limit memory usage. This option sets the maximum
slice size, in pixels. This defaults to 20000000 (20 million).
psAlwaysRasterize yes | no
If set to "yes", all PostScript output will be rasterized. This
defaults to "no".
psFile file-or-command
Sets the default PostScript file or print command for xpdf.
Commands start with a '|' character; anything else is a file.
If the file name or command contains spaces it must be quoted.
This defaults to unset, which tells xpdf to generate a name of
The
unix = LF
dos = CR+LF
mac = CR
(This can be overridden with the "-eol" switch on the command
line.) The default value is based on the OS where xpdf and
pdftotext were built.
textPageBreaks yes | no
If set to "yes", text extraction will insert page breaks (form
feed characters) between pages. This defaults to "yes".
textKeepTinyChars yes | no
If set to "yes", text extraction will keep all characters. If
set to "no", text extraction will discard tiny (smaller than 3
point) characters after the first 50000 per page, avoiding
extremely slow run times for PDF files that use special fonts to
do shading or cross-hatching. This defaults to "yes".
MISCELLANEOUS SETTINGS
initialZoom percentage | page | width
Sets the initial zoom factor. A number specifies a zoom percentage, where 100 means 72 dpi. You may also specify 'page',
to fit the page to the window size, or 'width', to fit the page
width to the window width.
continuousView yes | no
If set to "yes", xpdf will start in continuous view mode, i.e.,
with one vertical screoll bar for the whole document. This
defaults to "no".
enableFreeType yes | no
Enables or disables use
rasterizer). This is only
with FreeType support.
"freetypeControl" option.)
enableFreeType yes | no
Enables or disables use of
rasterizer). This is only
with FreeType support.
"freetypeControl" option.)
disableFreeTypeHinting yes | no
vectorAntialias yes | no
Enables or disables anti-aliasing of vector graphics in the PDF
rasterizer. This defaults to "yes".
antialiasPrinting yes | no
If this is "yes", bitmaps sent to the printer will be
antialiased (according to the "antialias" and "vectorAntialias"
settings). If this is "no", printed bitmaps will not be
antialiased. This defaults to "no".
strokeAdjust yes | no
Enables or disables stroke adjustment. Stroke adjustment moves
horizontal and vertical lines by up to half a pixel to make them
look "cleaner" when vector anti-aliasing is enabled. This
defaults to "yes".
screenType dispersed | clustered | stochasticClustered
Sets the halftone screen type, which will be used when generating a monochrome (1-bit) bitmap. The three options are dispersed-dot dithering, clustered-dot dithering (with a round dot
and 45-degree screen angle), and stochastic clustered-dot
dithering. By default, "stochasticClustered" is used for resolutions of 300 dpi and higher, and "dispersed" is used for resolutions lower then 300 dpi.
screenSize integer
Sets the size of the (square) halftone screen threshold matrix.
By default, this is 4 for dispersed-dot dithering, 10 for clustered-dot dithering, and 100 for stochastic clustered-dot
dithering.
screenDotRadius integer
Sets the halftone screen dot radius. This is only used when
screenType is set to stochasticClustered, and it defaults to 2.
In clustered-dot mode, the dot radius is half of the screen
size. Dispersed-dot dithering doesn't have a dot radius.
screenGamma
Sets
ues
than
float
the halftone screen gamma correction parameter. Gamma valgreater than 1 make the output brighter; gamma values less
1 make it darker. The default value is 1.
screenBlackThreshold float
When halftoning, all values below this threshold are forced to
solid black. This parameter is a floating point value between 0
(black) and 1 (white). The default value is 0.
screenWhiteThreshold float
When halftoning, all values above this threshold are forced to
solid white. This parameter is a floating point value between 0
(black) and 1 (white). The default value is 1.
minLineWidth float
Set the minimum line width, in device pixels. This affects the
rasterizer only, not the PostScript converter (except when it
uses rasterization to handle transparency). The default value
is 0 (no minimum).
drawAnnotations yes | no
If set to "no", annotations will not be drawn or printed. The
default value is "yes".
overprintPreview
If set to
OP/op/OPM
put. The
yes | no
"yes", generate overprint preview output, honoring the
settings in the PDF file. Ignored for non-CMYK outdefault value is "no".
launchCommand command
Sets the command executed when you click on a "launch"-type
link. The intent is for the command to be a program/script
which determines the file type and runs the appropriate viewer.
The command line will consist of the file to be launched, followed by any parameters specified with the link. Do not use
"%s" in "command". By default, this is unset, and Xpdf will
simply try to execute the file (after prompting the user).
urlCommand command
Sets the command executed when you click on a URL link. The
string "%s" will be replaced with the URL. (See the example
below.) This has no default value.
movieCommand command
Sets the command executed when you click on a movie annotation.
The string "%s" will be replaced with the movie file name. This
has no default value.
mapNumericCharNames yes | no
If set to "yes", the Xpdf tools will attempt to map various
numeric character names sometimes used in font subsets. In some
cases this leads to usable text, and in other cases it leads to
gibberish -- there is no way for Xpdf to tell. This defaults to
"yes".
mapUnknownCharNames yes | no
If set to "yes", and mapNumericCharNames is set to "no", the
Xpdf tools will apply a simple pass-through mapping (Unicode
index = character code) for all unrecognized glyph names. (For
CID fonts, setting mapNumericCharNames to "no" is unnecessary.)
In some cases, this leads to usable text, and in other cases it
leads to gibberish -- there is no way for Xpdf to tell. This
defaults to "no".
mapExtTrueTypeFontsViaUnicode yes | no
When rasterizing text using an external TrueType font, there are
two options for handling character codes. If mapExtTrueTypeFontsViaUnicode is set to "yes", Xpdf will use the font encoding/ToUnicode info to map character codes to Unicode, and then
use the font's Unicode cmap to map Unicode to GIDs. If mapExtTrueTypeFontsViaUnicode is set to "no", Xpdf will assume the
character codes are GIDs (i.e., use an identity mapping). This
defaults to "yes".
enableXFA yes | no
If set to "yes", an XFA form (if present) will be rendered in
place of an AcroForm. If "no", an XFA form will never be rendered. This defaults to "yes".
bind modifiers-key context command ...
Add a key or mouse button binding. Modifiers can be zero or
more of:
shiftctrlaltKey can be a regular ASCII character, or any one of:
space
tab
return
enter
backspace
insert
delete
home
end
pgup
pgdn
left / right / up / down
f1 .. f35
mousePress1 .. mousePress7
mouseRelease1 .. mouseRelease7
(arrow keys)
(function keys)
(mouse buttons)
(mouse buttons)
The context string can include only one of each pair in the
above list.
Command is an Xpdf command (see the COMMANDS section of the
xpdf(1) man page for details). Multiple commands are separated
by whitespace.
The bind command replaces any existing binding, but only if it
was defined for the exact same modifiers, key, and context. All
tokens (modifiers, key, context, commands) are case-sensitive.
Example key bindings:
# bind ctrl-a in any context to the nextPage
# command
bind ctrl-a any nextPage
# bind uppercase B, when in continuous mode
# with scroll lock on, to the reload command
# followed by the prevPage command
bind B continuous,scrLockOn reload prevPage
/usr/local/share/ghostscript/fonts/n021023
fontFile Times-Bold
/usr/local/share/ghostscript/fonts/n021004
fontFile Times-BoldItalic
/usr/local/share/ghostscript/fonts/n021024
fontFile Helvetica
/usr/local/share/ghostscript/fonts/n019003
fontFile Helvetica-Oblique
/usr/local/share/ghostscript/fonts/n019023
fontFile Helvetica-Bold
/usr/local/share/ghostscript/fonts/n019004
l.pfb
l.pfb
l.pfb
l.pfb
l.pfb
l.pfb
fontFile Helvetica-BoldOblique /usr/local/share/ghostscript/fonts/n019024
l.pfb
fontFile Courier
/usr/local/share/ghostscript/fonts/n022003
fontFile Courier-Oblique
/usr/local/share/ghostscript/fonts/n022023
fontFile Courier-Bold
/usr/local/share/ghostscript/fonts/n022004
fontFile Courier-BoldOblique
/usr/local/share/ghostscript/fonts/n022024
fontFile Symbol
/usr/local/share/ghostscript/fonts/s050000
fontFile ZapfDingbats
/usr/local/share/ghostscript/fonts/d050000
l.pfb
l.pfb
l.pfb
l.pfb
l.pfb
l.pfb
# use the Bakoma Type 1 fonts
28 May 2014
pdf-
xpdfrc(5)