6
xpdfrc - configuration file for Xpdf tools (version 3.02)
9
All of the Xpdf tools read a single configuration file.
10
If you have a .xpdfrc file in your home directory, it will
11
be read. Otherwise, a system-wide configuration file will
12
be read from /usr/local/etc/xpdfrc, if it exists. (This
13
is its default location; depending on build options, it
14
may be placed elsewhere.) On Win32 systems, the xpdfrc
15
file should be placed in the same directory as the exe-
18
The xpdfrc file consists of a series of configuration
19
options, one per line. Blank lines and lines starting
20
with a '#' (comments) are ignored.
22
The following sections list all of the configuration
23
options, sorted into functional groups. There is an exam-
24
ples section at the end.
28
Includes the specified config file. The effect of
29
this is equivalent to inserting the contents of
30
config-file directly into the parent config file in
31
place of the include command. Config files can be
32
nested arbitrarily deeply.
35
nameToUnicode map-file
36
Specifies a file with the mapping from character
37
names to Unicode. This is used to handle PDF fonts
38
that have valid encodings but no ToUnicode entry.
39
Each line of a nameToUnicode file looks like this:
43
The hex-string is the Unicode (UCS-2) character
44
index, and name is the corresponding character
45
name. Multiple nameToUnicode files can be used; if
46
a character name is given more than once, the code
47
in the last specified file is used. There is a
48
built-in default nameToUnicode table with all of
49
Adobe's standard character names.
51
cidToUnicode registry-ordering map-file
52
Specifies the file with the mapping from character
53
collection to Unicode. Each line of a cidToUnicode
54
file represents one character:
58
The hex-string is the Unicode (UCS-2) index for
59
that character. The first line maps CID 0, the
60
second line CID 1, etc. File size is determined by
61
size of the character collection. Only one file is
62
allowed per character collection; the last speci-
63
fied file is used. There are no built-in cidToUni-
66
unicodeToUnicode font-name-substring map-file
67
This is used to work around PDF fonts which have
68
incorrect Unicode information. It specifies a file
69
which maps from the given (incorrect) Unicode
70
indexes to the correct ones. The mapping will be
71
used for any font whose name contains
72
font-name-substring. Each line of a unicodeToUni-
73
code file represents one Unicode character:
75
in-hex out-hex1 out-hex2 ...
77
The in-hex field is an input (incorrect) Unicode
78
index, and the rest of the fields are one or more
79
output (correct) Unicode indexes. Each occurrence
80
of in-hex will be converted to the specified output
83
unicodeMap encoding-name map-file
84
Specifies the file with mapping from Unicode to
85
encoding-name. These encodings are used for X dis-
86
play fonts and text output (see below). Each line
87
of a unicodeMap file represents a range of one or
88
more Unicode characters which maps linearly to a
89
range in the output encoding:
91
in-start-hex in-end-hex out-start-hex
93
Entries for single characters can be abbreviated
98
The in-start-hex and in-end-hex fields (or the sin-
99
gle in-hex field) specify the Unicode range. The
100
out-start-hex field (or the out-hex field) speci-
101
fies the start of the output encoding range. The
102
length of the out-start-hex (or out-hex) string
103
determines the length of the output characters
104
(e.g., UTF-8 uses different numbers of bytes to
105
represent characters in different ranges). Entries
106
must be given in increasing Unicode order. Only
107
one file is allowed per encoding; the last speci-
108
fied file is used. The Latin1, ASCII7, Symbol,
109
ZapfDingbats, UTF-8, and UCS-2 encodings are prede-
112
cMapDir registry-ordering dir
113
Specifies a search directory, dir, for CMaps for
114
the registry-ordering character collection. There
115
can be multiple directories for a particular col-
116
lection. There are no default CMap directories.
119
Specifies a search directory, dir, for ToUnicode
120
CMaps. There can be multiple ToUnicode directo-
121
ries. There are no default ToUnicode directories.
124
displayFontT1 PDF-font-name T1-file
125
Maps a PDF font, PDF-font-name, to a Type 1 font
126
for display. The Type 1 font file, T1-file, should
127
be a standard .pfa or .pfb file.
129
displayFontTT PDF-font-name TT-file
130
Maps a PDF font, PDF-font-name, to a TrueType font
131
for display. The TrueType font file, TT-file,
132
should be a standard .ttf file.
134
displayNamedCIDFontT1 PDF-font-name T1-file
135
Maps a specific PDF CID (16-bit) font,
136
PDF-font-name, to a CID font (16-bit PostScript
137
font), for display. There are no default CID font
140
displayCIDFontT1 registry-ordering T1-file
141
Maps the registry-ordering character collection to
142
a CID font (16-bit PostScript font), for display.
143
This mapping is used if the font name doesn't match
144
any of the fonts declared with displayNamedCIDFont*
145
commands. There are no default CID font mappings.
147
displayNamedCIDFontTT PDF-font-name TT-file
148
Maps a specific PDF CID (16-bit) font,
149
PDF-font-name, to a (16-bit) TrueType font, for
150
display. There are no default CID font mappings.
152
displayCIDFontTT registry-ordering TT-file
153
Maps the registry-ordering character collection to
154
a (16-bit) TrueType font, for display. This map-
155
ping is used if the font name doesn't match any of
156
the fonts declared with displayNamedCIDFont* com-
157
mands. There are no default CID font mappings.
160
Specifies a search directory for external font
161
files. There can be multiple fontDir directories.
162
If a PDF file uses a font but doesn't embed it,
163
these directories will be searched for a matching
164
font file. These fonts are used by both xpdf (for
165
display) and pdftops (for embedding in the gener-
166
ated PostScript). Type 1 fonts must have a suffix
167
of ".pfa", ".pfb", ".ps", or no suffix at all.
168
TrueType fonts must have a ".ttf" suffix. Other
169
files in these directories will be ignored. There
170
are no default fontDir directories.
173
psPaperSize width(pts) height(pts)
174
Sets the paper size for PostScript output. The
175
width and height parameters give the paper size in
176
PostScript points (1 point = 1/72 inch).
178
psPaperSize letter | legal | A4 | A3 | match
179
Sets the paper size for PostScript output to a
180
standard size. The default paper size is set when
181
xpdf and pdftops are built, typically to "letter"
182
or "A4". This can also be set to "match", which
183
will set the paper size to match the size specified
186
psImageableArea llx lly urx ury
187
Sets the imageable area for PostScript output. The
188
four integers are the coordinates of the lower-left
189
and upper-right corners of the imageable region,
190
specified in points (with the origin being the
191
lower-left corner of the paper). This defaults to
192
the full paper size; the psPaperSize option will
193
reset the imageable area coordinates.
196
If set to "yes", PostScript output is cropped to
197
the CropBox specified in the PDF file; otherwise no
198
cropping is done. This defaults to "yes".
200
psExpandSmaller yes | no
201
If set to "yes", PDF pages smaller than the
202
PostScript imageable area are expanded to fill the
203
imageable area. Otherwise, no scalling is done on
204
smaller pages. This defaults to "no".
206
psShrinkLarger yes | no
207
If set to yes, PDF pages larger than the PostScript
208
imageable area are shrunk to fit the imageable
209
area. Otherwise, no scaling is done on larger
210
pages. This defaults to "yes".
213
If set to yes, PDF pages smaller than the
214
PostScript imageable area (after any scaling) are
215
centered in the imageable area. Otherwise, they
216
are aligned at the lower-left corner of the image-
217
able area. This defaults to "yes".
220
If set to "yes", the generated PostScript will set
221
the "Duplex" pagedevice entry. This tells duplex-
222
capable printers to enable duplexing. This
225
psLevel level1 | level1sep | level2 | level2sep | level3 |
227
Sets the PostScript level to generate. This
228
defaults to "level2".
230
psFont PDF-font-name PS-font-name
231
When the PDF-font-name font is used in a PDF file,
232
it will be translated to the PostScript font
233
PS-font-name, which is assumed to be resident in
234
the printer. Typically, PDF-font-name and
235
PS-font-name are the same. By default, only the
236
Base-14 fonts are assumed to be resident.
238
psNamedFont16 PDF-font-name wMode PS-font-name encoding
239
When the 16-bit font PDF-font-name is used in a PDF
240
file with the wMode writing mode and is not embed-
241
ded, the PS-font-name font is substituted for it.
242
The writing mode must be either 'H' for horizontal
243
or 'V' for vertical. The PS-font-name font is
244
assumed to be resident in the printer and to use
245
the specified encoding (which must have been
246
defined with the unicodeMap command).
248
psFont16 registry-ordering wMode PS-font-name encoding
249
When a 16-bit font using the registry-ordering
250
character collection and wMode writing mode is not
251
embedded and does not match any of the fonts
252
declared in psNamedFont16 commands, the
253
PS-font-name font is substituted for it. The writ-
254
ing mode must be either 'H' for horizontal or 'V'
255
for vertical. The PS-font-name font is assumed to
256
be resident in the printer and to use the specified
257
writing mode and encoding (which must have been
258
defined with the unicodeMap command).
260
psEmbedType1Fonts yes | no
261
If set to "no", prevents embedding of Type 1 fonts
262
in generated PostScript. This defaults to "yes".
264
psEmbedTrueTypeFonts yes | no
265
If set to "no", prevents embedding of TrueType
266
fonts in generated PostScript. This defaults to
269
psEmbedCIDTrueTypeFonts yes | no
270
If set to "no", prevents embedding of CID TrueType
271
fonts in generated PostScript. For Level 3
272
PostScript, this generates a CID font, for lower
273
levels it generates a non-CID composite font.
275
psEmbedCIDPostScriptFonts yes | no
276
If set to "no", prevents embedding of CID
277
PostScript fonts in generated PostScript. For
278
Level 3 PostScript, this generates a CID font, for
279
lower levels it generates a non-CID composite font.
282
If set to "yes", PDF forms are converted to PS pro-
283
cedures, and image data is preloaded. This uses
284
more memory in the PostScript interpreter, but gen-
285
erates significantly smaller PS files in situations
286
where, e.g., the same image is drawn on every page
287
of a long document. This defaults to "no".
290
If set to "yes", generates PostScript OPI comments
291
for all images and forms which have OPI informa-
292
tion. This option is only available if the Xpdf
293
tools were compiled with OPI support. This
297
If set to "yes", the ASCIIHexEncode filter will be
298
used instead of ASCII85Encode for binary data.
299
This defaults to "no".
301
psFile file-or-command
302
Sets the default PostScript file or print command
303
for xpdf. Commands start with a '|' character;
304
anything else is a file. If the file name or com-
305
mand contains spaces it must be quoted. This
306
defaults to unset, which tells xpdf to generate a
307
name of the form <file>.ps for a PDF file
311
See the description above, in the DISPLAY FONTS
315
textEncoding encoding-name
316
Sets the encoding to use for text output. (This
317
can be overridden with the "-enc" switch on the
318
command line.) The encoding-name must be defined
319
with the unicodeMap command (see above). This
320
defaults to "Latin1".
322
textEOL unix | dos | mac
323
Sets the end-of-line convention to use for text
324
output. The options are:
330
(This can be overridden with the "-eol" switch on
331
the command line.) The default value is based on
332
the OS where xpdf and pdftotext were built.
334
textPageBreaks yes | no
335
If set to "yes", text extraction will insert page
336
breaks (form feed characters) between pages. This
339
textKeepTinyChars yes | no
340
If set to "yes", text extraction will keep all
341
characters. If set to "no", text extraction will
342
discard tiny (smaller than 3 point) characters
343
after the first 50000 per page, avoiding extremely
344
slow run times for PDF files that use special fonts
345
to do shading or cross-hatching. This defaults to
348
MISCELLANEOUS SETTINGS
349
initialZoom percentage | page | width
350
Sets the initial zoom factor. A number specifies a
351
zoom percentage, where 100 means 72 dpi. You may
352
also specify 'page', to fit the page to the window
353
size, or 'width', to fit the page width to the win-
356
continuousView yes | no
357
If set to "yes", xpdf will start in continuous view
358
mode, i.e., with one vertical screoll bar for the
359
whole document. This defaults to "no".
362
Enables or disables use of t1lib (a Type 1 font
363
rasterizer). This is only relevant if the Xpdf
364
tools were built with t1lib support.
365
("enableT1lib" replaces the old "t1libControl"
366
option.) This option defaults to "yes".
368
enableFreeType yes | no
369
Enables or disables use of FreeType (a TrueType /
370
Type 1 font rasterizer). This is only relevant if
371
the Xpdf tools were built with FreeType support.
372
("enableFreeType" replaces the old "freetypeCon-
373
trol" option.) This option defaults to "yes".
376
Enables or disables font anti-aliasing in the PDF
377
rasterizer. This option affects all font rasteriz-
378
ers. ("antialias" replaces the anti-aliasing con-
379
trol provided by the old "t1libControl" and
380
"freetypeControl" options.) This default to "yes".
382
vectorAntialias yes | no
383
Enables or disables anti-aliasing of vector graph-
384
ics in the PDF rasterizer. This defaults to "yes".
386
strokeAdjust yes | no
387
Enables or disables stroke adjustment. This
390
screenType dispersed | clustered | stochasticClustered
391
Sets the halftone screen type, which will be used
392
when generating a monochrome (1-bit) bitmap. The
393
three options are dispersed-dot dithering, clus-
394
tered-dot dithering (with a round dot and 45-degree
395
screen angle), and stochastic clustered-dot dither-
396
ing. By default, "stochasticClustered" is used for
397
resolutions of 300 dpi and higher, and "dispersed"
398
is used for resolutions lower then 300 dpi.
401
Sets the size of the (square) halftone screen
402
threshold matrix. By default, this is 4 for dis-
403
persed-dot dithering, 10 for clustered-dot dither-
404
ing, and 100 for stochastic clustered-dot dither-
407
screenDotRadius integer
408
Sets the halftone screen dot radius. This is only
409
used when screenType is set to stochasticClustered,
410
and it defaults to 2. In clustered-dot mode, the
411
dot radius is half of the screen size. Dispersed-
412
dot dithering doesn't have a dot radius.
415
Sets the halftone screen gamma correction parame-
416
ter. Gamma values greater than 1 make the output
417
brighter; gamma values less than 1 make it darker.
418
The default value is 1.
420
screenBlackThreshold float
421
When halftoning, all values below this threshold
422
are forced to solid black. This parameter is a
423
floating point value between 0 (black) and 1
424
(white). The default value is 0.
426
screenWhiteThreshold float
427
When halftoning, all values above this threshold
428
are forced to solid white. This parameter is a
429
floating point value between 0 (black) and 1
430
(white). The default value is 1.
433
Sets the command executed when you click on a URL
434
link. The string "%s" will be replaced with the
435
URL. (See the example below.) This has no default
439
Sets the command executed when you click on a movie
440
annotation. The string "%s" will be replaced with
441
the movie file name. This has no default value.
443
mapNumericCharNames yes | no
444
If set to "yes", the Xpdf tools will attempt to map
445
various numeric character names sometimes used in
446
font subsets. In some cases this leads to usable
447
text, and in other cases it leads to gibberish --
448
there is no way for Xpdf to tell. This defaults to
451
mapUnknownCharNames yes | no
452
If set to "yes", and mapNumericCharNames is set to
453
"no", the Xpdf tools will apply a simple pass-
454
through mapping (Unicode index = character code)
455
for all unrecognized glyph names. In some cases,
456
this leads to usable text, and in other cases it
457
leads to gibberish -- there is no way for Xpdf to
458
tell. This defaults to "no".
460
bind modifiers-key context command ...
461
Add a key or mouse button binding. Modifiers can
468
Key can be a regular ASCII character, or any one
482
left / right / up / down (arrow keys)
483
f1 .. f35 (function keys)
484
mousePress1 .. mousePress7 (mouse buttons)
485
mouseRelease1 .. mouseRelease7 (mouse buttons)
487
Context is either "any" or a comma-separated combi-
490
fullScreen / window (full screen mode on/off)
491
continuous / singlePage (continuous mode on/off)
492
overLink / offLink (mouse over link or not)
493
scrLockOn / scrLockOff (scroll lock on/off)
495
The context string can include only one of each
496
pair in the above list.
498
Command is an Xpdf command (see the COMMANDS sec-
499
tion of the xpdf(1) man page for details). Multi-
500
ple commands are separated by whitespace.
502
The bind command replaces any existing binding, but
503
only if it was defined for the exact same modi-
504
fiers, key, and context. All tokens (modifiers,
505
key, context, commands) are case-sensitive.
507
Example key bindings:
509
# bind ctrl-a in any context to the nextPage
511
bind ctrl-a any nextPage
513
# bind uppercase B, when in continuous mode
514
# with scroll lock on, to the reload command
515
# followed by the prevPage command
516
bind B continuous,scrLockOn reload prevPage
518
See the xpdf(1) man page for more examples.
520
unbind modifiers-key context
521
Removes a key binding established with the bind
522
command. This is most useful to remove default key
523
bindings before establishing new ones (e.g., if the
524
default key binding is given for "any" context, and
525
you want to create new key bindings for multiple
528
printCommands yes | no
529
If set to "yes", drawing commands are printed as
530
they're executed (useful for debugging). This
534
If set to "yes", this suppresses all error and
535
warning messages from all of the Xpdf tools. This
539
The following is a sample xpdfrc file.
541
# from the Thai support package
542
nameToUnicode /usr/local/share/xpdf/Thai.nameToUnicode
544
# from the Japanese support package
545
cidToUnicode Adobe-Japan1 /usr/local/share/xpdf/Adobe-Japan1.cidToUnicode
546
unicodeMap JISX0208 /usr/local/share/xpdf/JISX0208.unicodeMap
547
cMapDir Adobe-Japan1 /usr/local/share/xpdf/cmap/Adobe-Japan1
549
# use the Base-14 Type 1 fonts from ghostscript
550
displayFontT1 Times-Roman /usr/local/share/ghostscript/fonts/n021003l.pfb
551
displayFontT1 Times-Italic /usr/local/share/ghostscript/fonts/n021023l.pfb
552
displayFontT1 Times-Bold /usr/local/share/ghostscript/fonts/n021004l.pfb
553
displayFontT1 Times-BoldItalic /usr/local/share/ghostscript/fonts/n021024l.pfb
554
displayFontT1 Helvetica /usr/local/share/ghostscript/fonts/n019003l.pfb
555
displayFontT1 Helvetica-Oblique /usr/local/share/ghostscript/fonts/n019023l.pfb
556
displayFontT1 Helvetica-Bold /usr/local/share/ghostscript/fonts/n019004l.pfb
557
displayFontT1 Helvetica-BoldOblique /usr/local/share/ghostscript/fonts/n019024l.pfb
558
displayFontT1 Courier /usr/local/share/ghostscript/fonts/n022003l.pfb
559
displayFontT1 Courier-Oblique /usr/local/share/ghostscript/fonts/n022023l.pfb
560
displayFontT1 Courier-Bold /usr/local/share/ghostscript/fonts/n022004l.pfb
561
displayFontT1 Courier-BoldOblique /usr/local/share/ghostscript/fonts/n022024l.pfb
562
displayFontT1 Symbol /usr/local/share/ghostscript/fonts/s050000l.pfb
563
displayFontT1 ZapfDingbats /usr/local/share/ghostscript/fonts/d050000l.pfb
565
# use the Bakoma Type 1 fonts
566
# (this assumes they happen to be installed in /usr/local/fonts/bakoma)
567
fontDir /usr/local/fonts/bakoma
569
# set some PostScript options
573
psEmbedType1Fonts yes
574
psEmbedTrueTypeFonts yes
575
psFile "| lpr -Pprinter5"
577
# assume that the PostScript printer has the Univers and
579
psFont Univers Univers
580
psFont Univers-Bold Univers-Bold
582
# set the text output options
589
urlCommand "netscape -remote 'openURL(%s)'"
593
/usr/local/etc/xpdfrc
594
This is the default location for the system-wide
595
configuration file. Depending on build options, it
596
may be placed elsewhere.
599
This is the user's configuration file. If it
600
exists, it will be read in place of the system-wide
604
The Xpdf software and documentation are copyright
605
1996-2007 Glyph & Cog, LLC.
608
xpdf(1), pdftops(1), pdftotext(1), pdfinfo(1),
609
pdftoppm(1), pdfimages(1)
610
http://www.foolabs.com/xpdf/
614
27 February 2007 xpdfrc(5)
added
removed
source/libs/xpdf/xpdf-3.02/doc/xpdfrc.cat
