1 | .\" Copyright 2002-2017 Glyph & Cog, LLC
|
---|
2 | .TH xpdfrc 5 "10 Aug 2017"
|
---|
3 | .SH NAME
|
---|
4 | xpdfrc \- configuration file for Xpdf tools (version 4.00)
|
---|
5 | .SH DESCRIPTION
|
---|
6 | All of the Xpdf tools read a single configuration file. If you have a
|
---|
7 | .I .xpdfrc
|
---|
8 | file in your home directory, it will be read. Otherwise, a
|
---|
9 | system-wide configuration file will be read from
|
---|
10 | .IR /usr/local/etc/xpdfrc ,
|
---|
11 | if it exists. (This is its default location; depending on build
|
---|
12 | options, it may be placed elsewhere.) On Win32 systems, the
|
---|
13 | .I xpdfrc
|
---|
14 | file should be placed in the same directory as the executables.
|
---|
15 | .PP
|
---|
16 | The xpdfrc file consists of a series of configuration options, one
|
---|
17 | per line. Blank lines and lines starting with a \'#' (comments) are
|
---|
18 | ignored.
|
---|
19 | .PP
|
---|
20 | Arguments may be quoted, using "double-quote" characters, e.g., for
|
---|
21 | file names that contain spaces.
|
---|
22 | .PP
|
---|
23 | The following sections list all of the configuration options, sorted
|
---|
24 | into functional groups. There is an examples section at the end.
|
---|
25 | .SH INCLUDE FILES
|
---|
26 | .TP
|
---|
27 | .BI include " config\-file"
|
---|
28 | Includes the specified config file. The effect of this is equivalent
|
---|
29 | to inserting the contents of
|
---|
30 | .I config\-file
|
---|
31 | directly into the parent config file in place of the
|
---|
32 | .I include
|
---|
33 | command. Config files can be nested arbitrarily deeply.
|
---|
34 | .SH GENERAL FONT CONFIGURATION
|
---|
35 | .TP
|
---|
36 | .BI fontFile " PDF\-font\-name font\-file"
|
---|
37 | Maps a PDF font,
|
---|
38 | .IR PDF\-font\-name ,
|
---|
39 | to a font for display or PostScript output. The font file,
|
---|
40 | .IR font\-file ,
|
---|
41 | can be any type allowed in a PDF file. This command can be used for
|
---|
42 | 8-bit or 16-bit (CID) fonts.
|
---|
43 | .TP
|
---|
44 | .BI fontDir " dir"
|
---|
45 | Specifies a search directory for font files. There can be multiple
|
---|
46 | fontDir commands; all of the specified directories will be searched in
|
---|
47 | order. The font files can be Type 1 (.pfa or .pfb) or TrueType (.ttf
|
---|
48 | or .ttc); other files in the directory will be ignored. The font file
|
---|
49 | name (not including the extension) must exactly match the PDF font
|
---|
50 | name. This search is performed if the font name doesn't match any of
|
---|
51 | the fonts declared with the fontFile command. There are no default
|
---|
52 | fontDir directories.
|
---|
53 | .TP
|
---|
54 | .BI fontFileCC " registry\-ordering font\-file"
|
---|
55 | Maps the
|
---|
56 | .I registry\-ordering
|
---|
57 | character collection to a font for display or PostScript output. This
|
---|
58 | mapping is used if the font name doesn't match any of the fonts
|
---|
59 | declared with the fontFile, fontDir, psResidentFont16, or
|
---|
60 | psResidentFontCC commands.
|
---|
61 | .SH POSTSCRIPT FONT CONFIGURATION
|
---|
62 | .TP
|
---|
63 | .BR psFontPassthrough " yes | no"
|
---|
64 | If set to "yes", pass 8-bit font names through to the PostScript
|
---|
65 | output without substitution. Fonts which are not embedded in the PDF
|
---|
66 | file are expected to be available on the printer. This defaults to
|
---|
67 | "no".
|
---|
68 | .TP
|
---|
69 | .BI psResidentFont " PDF\-font\-name PS\-font\-name"
|
---|
70 | When the 8-bit font
|
---|
71 | .I PDF\-font\-name
|
---|
72 | is used (without embedding) in a PDF file, it will be translated to
|
---|
73 | the PostScript font
|
---|
74 | .IR PS\-font\-name ,
|
---|
75 | which is assumed to be resident in the printer. Typically,
|
---|
76 | .I PDF\-font\-name
|
---|
77 | and
|
---|
78 | .I PS\-font\-name
|
---|
79 | are the same. By default, only the Base-14 fonts are assumed to be
|
---|
80 | resident.
|
---|
81 | .TP
|
---|
82 | .BI psResidentFont16 " PDF\-font\-name wMode PS\-font\-name encoding"
|
---|
83 | When the 16-bit (CID) font
|
---|
84 | .I PDF\-font\-name
|
---|
85 | with writing mode
|
---|
86 | .I wMode
|
---|
87 | is used (without embedding) in a PDF file, it will be translated to
|
---|
88 | the PostScript font
|
---|
89 | .IR PS\-font\-name ,
|
---|
90 | which is assumed to be resident in the printer. The writing mode
|
---|
91 | must be either \'H' for horizontal or \'V' for vertical. The resident
|
---|
92 | font is assumed to use the specified encoding (which must have been
|
---|
93 | defined with the unicodeMap command).
|
---|
94 | .TP
|
---|
95 | .BI psResidentFontCC " registry\-ordering wMode PS\-font\-name encoding"
|
---|
96 | When a 16-bit (CID) font using the
|
---|
97 | .I registry\-ordering
|
---|
98 | character collection and
|
---|
99 | .I wMode
|
---|
100 | writing mode is used (without embedding) in a PDF file, the PostScript
|
---|
101 | font,
|
---|
102 | .IR PS\-font\-name ,
|
---|
103 | is substituted for it. The substituted font is assumed to be
|
---|
104 | resident in the printer. The writing mode must be either \'H' for
|
---|
105 | horizontal or \'V' for vertical. The resident font is assumed to use
|
---|
106 | the specified encoding (which must have been defined with the
|
---|
107 | unicodeMap command).
|
---|
108 | .TP
|
---|
109 | .BR psEmbedType1Fonts " yes | no"
|
---|
110 | If set to "no", prevents embedding of Type 1 fonts in generated
|
---|
111 | PostScript. This defaults to "yes".
|
---|
112 | .TP
|
---|
113 | .BR psEmbedTrueTypeFonts " yes | no"
|
---|
114 | If set to "no", prevents embedding of TrueType fonts in generated
|
---|
115 | PostScript. This defaults to "yes".
|
---|
116 | .TP
|
---|
117 | .BR psEmbedCIDTrueTypeFonts " yes | no"
|
---|
118 | If set to "no", prevents embedding of CID TrueType fonts in generated
|
---|
119 | PostScript. For Level 3 PostScript, this generates a CID font, for
|
---|
120 | lower levels it generates a non-CID composite font. This defaults to
|
---|
121 | "yes".
|
---|
122 | .TP
|
---|
123 | .BR psEmbedCIDPostScriptFonts " yes | no"
|
---|
124 | If set to "no", prevents embedding of CID PostScript fonts in
|
---|
125 | generated PostScript. For Level 3 PostScript, this generates a CID
|
---|
126 | font, for lower levels it generates a non-CID composite font. This
|
---|
127 | defaults to "yes".
|
---|
128 | .SH POSTSCRIPT CONTROL
|
---|
129 | .TP
|
---|
130 | .BI psPaperSize " width(pts) height(pts)"
|
---|
131 | Sets the paper size for PostScript output. The
|
---|
132 | .I width
|
---|
133 | and
|
---|
134 | .I height
|
---|
135 | parameters give the paper size in PostScript points (1 point = 1/72
|
---|
136 | inch).
|
---|
137 | .TP
|
---|
138 | .BR psPaperSize " letter | legal | A4 | A3 | match"
|
---|
139 | Sets the paper size for PostScript output to a standard size. The
|
---|
140 | default paper size is set when xpdf and pdftops are built, typically
|
---|
141 | to "letter" or "A4". This can also be set to "match", which will set
|
---|
142 | the paper size to match the size specified in the PDF file.
|
---|
143 | .TP
|
---|
144 | .BR psImageableArea " llx lly urx ury"
|
---|
145 | Sets the imageable area for PostScript output. The four integers are
|
---|
146 | the coordinates of the lower-left and upper-right corners of the
|
---|
147 | imageable region, specified in points (with the origin being the
|
---|
148 | lower-left corner of the paper). This defaults to the full paper
|
---|
149 | size; the psPaperSize option will reset the imageable area
|
---|
150 | coordinates.
|
---|
151 | .TP
|
---|
152 | .BR psCrop " yes | no"
|
---|
153 | If set to "yes", PostScript output is cropped to the CropBox specified
|
---|
154 | in the PDF file; otherwise no cropping is done. This defaults to
|
---|
155 | "yes".
|
---|
156 | .TP
|
---|
157 | .BR psUseCropBoxAsPage " yes | no"
|
---|
158 | If set to "yes", PostScript output treats the CropBox as the page size.
|
---|
159 | By default, this is "no", and the MediaBox is used as the page size.
|
---|
160 | .TP
|
---|
161 | .BR psExpandSmaller " yes | no"
|
---|
162 | If set to "yes", PDF pages smaller than the PostScript imageable area
|
---|
163 | are expanded to fill the imageable area. Otherwise, no scaling is
|
---|
164 | done on smaller pages. This defaults to "no".
|
---|
165 | .TP
|
---|
166 | .BR psShrinkLarger " yes | no"
|
---|
167 | If set to yes, PDF pages larger than the PostScript imageable area are
|
---|
168 | shrunk to fit the imageable area. Otherwise, no scaling is done on
|
---|
169 | larger pages. This defaults to "yes".
|
---|
170 | .TP
|
---|
171 | .BR psCenter " yes | no"
|
---|
172 | If set to yes, PDF pages smaller than the PostScript imageable area
|
---|
173 | (after any scaling) are centered in the imageable area. Otherwise,
|
---|
174 | they are aligned at the lower-left corner of the imageable area. This
|
---|
175 | defaults to "yes".
|
---|
176 | .TP
|
---|
177 | .BR psDuplex " yes | no"
|
---|
178 | If set to "yes", the generated PostScript will set the "Duplex"
|
---|
179 | pagedevice entry. This tells duplex-capable printers to enable
|
---|
180 | duplexing. This defaults to "no".
|
---|
181 | .TP
|
---|
182 | .BR psLevel " level1 | level1sep | level2 | level2gray | level2sep | level3 | level3gray | level3Sep"
|
---|
183 | Sets the PostScript level to generate. This defaults to "level2".
|
---|
184 | .TP
|
---|
185 | .BR psPreload " yes | no"
|
---|
186 | If set to "yes", PDF forms are converted to PS procedures, and image
|
---|
187 | data is preloaded. This uses more memory in the PostScript
|
---|
188 | interpreter, but generates significantly smaller PS files in
|
---|
189 | situations where, e.g., the same image is drawn on every page of a
|
---|
190 | long document. This defaults to "no".
|
---|
191 | .TP
|
---|
192 | .BR psOPI " yes | no"
|
---|
193 | If set to "yes", generates PostScript OPI comments for all images and
|
---|
194 | forms which have OPI information. This option is only available if
|
---|
195 | the Xpdf tools were compiled with OPI support. This defaults to "no".
|
---|
196 | .TP
|
---|
197 | .BR psASCIIHex " yes | no"
|
---|
198 | If set to "yes", the ASCIIHexEncode filter will be used instead of
|
---|
199 | ASCII85Encode for binary data. This defaults to "no".
|
---|
200 | .TP
|
---|
201 | .BR psLZW " yes | no"
|
---|
202 | If set to "yes", the LZWEncode filter will be used for lossless
|
---|
203 | compression in PostScript output; if set to "no", the RunLengthEncode
|
---|
204 | filter will be used instead. LZW generates better compression
|
---|
205 | (smaller PS files), but may not be supported by some printers. This
|
---|
206 | defaults to "yes".
|
---|
207 | .TP
|
---|
208 | .BR psUncompressPreloadedImages " yes | no"
|
---|
209 | If set to "yes", all preloaded images in PS files will uncompressed.
|
---|
210 | If set to "no", the original compressed images will be used when
|
---|
211 | possible. The "yes" setting is useful to work around certain buggy
|
---|
212 | PostScript interpreters. This defaults to "no".
|
---|
213 | .TP
|
---|
214 | .BR psMinLineWidth " float"
|
---|
215 | Set the minimum line width, in points, for PostScript output. The
|
---|
216 | default value is 0 (no minimum).
|
---|
217 | .TP
|
---|
218 | .BR psRasterResolution " float"
|
---|
219 | Set the resolution (in dpi) for rasterized pages in PostScript output.
|
---|
220 | (Pdftops will rasterize pages which use transparency.) This defaults
|
---|
221 | to 300.
|
---|
222 | .TP
|
---|
223 | .BR psRasterMono " yes | no"
|
---|
224 | If set to "yes", rasterized pages in PS files will be monochrome
|
---|
225 | (8-bit gray) instead of color. This defaults to "no".
|
---|
226 | .TP
|
---|
227 | .BR psRasterSliceSize " pixels"
|
---|
228 | When rasterizing pages, pdftops splits the page into horizontal
|
---|
229 | "slices", to limit memory usage. This option sets the maximum slice
|
---|
230 | size, in pixels. This defaults to 20000000 (20 million).
|
---|
231 | .TP
|
---|
232 | .BR psAlwaysRasterize " yes | no"
|
---|
233 | If set to "yes", all PostScript output will be rasterized. This
|
---|
234 | defaults to "no".
|
---|
235 | .TP
|
---|
236 | .BR psNeverRasterize " yes | no"
|
---|
237 | If set to "yes", PostScript output will never be rasterized. This
|
---|
238 | will likely result in incorrect output for PDF files that use
|
---|
239 | transparency. (If both psAlwaysRasterize and psNeverRasterize are set
|
---|
240 | to "yes", the psAlwaysRasterize setting wins.) This defaults to "no".
|
---|
241 | .TP
|
---|
242 | .BI psFile " file\-or\-command"
|
---|
243 | Sets the default PostScript file or print command for xpdf. Commands
|
---|
244 | start with a \'|' character; anything else is a file. If the file
|
---|
245 | name or command contains spaces it must be quoted. This defaults to
|
---|
246 | unset, which tells xpdf to generate a name of the form <file>.ps for a
|
---|
247 | PDF file <file>.pdf.
|
---|
248 | .TP
|
---|
249 | .BI fontDir " dir"
|
---|
250 | See the description above, in the DISPLAY FONTS section.
|
---|
251 | .SH TEXT CONTROL AND CHARACTER MAPPING
|
---|
252 | .TP
|
---|
253 | .BI textEncoding " encoding\-name"
|
---|
254 | Sets the encoding to use for text output. (This can be overridden
|
---|
255 | with the "\-enc" switch on the command line.) The
|
---|
256 | .I encoding\-name
|
---|
257 | must be defined with the unicodeMap command (see above). This
|
---|
258 | defaults to "Latin1".
|
---|
259 | .TP
|
---|
260 | .BR textEOL " unix | dos | mac"
|
---|
261 | Sets the end-of-line convention to use for text output. The options
|
---|
262 | are:
|
---|
263 | .nf
|
---|
264 |
|
---|
265 | unix = LF
|
---|
266 | dos = CR+LF
|
---|
267 | mac = CR
|
---|
268 |
|
---|
269 | .fi
|
---|
270 | (This can be overridden with the "\-eol" switch on the command line.)
|
---|
271 | The default value is based on the OS where xpdf and pdftotext were
|
---|
272 | built.
|
---|
273 | .TP
|
---|
274 | .BR textPageBreaks " yes | no"
|
---|
275 | If set to "yes", text extraction will insert page breaks (form feed
|
---|
276 | characters) between pages. This defaults to "yes".
|
---|
277 | .TP
|
---|
278 | .BR textKeepTinyChars " yes | no"
|
---|
279 | If set to "yes", text extraction will keep all characters. If set to
|
---|
280 | "no", text extraction will discard tiny (smaller than 3 point)
|
---|
281 | characters after the first 50000 per page, avoiding extremely slow run
|
---|
282 | times for PDF files that use special fonts to do shading or
|
---|
283 | cross-hatching. This defaults to "yes".
|
---|
284 | .TP
|
---|
285 | .BI nameToUnicode " map\-file"
|
---|
286 | Specifies a file with the mapping from character names to Unicode.
|
---|
287 | This is used to handle PDF fonts that have valid encodings but no
|
---|
288 | ToUnicode entry. Each line of a nameToUnicode file looks like this:
|
---|
289 |
|
---|
290 | .I " " hex\-string name
|
---|
291 |
|
---|
292 | The
|
---|
293 | .I hex\-string
|
---|
294 | is the Unicode (UCS-2) character index, and
|
---|
295 | .I name
|
---|
296 | is the corresponding character name. Multiple nameToUnicode files can
|
---|
297 | be used; if a character name is given more than once, the code in the
|
---|
298 | last specified file is used. There is a built-in default
|
---|
299 | nameToUnicode table with all of Adobe's standard character names.
|
---|
300 | .TP
|
---|
301 | .BI cidToUnicode " registry\-ordering map\-file"
|
---|
302 | Specifies the file with the mapping from character collection to
|
---|
303 | Unicode. Each line of a cidToUnicode file represents one character:
|
---|
304 |
|
---|
305 | .I " " hex\-string
|
---|
306 |
|
---|
307 | The
|
---|
308 | .I hex\-string
|
---|
309 | is the Unicode (UCS-2) index for that character. The first line maps
|
---|
310 | CID 0, the second line CID 1, etc. File size is determined by size of
|
---|
311 | the character collection. Only one file is allowed per character
|
---|
312 | collection; the last specified file is used. There are no built-in
|
---|
313 | cidToUnicode mappings.
|
---|
314 | .TP
|
---|
315 | .BI unicodeToUnicode " font\-name\-substring map\-file"
|
---|
316 | This is used to work around PDF fonts which have incorrect Unicode
|
---|
317 | information. It specifies a file which maps from the given
|
---|
318 | (incorrect) Unicode indexes to the correct ones. The mapping will be
|
---|
319 | used for any font whose name contains
|
---|
320 | .IR font\-name\-substring .
|
---|
321 | Each line of a unicodeToUnicode file represents one Unicode character:
|
---|
322 |
|
---|
323 | .RI " " in\-hex " " out\-hex1 " " out\-hex2 " ..."
|
---|
324 |
|
---|
325 | The
|
---|
326 | .I in\-hex
|
---|
327 | field is an input (incorrect) Unicode index, and the rest of the
|
---|
328 | fields are one or more output (correct) Unicode indexes. Each
|
---|
329 | occurrence of
|
---|
330 | .I in\-hex
|
---|
331 | will be converted to the specified output sequence.
|
---|
332 | .TP
|
---|
333 | .BI unicodeMap " encoding\-name map\-file"
|
---|
334 | Specifies the file with mapping from Unicode to
|
---|
335 | .IR encoding\-name .
|
---|
336 | These encodings are used for text output (see below). Each line of a
|
---|
337 | unicodeMap file represents a range of one or more Unicode characters
|
---|
338 | which maps linearly to a range in the output encoding:
|
---|
339 | .nf
|
---|
340 |
|
---|
341 | .I " " in\-start\-hex in\-end\-hex out\-start\-hex
|
---|
342 |
|
---|
343 | .fi
|
---|
344 | Entries for single characters can be abbreviated to:
|
---|
345 | .nf
|
---|
346 |
|
---|
347 | .I " " in\-hex out\-hex
|
---|
348 |
|
---|
349 | .fi
|
---|
350 | The
|
---|
351 | .I in\-start\-hex
|
---|
352 | and
|
---|
353 | .I in\-end\-hex
|
---|
354 | fields (or the single
|
---|
355 | .I in\-hex
|
---|
356 | field) specify the Unicode range. The
|
---|
357 | .I out\-start\-hex
|
---|
358 | field (or the
|
---|
359 | .I out\-hex
|
---|
360 | field) specifies the start of the output encoding range. The length
|
---|
361 | of the
|
---|
362 | .I out\-start\-hex
|
---|
363 | (or
|
---|
364 | .IR out\-hex )
|
---|
365 | string determines the length of the output characters (e.g., UTF-8
|
---|
366 | uses different numbers of bytes to represent characters in different
|
---|
367 | ranges). Entries must be given in increasing Unicode order. Only one
|
---|
368 | file is allowed per encoding; the last specified file is used. The
|
---|
369 | .IR Latin1 ,
|
---|
370 | .IR ASCII7 ,
|
---|
371 | .IR Symbol ,
|
---|
372 | .IR ZapfDingbats ,
|
---|
373 | .IR UTF-8 ,
|
---|
374 | and
|
---|
375 | .I UCS-2
|
---|
376 | encodings are predefined.
|
---|
377 | .TP
|
---|
378 | .BI cMapDir " registry\-ordering dir"
|
---|
379 | Specifies a search directory,
|
---|
380 | .IR dir ,
|
---|
381 | for CMaps for the
|
---|
382 | .I registry\-ordering
|
---|
383 | character collection. There can be multiple directories for a
|
---|
384 | particular collection. There are no default CMap directories.
|
---|
385 | .TP
|
---|
386 | .BI toUnicodeDir " dir"
|
---|
387 | Specifies a search directory,
|
---|
388 | .IR dir ,
|
---|
389 | for ToUnicode CMaps. There can be multiple ToUnicode directories.
|
---|
390 | There are no default ToUnicode directories.
|
---|
391 | .TP
|
---|
392 | .BI mapNumericCharNames " yes | no"
|
---|
393 | If set to "yes", the Xpdf tools will attempt to map various numeric
|
---|
394 | character names sometimes used in font subsets. In some cases this
|
---|
395 | leads to usable text, and in other cases it leads to gibberish --
|
---|
396 | there is no way for Xpdf to tell. This defaults to "yes".
|
---|
397 | .TP
|
---|
398 | .BI mapUnknownCharNames " yes | no"
|
---|
399 | If set to "yes", and mapNumericCharNames is set to "no", the Xpdf
|
---|
400 | tools will apply a simple pass-through mapping (Unicode index =
|
---|
401 | character code) for all unrecognized glyph names. (For CID fonts,
|
---|
402 | setting mapNumericCharNames to "no" is unnecessary.) In some cases,
|
---|
403 | this leads to usable text, and in other cases it leads to gibberish --
|
---|
404 | there is no way for Xpdf to tell. This defaults to "no".
|
---|
405 | .TP
|
---|
406 | .BI mapExtTrueTypeFontsViaUnicode " yes | no"
|
---|
407 | When rasterizing text using an external TrueType font, there are two
|
---|
408 | options for handling character codes. If
|
---|
409 | mapExtTrueTypeFontsViaUnicode is set to "yes", Xpdf will use the font
|
---|
410 | encoding/ToUnicode info to map character codes to Unicode, and then
|
---|
411 | use the font's Unicode cmap to map Unicode to GIDs. If
|
---|
412 | mapExtTrueTypeFontsViaUnicode is set to "no", Xpdf will assume the
|
---|
413 | character codes are GIDs (i.e., use an identity mapping). This
|
---|
414 | defaults to "yes".
|
---|
415 | .SH RASTERIZER SETTINGS
|
---|
416 | .TP
|
---|
417 | .BR enableFreeType " yes | no"
|
---|
418 | Enables or disables use of FreeType (a TrueType / Type 1 font
|
---|
419 | rasterizer). This is only relevant if the Xpdf tools were built with
|
---|
420 | FreeType support. ("enableFreeType" replaces the old
|
---|
421 | "freetypeControl" option.) This option defaults to "yes".
|
---|
422 | .TP
|
---|
423 | .BR disableFreeTypeHinting " yes | no"
|
---|
424 | If this is set to "yes", FreeType hinting will be forced off. This
|
---|
425 | option defaults to "no".
|
---|
426 | .TP
|
---|
427 | .BR antialias " yes | no"
|
---|
428 | Enables or disables font anti-aliasing in the PDF rasterizer. This
|
---|
429 | option affects all font rasterizers. ("antialias" replaces the
|
---|
430 | anti-aliasing control provided by the old "t1libControl" and
|
---|
431 | "freetypeControl" options.) This default to "yes".
|
---|
432 | .TP
|
---|
433 | .BR vectorAntialias " yes | no"
|
---|
434 | Enables or disables anti-aliasing of vector graphics in the PDF
|
---|
435 | rasterizer. This defaults to "yes".
|
---|
436 | .TP
|
---|
437 | .BR antialiasPrinting " yes | no"
|
---|
438 | If this is "yes", bitmaps sent to the printer will be antialiased
|
---|
439 | (according to the "antialias" and "vectorAntialias" settings). If
|
---|
440 | this is "no", printed bitmaps will not be antialiased. This defaults
|
---|
441 | to "no".
|
---|
442 | .TP
|
---|
443 | .BR strokeAdjust " yes | no | cad"
|
---|
444 | Sets the stroke adjustment mode. If set to "no", no stroke adjustment
|
---|
445 | will be done. If set to "yes", normal stroke adjustment will be done:
|
---|
446 | horizontal and vertical lines will be moved by up to half a pixel to
|
---|
447 | make them look cleaner when vector anti-aliasing is enabled. If set
|
---|
448 | to "cad", a slightly different stroke adjustment algorithm will be
|
---|
449 | used to ensure that lines of the same original width will always have
|
---|
450 | the same adjusted width (at the expense of allowing gaps and overlaps
|
---|
451 | between adjacent lines). This defaults to "yes".
|
---|
452 | .TP
|
---|
453 | .BR screenType " dispersed | clustered | stochasticClustered"
|
---|
454 | Sets the halftone screen type, which will be used when generating a
|
---|
455 | monochrome (1-bit) bitmap. The three options are dispersed-dot
|
---|
456 | dithering, clustered-dot dithering (with a round dot and 45-degree
|
---|
457 | screen angle), and stochastic clustered-dot dithering. By default,
|
---|
458 | "stochasticClustered" is used for resolutions of 300 dpi and higher,
|
---|
459 | and "dispersed" is used for resolutions lower then 300 dpi.
|
---|
460 | .TP
|
---|
461 | .BI screenSize " integer"
|
---|
462 | Sets the size of the (square) halftone screen threshold matrix. By
|
---|
463 | default, this is 4 for dispersed-dot dithering, 10 for clustered-dot
|
---|
464 | dithering, and 100 for stochastic clustered-dot dithering.
|
---|
465 | .TP
|
---|
466 | .BI screenDotRadius " integer"
|
---|
467 | Sets the halftone screen dot radius. This is only used when
|
---|
468 | screenType is set to stochasticClustered, and it defaults to 2. In
|
---|
469 | clustered-dot mode, the dot radius is half of the screen size.
|
---|
470 | Dispersed-dot dithering doesn't have a dot radius.
|
---|
471 | .TP
|
---|
472 | .BI screenGamma " float"
|
---|
473 | Sets the halftone screen gamma correction parameter. Gamma values
|
---|
474 | greater than 1 make the output brighter; gamma values less than 1 make
|
---|
475 | it darker. The default value is 1.
|
---|
476 | .TP
|
---|
477 | .BI screenBlackThreshold " float"
|
---|
478 | When halftoning, all values below this threshold are forced to solid
|
---|
479 | black. This parameter is a floating point value between 0 (black) and
|
---|
480 | 1 (white). The default value is 0.
|
---|
481 | .TP
|
---|
482 | .BI screenWhiteThreshold " float"
|
---|
483 | When halftoning, all values above this threshold are forced to solid
|
---|
484 | white. This parameter is a floating point value between 0 (black) and
|
---|
485 | 1 (white). The default value is 1.
|
---|
486 | .TP
|
---|
487 | .BI minLineWidth " float"
|
---|
488 | Set the minimum line width, in device pixels. This affects the
|
---|
489 | rasterizer only, not the PostScript converter (except when it uses
|
---|
490 | rasterization to handle transparency). The default value is 0 (no
|
---|
491 | minimum).
|
---|
492 | .TP
|
---|
493 | .BI enablePathSimplification " yes | no"
|
---|
494 | If set to "yes", simplify paths by removing points where it won't make
|
---|
495 | a significant difference to the shape. The default value is "no".
|
---|
496 | .TP
|
---|
497 | .BI overprintPreview " yes | no"
|
---|
498 | If set to "yes", generate overprint preview output, honoring the
|
---|
499 | OP/op/OPM settings in the PDF file. Ignored for non-CMYK output. The
|
---|
500 | default value is "no".
|
---|
501 | .SH VIEWER SETTINGS
|
---|
502 | These settings only apply to the Xpdf GUI PDF viewer.
|
---|
503 | .TP
|
---|
504 | .BR initialZoom " \fIpercentage\fR | page | width"
|
---|
505 | Sets the initial zoom factor. A number specifies a zoom percentage,
|
---|
506 | where 100 means 72 dpi. You may also specify \'page', to fit the page
|
---|
507 | to the window size, or \'width', to fit the page width to the window
|
---|
508 | width.
|
---|
509 | .TP
|
---|
510 | .BI defaultFitZoom " percentage"
|
---|
511 | If xpdf is started with fit-page or fit-width zoom and no window
|
---|
512 | geometry, it will calculate a desired window size based on the PDF
|
---|
513 | page size and this defaultFitZoom value. I.e., the window size will
|
---|
514 | be chosen such that exactly one page will fit in the window at this
|
---|
515 | zoom factor (which must be a percentage). The default value is
|
---|
516 | based on the screen resolution.
|
---|
517 | .TP
|
---|
518 | .BI initialSidebarState " yes | no"
|
---|
519 | If set to "yes", xpdf opens with the sidebar (tabs, outline, etc.)
|
---|
520 | visible. If set to "no", xpdf opens with the sidebar collapsed. The
|
---|
521 | default is "no".
|
---|
522 | .TP
|
---|
523 | .BI paperColor " color"
|
---|
524 | Set the "paper color", i.e., the background of the page display. The
|
---|
525 | color can be #RRGGBB (hexadecimal) or a named color. This option will
|
---|
526 | not work well with PDF files that do things like filling in white
|
---|
527 | behind the text.
|
---|
528 | .TP
|
---|
529 | .BI matteColor " color"
|
---|
530 | Set the matte color, i.e., the color used for background outside the
|
---|
531 | actual page area. The color can be #RRGGBB (hexadecimal) or a named
|
---|
532 | color.
|
---|
533 | .TP
|
---|
534 | .BI fullScreenMatteColor " color"
|
---|
535 | Set the matte color for full-screen mode. The color can be #RRGGBB
|
---|
536 | (hexadecimal) or a named color.
|
---|
537 | .TP
|
---|
538 | .BI popupMenuCmd " title command ..."
|
---|
539 | Add a command to the popup menu.
|
---|
540 | .I Title
|
---|
541 | is the text to be displayed in the menu.
|
---|
542 | .I Command
|
---|
543 | is an Xpdf command (see the COMMANDS section of the
|
---|
544 | .BR xpdf (1)
|
---|
545 | man page for details). Multiple commands are separated by whitespace.
|
---|
546 | .TP
|
---|
547 | .BI maxTileWidth " pixels"
|
---|
548 | Set the maximum width of tiles to be used by xpdf when rasterizing
|
---|
549 | pages. This defaults to 1500.
|
---|
550 | .TP
|
---|
551 | .BI maxTileHeight " pixels"
|
---|
552 | Set the maximum height of tiles to be used by xpdf when rasterizing
|
---|
553 | pages. This defaults to 1500.
|
---|
554 | .TP
|
---|
555 | .BI tileCacheSize " tiles"
|
---|
556 | Set the maximum number of tiles to be cached by xpdf when rasterizing
|
---|
557 | pages. This defaults to 10.
|
---|
558 | .TP
|
---|
559 | .BI workerThreads " numThreads"
|
---|
560 | Set the number of worker threads to be used by xpdf when rasterizing
|
---|
561 | pages. This defaults to 1.
|
---|
562 | .TP
|
---|
563 | .BI launchCommand " command"
|
---|
564 | Sets the command executed when you click on a "launch"-type link. The
|
---|
565 | intent is for the command to be a program/script which determines the
|
---|
566 | file type and runs the appropriate viewer. The command line will
|
---|
567 | consist of the file to be launched, followed by any parameters
|
---|
568 | specified with the link. Do not use "%s" in "command". By default,
|
---|
569 | this is unset, and Xpdf will simply try to execute the file (after
|
---|
570 | prompting the user).
|
---|
571 | .TP
|
---|
572 | .BI movieCommand " command"
|
---|
573 | Sets the command executed when you click on a movie annotation. The
|
---|
574 | string "%s" will be replaced with the movie file name. This has no
|
---|
575 | default value.
|
---|
576 | .TP
|
---|
577 | .BI bind " modifiers-key context command ..."
|
---|
578 | Add a key or mouse button binding.
|
---|
579 | .I Modifiers
|
---|
580 | can be zero or more of:
|
---|
581 | .nf
|
---|
582 |
|
---|
583 | shift-
|
---|
584 | ctrl-
|
---|
585 | alt-
|
---|
586 |
|
---|
587 | .fi
|
---|
588 | .I Key
|
---|
589 | can be a regular ASCII character, or any one of:
|
---|
590 | .nf
|
---|
591 |
|
---|
592 | space
|
---|
593 | tab
|
---|
594 | return
|
---|
595 | enter
|
---|
596 | backspace
|
---|
597 | esc
|
---|
598 | insert
|
---|
599 | delete
|
---|
600 | home
|
---|
601 | end
|
---|
602 | pgup
|
---|
603 | pgdn
|
---|
604 | left / right / up / down (arrow keys)
|
---|
605 | f1 .. f35 (function keys)
|
---|
606 | mousePress1 .. mousePress7 (mouse buttons)
|
---|
607 | mouseRelease1 .. mouseRelease7 (mouse buttons)
|
---|
608 | mouseClick1 .. mouseClick7 (mouse buttons)
|
---|
609 |
|
---|
610 | .fi
|
---|
611 | .I Context
|
---|
612 | is either "any" or a comma-separated combination of:
|
---|
613 | .nf
|
---|
614 |
|
---|
615 | fullScreen / window (full screen mode on/off)
|
---|
616 | continuous / singlePage (continuous mode on/off)
|
---|
617 | overLink / offLink (mouse over link or not)
|
---|
618 | scrLockOn / scrLockOff (scroll lock on/off)
|
---|
619 |
|
---|
620 | .fi
|
---|
621 | The context string can include only one of each pair in the above
|
---|
622 | list.
|
---|
623 |
|
---|
624 | .I Command
|
---|
625 | is an Xpdf command (see the COMMANDS section of the
|
---|
626 | .BR xpdf (1)
|
---|
627 | man page for details). Multiple commands are separated by whitespace.
|
---|
628 |
|
---|
629 | The bind command replaces any existing binding, but only if it was
|
---|
630 | defined for the exact same modifiers, key, and context. All tokens
|
---|
631 | (modifiers, key, context, commands) are case-sensitive.
|
---|
632 |
|
---|
633 | Example key bindings:
|
---|
634 | .nf
|
---|
635 |
|
---|
636 | # bind ctrl-a in any context to the nextPage
|
---|
637 | # command
|
---|
638 | bind ctrl-a any nextPage
|
---|
639 |
|
---|
640 | # bind uppercase B, when in continuous mode
|
---|
641 | # with scroll lock on, to the reload command
|
---|
642 | # followed by the prevPage command
|
---|
643 | bind B continuous,scrLockOn reload prevPage
|
---|
644 |
|
---|
645 | .fi
|
---|
646 | See the
|
---|
647 | .BR xpdf (1)
|
---|
648 | man page for more examples.
|
---|
649 | .TP
|
---|
650 | .BI unbind " modifiers-key context"
|
---|
651 | Removes a key binding established with the bind command. This is most
|
---|
652 | useful to remove default key bindings before establishing new ones
|
---|
653 | (e.g., if the default key binding is given for "any" context, and you
|
---|
654 | want to create new key bindings for multiple contexts).
|
---|
655 | .SH MISCELLANEOUS SETTINGS
|
---|
656 | .TP
|
---|
657 | .BI drawAnnotations " yes | no"
|
---|
658 | If set to "no", annotations will not be drawn or printed. The default
|
---|
659 | value is "yes".
|
---|
660 | .TP
|
---|
661 | .BI drawFormFields " yes | no"
|
---|
662 | If set to "no", form fields will not be drawn or printed. The default
|
---|
663 | value is "yes".
|
---|
664 | .TP
|
---|
665 | .BI enableXFA " yes | no"
|
---|
666 | If set to "yes", an XFA form (if present) will be rendered in place of
|
---|
667 | an AcroForm. If "no", an XFA form will never be rendered. This
|
---|
668 | defaults to "yes".
|
---|
669 | .TP
|
---|
670 | .BI printCommands " yes | no"
|
---|
671 | If set to "yes", drawing commands are printed as they're executed
|
---|
672 | (useful for debugging). This defaults to "no".
|
---|
673 | .TP
|
---|
674 | .BI errQuiet " yes | no"
|
---|
675 | If set to "yes", this suppresses all error and warning messages from
|
---|
676 | all of the Xpdf tools. This defaults to "no".
|
---|
677 | .SH EXAMPLES
|
---|
678 | The following is a sample xpdfrc file.
|
---|
679 | .nf
|
---|
680 |
|
---|
681 | # from the Thai support package
|
---|
682 | nameToUnicode /usr/local/share/xpdf/Thai.nameToUnicode
|
---|
683 |
|
---|
684 | # from the Japanese support package
|
---|
685 | cidToUnicode Adobe-Japan1 /usr/local/share/xpdf/Adobe-Japan1.cidToUnicode
|
---|
686 | unicodeMap JISX0208 /usr/local/share/xpdf/JISX0208.unicodeMap
|
---|
687 | cMapDir Adobe-Japan1 /usr/local/share/xpdf/cmap/Adobe-Japan1
|
---|
688 |
|
---|
689 | # use the Base-14 Type 1 fonts from ghostscript
|
---|
690 | fontFile Times-Roman /usr/local/share/ghostscript/fonts/n021003l.pfb
|
---|
691 | fontFile Times-Italic /usr/local/share/ghostscript/fonts/n021023l.pfb
|
---|
692 | fontFile Times-Bold /usr/local/share/ghostscript/fonts/n021004l.pfb
|
---|
693 | fontFile Times-BoldItalic /usr/local/share/ghostscript/fonts/n021024l.pfb
|
---|
694 | fontFile Helvetica /usr/local/share/ghostscript/fonts/n019003l.pfb
|
---|
695 | fontFile Helvetica-Oblique /usr/local/share/ghostscript/fonts/n019023l.pfb
|
---|
696 | fontFile Helvetica-Bold /usr/local/share/ghostscript/fonts/n019004l.pfb
|
---|
697 | fontFile Helvetica-BoldOblique /usr/local/share/ghostscript/fonts/n019024l.pfb
|
---|
698 | fontFile Courier /usr/local/share/ghostscript/fonts/n022003l.pfb
|
---|
699 | fontFile Courier-Oblique /usr/local/share/ghostscript/fonts/n022023l.pfb
|
---|
700 | fontFile Courier-Bold /usr/local/share/ghostscript/fonts/n022004l.pfb
|
---|
701 | fontFile Courier-BoldOblique /usr/local/share/ghostscript/fonts/n022024l.pfb
|
---|
702 | fontFile Symbol /usr/local/share/ghostscript/fonts/s050000l.pfb
|
---|
703 | fontFile ZapfDingbats /usr/local/share/ghostscript/fonts/d050000l.pfb
|
---|
704 |
|
---|
705 | # use the Bakoma Type 1 fonts
|
---|
706 | # (this assumes they happen to be installed in /usr/local/fonts/bakoma)
|
---|
707 | fontDir /usr/local/fonts/bakoma
|
---|
708 |
|
---|
709 | # set some PostScript options
|
---|
710 | psPaperSize letter
|
---|
711 | psDuplex no
|
---|
712 | psLevel level2
|
---|
713 | psEmbedType1Fonts yes
|
---|
714 | psEmbedTrueTypeFonts yes
|
---|
715 | psFile "| lpr \-Pprinter5"
|
---|
716 |
|
---|
717 | # assume that the PostScript printer has the Univers and
|
---|
718 | # Univers-Bold fonts
|
---|
719 | psResidentFont Univers Univers
|
---|
720 | psResidentFont Univers-Bold Univers-Bold
|
---|
721 |
|
---|
722 | # set the text output options
|
---|
723 | textEncoding UTF-8
|
---|
724 | textEOL unix
|
---|
725 |
|
---|
726 | # misc options
|
---|
727 | enableFreeType yes
|
---|
728 | launchCommand viewer-script
|
---|
729 | urlCommand "netscape \-remote 'openURL(%s)'"
|
---|
730 |
|
---|
731 | .fi
|
---|
732 | .SH FILES
|
---|
733 | .TP
|
---|
734 | .B /usr/local/etc/xpdfrc
|
---|
735 | This is the default location for the system-wide configuration file.
|
---|
736 | Depending on build options, it may be placed elsewhere.
|
---|
737 | .TP
|
---|
738 | .B $HOME/.xpdfrc
|
---|
739 | This is the user's configuration file. If it exists, it will be read
|
---|
740 | in place of the system-wide file.
|
---|
741 | .SH AUTHOR
|
---|
742 | The Xpdf software and documentation are copyright 1996-2017 Glyph &
|
---|
743 | Cog, LLC.
|
---|
744 | .SH "SEE ALSO"
|
---|
745 | .BR xpdf (1),
|
---|
746 | .BR pdftops (1),
|
---|
747 | .BR pdftotext (1),
|
---|
748 | .BR pdftohtml (1),
|
---|
749 | .BR pdfinfo (1),
|
---|
750 | .BR pdffonts (1),
|
---|
751 | .BR pdfdetach (1),
|
---|
752 | .BR pdftoppm (1),
|
---|
753 | .BR pdftopng (1),
|
---|
754 | .BR pdfimages (1)
|
---|
755 | .br
|
---|
756 | .B http://www.xpdfreader.com/
|
---|