xpdfrc.5

source code: Covert TXT to PDF

.\" Copyright 2002 Glyph & Cog, LLC
.TH xpdfrc 5 "05 December 2002"
.SH NAME
xpdfrc \- configuration file for Xpdf tools (version 2.01)
.SH DESCRIPTION
All of the Xpdf tools read a single configuration file.  If you have a
.I .xpdfrc
file in your home directory, it will be read.  Otherwise, a
system-wide configuration file will be read from
.IR /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
.I xpdfrc
file should be placed in the same directory as the executables.
.PP
The xpdfrc file consists of a series of configuration options, one
per line.  Blank lines and lines starting with a \'#' (comments) are
ignored.
.PP
The following sections list all of the configuration options, sorted
into functional groups.  There is an examples section at the end.
.SH INCLUDE FILES
.TP
.BI include " config\-file"
Includes the specified config file.  The effect of this is equivalent
to inserting the contents of
.I config\-file
directly into the parent config file in place of the
.I include
command.  Config files can be nested arbitrarily deep.
.SH CHARACTER MAPPING
.TP
.BI 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:

.I "    " hex\-string name

The
.I hex\-string
is the Unicode (UCS-2) character index, and
.I 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 built-in default
nameToUnicode table with all of Adobe's standard character names.
.TP
.BI 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:

.I "    " hex\-string

The
.I 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.
.TP
.BI unicodeMap " encoding\-name map\-file"
Specifies the file with mapping from Unicode to
.IR encoding\-name .
These encodings are used for X display fonts and text output (see
below).  Each line of a unicodeMap file represents a range of one or
more Unicode characters which maps linearly to a range in the output
encoding:
.nf

.I "    " in\-start\-hex in\-end\-hex out\-start\-hex

.fi
Entries for single characters can be abbreviated to:
.nf

.I "    " in\-hex out\-hex

.fi
The
.I in\-start\-hex
and
.I in\-end\-hex
fields (or the single
.I in\-hex
field) specify the Unicode range.  The
.I out\-start\-hex
field (or the
.I out\-hex
field) specifies the start of the output encoding range.  The length
of the
.I out\-start\-hex
(or
.IR out\-hex )
string determines the length of the output characters (e.g., UTF-8
uses different numbers of bytes to represent characters in different
ranges).  Entries must be given in increasing Unicode order.  Only one
file is allowed per encoding; the last specified file is used.  The
.IR Latin1 ,
.IR ASCII7 ,
.IR Symbol ,
.IR ZapfDingbats ,
.IR UTF-8 ,
and
.I UCS-2
encodings are predefined.
.TP
.BI cMapDir " registry\-ordering dir"
Specifies a search directory,
.IR dir ,
for CMaps for the
.I registry\-ordering
character collection.  There can be multiple directories for a
particular collection.  There are no default CMap directories.
.TP
.BI toUnicodeDir " dir"
Specifies a search directory,
.IR dir ,
for ToUnicode CMaps.  There can be multiple ToUnicode directories.
There are no default ToUnicode directories.
.SH DISPLAY FONTS
.TP
.BI displayFontX " PDF\-font\-name XLFD encoding\-name"
Maps a PDF font,
.IR PDF\-font\-name ,
to an X font,
.IR XLFD ,
for display.  The XLFD (X Logical Font Descriptor) should contain the
string "%s", which will be replaced by xpdf with the font size.  If
the XLFD contains spaces it must be quoted.  The
.I encoding\-name
must be defined with the
.I unicodeMap
command (see above).  By default, the Base-14 fonts are mapped to
standard X fonts, using the
.IR Latin1 ,
.IR Symbol ,
and
.I ZapfDingbats
encodings.
.TP
.BI displayFontT1 " PDF\-font\-name T1\-file"
Maps a PDF font,
.IR PDF\-font\-name ,
to a Type 1 font for display.  The Type 1 font file,
.IR T1\-file ,
should be a standard .pfa or .pfb file.
.TP
.BI displayFontTT " PDF\-font\-name TT\-file"
Maps a PDF font,
.IR PDF\-font\-name ,
to a TrueType font for display.  The TrueType font file,
.IR TT\-file ,
should be a standard .ttf file.
.TP
.BI displayNamedCIDFontX " PDF\-font\-name XLFD encoding\-name"
Maps a specific PDF CID (16-bit) font,
.IR PDF\-font\-name ,
to the X font,
.IR XLFD ,
for display.  The encoding given by
.I encoding\-name
must be defined with the unicodeMap command.  There are no default
display CID font mappings.
.TP
.BI displayCIDFontX " registry\-ordering XLFD encoding\-name"
Maps the
.I registry\-ordering
character collection to the X font,
.IR XLFD ,
for display.  This mapping is used if the font name doesn't match any
of the fonts declared with displayNamedCIDFont* commands.  The
encoding given by
.I encoding\-name
must be defined with the unicodeMap command.  There are no default
display CID font mappings.
.TP
.BI displayNamedCIDFontT1 " PDF\-font\-name T1\-file"
Maps a specific PDF CID (16-bit) font,
.IR PDF\-font\-name ,
to a CID font (16-bit PostScript font), for display.  There are no
default CID font mappings.
.TP
.BI displayCIDFontT1 " registry\-ordering T1\-file"
Maps the
.I registry\-ordering
character collection to a CID font (16-bit PostScript font), for
display.  This mapping is used if the font name doesn't match any of
the fonts declared with displayNamedCIDFont* commands.  There are no
default CID font mappings.
.TP
.BI fontDir " dir"
Specifies a search directory for external font files.  There can be
multiple fontDir directories.  If a PDF file uses a font but doesn't
embed it, these directories will be searched for a matching font file.
These fonts are used by both xpdf (for display) and pdftops (for
embedding in the generated PostScript).  Only files with suffixes of
".pfa", ".pfb", or ".ttf" will be used; other files in these
directories will be ignored.  There are no default fontDir
directories.
.SH POSTSCRIPT CONTROL
.TP
.BI psPaperSize " width(pts) height(pts)"
Sets the paper size for PostScript output.  The
.I width
and
.I height
parameters give the paper size in PostScript points.
.TP
.BR psPaperSize " letter | legal | A4 | A3"
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".
.TP
.BR 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".
.TP
.BR psLevel " level1 | level1sep | level2 | level2sep | level3 | level3Sep"
Sets the PostScript level to generate.  This defaults to "level2".
.TP
.BI psFont " PDF\-font\-name PS\-font\-name"
When the
.I PDF\-font\-name
font is used in a PDF file, it will be translated to the PostScript
font
.IR PS\-font\-name ,