| blob | deb9fb4e45ad69e0527907a9a05a810e45b429d8 |
1 ! Generated automatically by mantohlp
2 1 xpdfrc
3 2 NCLUDE_FILE
5 xpdfrc - configuration file for Xpdf tools (version 3.02)
7 include config-file
8 Includes the specified config file. The effect of
9 this is equivalent to inserting the contents of
10 config-file directly into the parent config file in
11 place of the include command. Config files can be
12 nested arbitrarily deeply.
14 ()
16 2 HARACTER_MAPPIN
18 nameToUnicode map-file
19 Specifies a file with the mapping from character
20 names to Unicode. This is used to handle PDF fonts
21 that have valid encodings but no ToUnicode entry.
22 Each line of a nameToUnicode file looks like this:
24 hex-string name
26 The hex-string is the Unicode (UCS-2) character
27 index, and name is the corresponding character
28 name. Multiple nameToUnicode files can be used; if
29 a character name is given more than once, the code
30 in the last specified file is used. There is a
31 built-in default nameToUnicode table with all of
32 Adobe's standard character names.
34 cidToUnicode registry-ordering map-file
35 Specifies the file with the mapping from character
36 collection to Unicode. Each line of a cidToUnicode
37 file represents one character:
39 hex-string
41 The hex-string is the Unicode (UCS-2) index for
42 that character. The first line maps CID 0, the
43 second line CID 1, etc. File size is determined by
44 size of the character collection. Only one file is
45 allowed per character collection; the last speci-
46 fied file is used. There are no built-in cidToUni-
47 code mappings.
49 unicodeToUnicode font-name-substring map-file
50 This is used to work around PDF fonts which have
51 incorrect Unicode information. It specifies a file
52 which maps from the given (incorrect) Unicode
53 indexes to the correct ones. The mapping will be
54 used for any font whose name contains
55 font-name-substring. Each line of a unicodeToUni-
56 code file represents one Unicode character:
58 in-hex out-hex1 out-hex2 ...
60 The in-hex field is an input (incorrect) Unicode
61 index, and the rest of the fields are one or more
62 output (correct) Unicode indexes. Each occurrence
63 of in-hex will be converted to the specified output
64 sequence.
66 unicodeMap encoding-name map-file
67 Specifies the file with mapping from Unicode to
68 encoding-name. These encodings are used for X dis-
69 play fonts and text output (see below). Each line
70 of a unicodeMap file represents a range of one or
71 more Unicode characters which maps linearly to a
72 range in the output encoding:
74 in-start-hex in-end-hex out-start-hex
76 Entries for single characters can be abbreviated
77 to:
79 in-hex out-hex
81 The in-start-hex and in-end-hex fields (or the sin-
82 gle in-hex field) specify the Unicode range. The
83 out-start-hex field (or the out-hex field) speci-
84 fies the start of the output encoding range. The
85 length of the out-start-hex (or out-hex) string
86 determines the length of the output characters
87 (e.g., UTF-8 uses different numbers of bytes to
88 represent characters in different ranges). Entries
89 must be given in increasing Unicode order. Only
90 one file is allowed per encoding; the last speci-
91 fied file is used. The Latin1, ASCII7, Symbol,
92 ZapfDingbats, UTF-8, and UCS-2 encodings are prede-
93 fined.
95 cMapDir registry-ordering dir
96 Specifies a search directory, dir, for CMaps for
97 the registry-ordering character collection. There
98 can be multiple directories for a particular col-
99 lection. There are no default CMap directories.
101 toUnicodeDir dir
102 Specifies a search directory, dir, for ToUnicode
103 CMaps. There can be multiple ToUnicode directo-
104 ries. There are no default ToUnicode directories.
106 ()
108 2 ISPLAY_FONT
110 displayFontT1 PDF-font-name T1-file
111 Maps a PDF font, PDF-font-name, to a Type 1 font
112 for display. The Type 1 font file, T1-file, should
113 be a standard .pfa or .pfb file.
115 displayFontTT PDF-font-name TT-file
116 Maps a PDF font, PDF-font-name, to a TrueType font
117 for display. The TrueType font file, TT-file,
118 should be a standard .ttf file.
120 displayNamedCIDFontT1 PDF-font-name T1-file
121 Maps a specific PDF CID (16-bit) font,
122 PDF-font-name, to a CID font (16-bit PostScript
123 font), for display. There are no default CID font
124 mappings.
126 displayCIDFontT1 registry-ordering T1-file
127 Maps the registry-ordering character collection to
128 a CID font (16-bit PostScript font), for display.
129 This mapping is used if the font name doesn't match
130 any of the fonts declared with displayNamedCIDFont*
131 commands. There are no default CID font mappings.
133 displayNamedCIDFontTT PDF-font-name TT-file
134 Maps a specific PDF CID (16-bit) font,
135 PDF-font-name, to a (16-bit) TrueType font, for
136 display. There are no default CID font mappings.
138 displayCIDFontTT registry-ordering TT-file
139 Maps the registry-ordering character collection to
140 a (16-bit) TrueType font, for display. This map-
141 ping is used if the font name doesn't match any of
142 the fonts declared with displayNamedCIDFont* com-
143 mands. There are no default CID font mappings.
145 fontDir dir
146 Specifies a search directory for external font
147 files. There can be multiple fontDir directories.
148 If a PDF file uses a font but doesn't embed it,
149 these directories will be searched for a matching
150 font file. These fonts are used by both xpdf (for
151 display) and pdftops (for embedding in the gener-
152 ated PostScript). Type 1 fonts must have a suffix
153 of ".pfa", ".pfb", ".ps", or no suffix at all.
154 TrueType fonts must have a ".ttf" suffix. Other
155 files in these directories will be ignored. There
156 are no default fontDir directories.
158 ()
160 2 OSTSCRIPT_CONTRO
162 psPaperSize width(pts) height(pts)
163 Sets the paper size for PostScript output. The
164 width and height parameters give the paper size in
165 PostScript points (1 point = 1/72 inch).
167 psPaperSize letter | legal | A4 | A3 | match
168 Sets the paper size for PostScript output to a
169 standard size. The default paper size is set when
170 xpdf and pdftops are built, typically to "letter"
171 or "A4". This can also be set to "match", which
172 will set the paper size to match the size specified
173 in the PDF file.
175 psImageableArea llx lly urx ury
176 Sets the imageable area for PostScript output. The
177 four integers are the coordinates of the lower-left
178 and upper-right corners of the imageable region,
179 specified in points (with the origin being the
180 lower-left corner of the paper). This defaults to
181 the full paper size; the psPaperSize option will
182 reset the imageable area coordinates.
184 psCrop yes | no
185 If set to "yes", PostScript output is cropped to
186 the CropBox specified in the PDF file; otherwise no
187 cropping is done. This defaults to "yes".
189 psExpandSmaller yes | no
190 If set to "yes", PDF pages smaller than the
191 PostScript imageable area are expanded to fill the
192 imageable area. Otherwise, no scalling is done on
193 smaller pages. This defaults to "no".
195 psShrinkLarger yes | no
196 If set to yes, PDF pages larger than the PostScript
197 imageable area are shrunk to fit the imageable
198 area. Otherwise, no scaling is done on larger
199 pages. This defaults to "yes".
201 psCenter yes | no
202 If set to yes, PDF pages smaller than the
203 PostScript imageable area (after any scaling) are
204 centered in the imageable area. Otherwise, they
205 are aligned at the lower-left corner of the image-
206 able area. This defaults to "yes".
208 psDuplex yes | no
209 If set to "yes", the generated PostScript will set
210 the "Duplex" pagedevice entry. This tells duplex-
211 capable printers to enable duplexing. This
212 defaults to "no".
214 psLevel level1 | level1sep | level2 | level2sep | level3 |
215 level3Sep
216 Sets the PostScript level to generate. This
217 defaults to "level2".
219 psFont PDF-font-name PS-font-name
220 When the PDF-font-name font is used in a PDF file,
221 it will be translated to the PostScript font
222 PS-font-name, which is assumed to be resident in
223 the printer. Typically, PDF-font-name and
224 PS-font-name are the same. By default, only the
225 Base-14 fonts are assumed to be resident.
227 psNamedFont16 PDF-font-name wMode PS-font-name encoding
228 When the 16-bit font PDF-font-name is used in a PDF
229 file with the wMode writing mode and is not embed-
230 ded, the PS-font-name font is substituted for it.
231 The writing mode must be either 'H' for horizontal
232 or 'V' for vertical. The PS-font-name font is
233 assumed to be resident in the printer and to use
234 the specified encoding (which must have been
235 defined with the unicodeMap command).
237 psFont16 registry-ordering wMode PS-font-name encoding
238 When a 16-bit font using the registry-ordering
239 character collection and wMode writing mode is not
240 embedded and does not match any of the fonts
241 declared in psNamedFont16 commands, the
242 PS-font-name font is substituted for it. The writ-
243 ing mode must be either 'H' for horizontal or 'V'
244 for vertical. The PS-font-name font is assumed to
245 be resident in the printer and to use the specified
246 writing mode and encoding (which must have been
247 defined with the unicodeMap command).
249 psEmbedType1Fonts yes | no
250 If set to "no", prevents embedding of Type 1 fonts
251 in generated PostScript. This defaults to "yes".
253 psEmbedTrueTypeFonts yes | no
254 If set to "no", prevents embedding of TrueType
255 fonts in generated PostScript. This defaults to
256 "yes".
258 psEmbedCIDTrueTypeFonts yes | no
259 If set to "no", prevents embedding of CID TrueType
260 fonts in generated PostScript. For Level 3
261 PostScript, this generates a CID font, for lower
262 levels it generates a non-CID composite font.
264 psEmbedCIDPostScriptFonts yes | no
265 If set to "no", prevents embedding of CID
266 PostScript fonts in generated PostScript. For
267 Level 3 PostScript, this generates a CID font, for
268 lower levels it generates a non-CID composite font.
270 psPreload yes | no
271 If set to "yes", PDF forms are converted to PS pro-
272 cedures, and image data is preloaded. This uses
273 more memory in the PostScript interpreter, but gen-
274 erates significantly smaller PS files in situations
275 where, e.g., the same image is drawn on every page
276 of a long document. This defaults to "no".
278 psOPI yes | no
279 If set to "yes", generates PostScript OPI comments
280 for all images and forms which have OPI informa-
281 tion. This option is only available if the Xpdf
282 tools were compiled with OPI support. This
283 defaults to "no".
285 psASCIIHex yes | no
286 If set to "yes", the ASCIIHexEncode filter will be
287 used instead of ASCII85Encode for binary data.
288 This defaults to "no".
290 psFile file-or-command
291 Sets the default PostScript file or print command
292 for xpdf. Commands start with a '|' character;
293 anything else is a file. If the file name or com-
294 mand contains spaces it must be quoted. This
295 defaults to unset, which tells xpdf to generate a
296 name of the form <file>.ps for a PDF file
297 <file>.pdf.
299 fontDir dir
300 See the description above, in the DISPLAY FONTS
301 section.
303 ()
305 2 EXT_CONTRO
307 textEncoding encoding-name
308 Sets the encoding to use for text output. (This
309 can be overridden with the "-enc" switch on the
310 command line.) The encoding-name must be defined
311 with the unicodeMap command (see above). This
312 defaults to "Latin1".
314 textEOL unix | dos | mac
315 Sets the end-of-line convention to use for text
316 output. The options are:
318 unix = LF
319 dos = CR+LF
320 mac = CR
322 (This can be overridden with the "-eol" switch on
323 the command line.) The default value is based on
324 the OS where xpdf and pdftotext were built.
326 textPageBreaks yes | no
327 If set to "yes", text extraction will insert page
328 breaks (form feed characters) between pages. This
329 defaults to "yes".
331 textKeepTinyChars yes | no
332 If set to "yes", text extraction will keep all
333 characters. If set to "no", text extraction will
334 discard tiny (smaller than 3 point) characters
335 after the first 50000 per page, avoiding extremely
336 slow run times for PDF files that use special fonts
337 to do shading or cross-hatching. This defaults to
338 "no".
340 ()
342 2 ISCELLANEOUS_SETTING
344 initialZoom percentage | page | width
345 Sets the initial zoom factor. A number specifies a
346 zoom percentage, where 100 means 72 dpi. You may
347 also specify 'page', to fit the page to the window
348 size, or 'width', to fit the page width to the win-
349 dow width.
351 continuousView yes | no
352 If set to "yes", xpdf will start in continuous view
353 mode, i.e., with one vertical screoll bar for the
354 whole document. This defaults to "no".
356 enableT1lib yes | no
357 Enables or disables use of t1lib (a Type 1 font
358 rasterizer). This is only relevant if the Xpdf
359 tools were built with t1lib support.
360 ("enableT1lib" replaces the old "t1libControl"
361 option.) This option defaults to "yes".
363 enableFreeType yes | no
364 Enables or disables use of FreeType (a TrueType /
365 Type 1 font rasterizer). This is only relevant if
366 the Xpdf tools were built with FreeType support.
367 ("enableFreeType" replaces the old "freetypeCon-
368 trol" option.) This option defaults to "yes".
370 antialias yes | no
371 Enables or disables font anti-aliasing in the PDF
372 rasterizer. This option affects all font rasteriz-
373 ers. ("antialias" replaces the anti-aliasing con-
374 trol provided by the old "t1libControl" and
375 "freetypeControl" options.) This default to "yes".
377 vectorAntialias yes | no
378 Enables or disables anti-aliasing of vector graph-
379 ics in the PDF rasterizer. This defaults to "yes".
381 strokeAdjust yes | no
382 Enables or disables stroke adjustment. This
383 defaults to "yes".
385 screenType dispersed | clustered | stochasticClustered
386 Sets the halftone screen type, which will be used
387 when generating a monochrome (1-bit) bitmap. The
388 three options are dispersed-dot dithering, clus-
389 tered-dot dithering (with a round dot and 45-degree
390 screen angle), and stochastic clustered-dot dither-
391 ing. By default, "stochasticClustered" is used for
392 resolutions of 300 dpi and higher, and "dispersed"
393 is used for resolutions lower then 300 dpi.
395 screenSize integer
396 Sets the size of the (square) halftone screen
397 threshold matrix. By default, this is 4 for dis-
398 persed-dot dithering, 10 for clustered-dot dither-
399 ing, and 100 for stochastic clustered-dot dither-
400 ing.
402 screenDotRadius integer
403 Sets the halftone screen dot radius. This is only
404 used when screenType is set to stochasticClustered,
405 and it defaults to 2. In clustered-dot mode, the
406 dot radius is half of the screen size. Dispersed-
407 dot dithering doesn't have a dot radius.
409 screenGamma float
410 Sets the halftone screen gamma correction parame-
411 ter. Gamma values greater than 1 make the output
412 brighter; gamma values less than 1 make it darker.
413 The default value is 1.
415 screenBlackThreshold float
416 When halftoning, all values below this threshold
417 are forced to solid black. This parameter is a
418 floating point value between 0 (black) and 1
419 (white). The default value is 0.
421 screenWhiteThreshold float
422 When halftoning, all values above this threshold
423 are forced to solid white. This parameter is a
424 floating point value between 0 (black) and 1
425 (white). The default value is 1.
427 urlCommand command
428 Sets the command executed when you click on a URL
429 link. The string "%s" will be replaced with the
430 URL. (See the example below.) This has no default
431 value.
433 movieCommand command
434 Sets the command executed when you click on a movie
435 annotation. The string "%s" will be replaced with
436 the movie file name. This has no default value.
438 mapNumericCharNames yes | no
439 If set to "yes", the Xpdf tools will attempt to map
440 various numeric character names sometimes used in
441 font subsets. In some cases this leads to usable
442 text, and in other cases it leads to gibberish --
443 there is no way for Xpdf to tell. This defaults to
444 "yes".
446 mapUnknownCharNames yes | no
447 If set to "yes", and mapNumericCharNames is set to
448 "no", the Xpdf tools will apply a simple pass-
449 through mapping (Unicode index = character code)
450 for all unrecognized glyph names. In some cases,
451 this leads to usable text, and in other cases it
452 leads to gibberish -- there is no way for Xpdf to
453 tell. This defaults to "no".
455 bind modifiers-key context command ...
456 Add a key or mouse button binding. Modifiers can
457 be zero or more of:
459 shift-
460 ctrl-
461 alt-
463 Key can be a regular ASCII character, or any one
464 of:
466 space
467 tab
468 return
469 enter
470 backspace
471 insert
472 delete
473 home
474 end
475 pgup
476 pgdn
477 left / right / up / down (arrow keys)
478 f1 .. f35 (function keys)
479 mousePress1 .. mousePress7 (mouse buttons)
480 mouseRelease1 .. mouseRelease7 (mouse buttons)
482 Context is either "any" or a comma-separated combi-
483 nation of:
485 fullScreen / window (full screen mode on/off)
486 continuous / singlePage (continuous mode on/off)
487 overLink / offLink (mouse over link or not)
488 scrLockOn / scrLockOff (scroll lock on/off)
490 The context string can include only one of each
491 pair in the above list.
493 Command is an Xpdf command (see the COMMANDS sec-
494 tion of the xpdf(1) man page for details). Multi-
495 ple commands are separated by whitespace.
497 The bind command replaces any existing binding, but
498 only if it was defined for the exact same modi-
499 fiers, key, and context. All tokens (modifiers,
500 key, context, commands) are case-sensitive.
502 Example key bindings:
504 # bind ctrl-a in any context to the nextPage
505 # command
506 bind ctrl-a any nextPage
508 # bind uppercase B, when in continuous mode
509 # with scroll lock on, to the reload command
510 # followed by the prevPage command
511 bind B continuous,scrLockOn reload prevPage
513 See the xpdf(1) man page for more examples.
515 unbind modifiers-key context
516 Removes a key binding established with the bind
517 command. This is most useful to remove default key
518 bindings before establishing new ones (e.g., if the
519 default key binding is given for "any" context, and
520 you want to create new key bindings for multiple
521 contexts).
523 printCommands yes | no
524 If set to "yes", drawing commands are printed as
525 they're executed (useful for debugging). This
526 defaults to "no".
528 errQuiet yes | no
529 If set to "yes", this suppresses all error and
530 warning messages from all of the Xpdf tools. This
531 defaults to "no".
533 ()
535 2 EXAMPLES
537 The following is a sample xpdfrc file.
539 # from the Thai support package
540 nameToUnicode /usr/local/share/xpdf/Thai.nameToUnicode
542 # from the Japanese support package
543 cidToUnicode Adobe-Japan1 /usr/local/share/xpdf/Adobe-Japan1.cidToUnicode
544 unicodeMap JISX0208 /usr/local/share/xpdf/JISX0208.unicodeMap
545 cMapDir Adobe-Japan1 /usr/local/share/xpdf/cmap/Adobe-Japan1
547 # use the Base-14 Type 1 fonts from ghostscript
548 displayFontT1 Times-Roman /usr/local/share/ghostscript/fonts/n021003l.pfb
549 displayFontT1 Times-Italic /usr/local/share/ghostscript/fonts/n021023l.pfb
550 displayFontT1 Times-Bold /usr/local/share/ghostscript/fonts/n021004l.pfb
551 displayFontT1 Times-BoldItalic /usr/local/share/ghostscript/fonts/n021024l.pfb
552 displayFontT1 Helvetica /usr/local/share/ghostscript/fonts/n019003l.pfb
553 displayFontT1 Helvetica-Oblique /usr/local/share/ghostscript/fonts/n019023l.pfb
554 displayFontT1 Helvetica-Bold /usr/local/share/ghostscript/fonts/n019004l.pfb
555 displayFontT1 Helvetica-BoldOblique /usr/local/share/ghostscript/fonts/n019024l.pfb
556 displayFontT1 Courier /usr/local/share/ghostscript/fonts/n022003l.pfb
557 displayFontT1 Courier-Oblique /usr/local/share/ghostscript/fonts/n022023l.pfb
558 displayFontT1 Courier-Bold /usr/local/share/ghostscript/fonts/n022004l.pfb
559 displayFontT1 Courier-BoldOblique /usr/local/share/ghostscript/fonts/n022024l.pfb
560 displayFontT1 Symbol /usr/local/share/ghostscript/fonts/s050000l.pfb
561 displayFontT1 ZapfDingbats /usr/local/share/ghostscript/fonts/d050000l.pfb
563 # use the Bakoma Type 1 fonts
564 # (this assumes they happen to be installed in /usr/local/fonts/bakoma)
565 fontDir /usr/local/fonts/bakoma
567 # set some PostScript options
568 psPaperSize letter
569 psDuplex no
570 psLevel level2
571 psEmbedType1Fonts yes
572 psEmbedTrueTypeFonts yes
573 psFile "| lpr -Pprinter5"
575 # assume that the PostScript printer has the Univers and
576 # Univers-Bold fonts
577 psFont Univers Univers
578 psFont Univers-Bold Univers-Bold
580 # set the text output options
581 textEncoding UTF-8
582 textEOL unix
584 # misc options
585 t1libControl low
586 freetypeControl low
587 urlCommand "netscape -remote 'openURL(%s)'"
589 ()
591 2 FILES
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.
598 $HOME/.xpdfrc
599 This is the user's configuration file. If it
600 exists, it will be read in place of the system-wide
601 file.
603 ()
605 2 AUTHOR
607 The Xpdf software and documentation are copyright
608 1996-2007 Glyph & Cog, LLC.
610 ()
612 2 SEE_ALSO
614 xpdf(1), pdftops(1), pdftotext(1), pdfinfo(1),
615 pdftoppm(1), pdfimages(1)
616 http://www.foolabs.com/xpdf/
618 ()