summaryrefslogtreecommitdiff
path: root/Build/source/libs/xpdf/xpdf-src/doc/xpdfrc.5
diff options
context:
space:
mode:
authorAkira Kakuto <kakuto@fuk.kindai.ac.jp>2017-08-13 07:14:48 +0000
committerAkira Kakuto <kakuto@fuk.kindai.ac.jp>2017-08-13 07:14:48 +0000
commit4b4995cda35627e06c43e25ecbe07c1bc1859bb5 (patch)
tree143ed02a389bab62f44043a54cbc70f69e312e2f /Build/source/libs/xpdf/xpdf-src/doc/xpdfrc.5
parent00d00899c484b81967558f43c4fe4a896ffdf610 (diff)
xpdf 4.00
git-svn-id: svn://tug.org/texlive/trunk@45031 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Build/source/libs/xpdf/xpdf-src/doc/xpdfrc.5')
-rw-r--r--Build/source/libs/xpdf/xpdf-src/doc/xpdfrc.5409
1 files changed, 234 insertions, 175 deletions
diff --git a/Build/source/libs/xpdf/xpdf-src/doc/xpdfrc.5 b/Build/source/libs/xpdf/xpdf-src/doc/xpdfrc.5
index afb8d950795..8ae83f410a5 100644
--- a/Build/source/libs/xpdf/xpdf-src/doc/xpdfrc.5
+++ b/Build/source/libs/xpdf/xpdf-src/doc/xpdfrc.5
@@ -1,7 +1,7 @@
-.\" Copyright 2002-2014 Glyph & Cog, LLC
-.TH xpdfrc 5 "28 May 2014"
+.\" Copyright 2002-2017 Glyph & Cog, LLC
+.TH xpdfrc 5 "10 Aug 2017"
.SH NAME
-xpdfrc \- configuration file for Xpdf tools (version 3.04)
+xpdfrc \- configuration file for Xpdf tools (version 4.00)
.SH DESCRIPTION
All of the Xpdf tools read a single configuration file. If you have a
.I .xpdfrc
@@ -31,114 +31,6 @@ to inserting the contents of
directly into the parent config file in place of the
.I include
command. Config files can be nested arbitrarily deeply.
-.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 unicodeToUnicode " font\-name\-substring map\-file"
-This is used to work around PDF fonts which have incorrect Unicode
-information. It specifies a file which maps from the given
-(incorrect) Unicode indexes to the correct ones. The mapping will be
-used for any font whose name contains
-.IR font\-name\-substring .
-Each line of a unicodeToUnicode file represents one Unicode character:
-
-.RI " " in\-hex " " out\-hex1 " " out\-hex2 " ..."
-
-The
-.I in\-hex
-field is an input (incorrect) Unicode index, and the rest of the
-fields are one or more output (correct) Unicode indexes. Each
-occurrence of
-.I in\-hex
-will be converted to the specified output sequence.
-.TP
-.BI unicodeMap " encoding\-name map\-file"
-Specifies the file with mapping from Unicode to
-.IR encoding\-name .
-These encodings are used for 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 GENERAL FONT CONFIGURATION
.TP
.BI fontFile " PDF\-font\-name font\-file"
@@ -195,7 +87,7 @@ with writing mode
is used (without embedding) in a PDF file, it will be translated to
the PostScript font
.IR PS\-font\-name ,
-which is assumbed to be resident in the printer. The writing mode
+which is assumed to be resident in the printer. The writing mode
must be either \'H' for horizontal or \'V' for vertical. The resident
font is assumed to use the specified encoding (which must have been
defined with the unicodeMap command).
@@ -208,7 +100,7 @@ character collection and
writing mode is used (without embedding) in a PDF file, the PostScript
font,
.IR PS\-font\-name ,
-is substituted for it. The substituted font is assumbed to be
+is substituted for it. The substituted font is assumed to be
resident in the printer. The writing mode must be either \'H' for
horizontal or \'V' for vertical. The resident font is assumed to use
the specified encoding (which must have been defined with the
@@ -268,7 +160,7 @@ By default, this is "no", and the MediaBox is used as the page size.
.TP
.BR 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
+are expanded to fill the imageable area. Otherwise, no scaling is
done on smaller pages. This defaults to "no".
.TP
.BR psShrinkLarger " yes | no"
@@ -287,7 +179,7 @@ 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"
+.BR psLevel " level1 | level1sep | level2 | level2gray | level2sep | level3 | level3gray | level3Sep"
Sets the PostScript level to generate. This defaults to "level2".
.TP
.BR psPreload " yes | no"
@@ -341,6 +233,12 @@ size, in pixels. This defaults to 20000000 (20 million).
If set to "yes", all PostScript output will be rasterized. This
defaults to "no".
.TP
+.BR psNeverRasterize " yes | no"
+If set to "yes", PostScript output will never be rasterized. This
+will likely result in incorrect output for PDF files that use
+transparency. (If both psAlwaysRasterize and psNeverRasterize are set
+to "yes", the psAlwaysRasterize setting wins.) This defaults to "no".
+.TP
.BI 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
@@ -350,7 +248,7 @@ PDF file <file>.pdf.
.TP
.BI fontDir " dir"
See the description above, in the DISPLAY FONTS section.
-.SH TEXT CONTROL
+.SH TEXT CONTROL AND CHARACTER MAPPING
.TP
.BI textEncoding " encoding\-name"
Sets the encoding to use for text output. (This can be overridden
@@ -383,24 +281,138 @@ If set to "yes", text extraction will keep all characters. If set to
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".
-.SH MISCELLANEOUS SETTINGS
.TP
-.BR initialZoom " \fIpercentage\fR | 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.
+.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
-.BR 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".
+.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
-.BR enableFreeType " yes | no"
-Enables or disables use of FreeType (a TrueType / Type 1 font
-rasterizer). This is only relevant if the Xpdf tools were built with
-FreeType support. ("enableFreeType" replaces the old
-"freetypeControl" option.) This option defaults to "yes".
+.BI unicodeToUnicode " font\-name\-substring map\-file"
+This is used to work around PDF fonts which have incorrect Unicode
+information. It specifies a file which maps from the given
+(incorrect) Unicode indexes to the correct ones. The mapping will be
+used for any font whose name contains
+.IR font\-name\-substring .
+Each line of a unicodeToUnicode file represents one Unicode character:
+
+.RI " " in\-hex " " out\-hex1 " " out\-hex2 " ..."
+
+The
+.I in\-hex
+field is an input (incorrect) Unicode index, and the rest of the
+fields are one or more output (correct) Unicode indexes. Each
+occurrence of
+.I in\-hex
+will be converted to the specified output sequence.
+.TP
+.BI unicodeMap " encoding\-name map\-file"
+Specifies the file with mapping from Unicode to
+.IR encoding\-name .
+These encodings are used for 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.
+.TP
+.BI 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".
+.TP
+.BI 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".
+.TP
+.BI 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".
+.SH RASTERIZER SETTINGS
.TP
.BR enableFreeType " yes | no"
Enables or disables use of FreeType (a TrueType / Type 1 font
@@ -428,11 +440,15 @@ If this is "yes", bitmaps sent to the printer will be antialiased
this is "no", printed bitmaps will not be antialiased. This defaults
to "no".
.TP
-.BR 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".
+.BR strokeAdjust " yes | no | cad"
+Sets the stroke adjustment mode. If set to "no", no stroke adjustment
+will be done. If set to "yes", normal stroke adjustment will be done:
+horizontal and vertical lines will be moved by up to half a pixel to
+make them look cleaner when vector anti-aliasing is enabled. If set
+to "cad", a slightly different stroke adjustment algorithm will be
+used to ensure that lines of the same original width will always have
+the same adjusted width (at the expense of allowing gaps and overlaps
+between adjacent lines). This defaults to "yes".
.TP
.BR screenType " dispersed | clustered | stochasticClustered"
Sets the halftone screen type, which will be used when generating a
@@ -474,14 +490,75 @@ rasterizer only, not the PostScript converter (except when it uses
rasterization to handle transparency). The default value is 0 (no
minimum).
.TP
-.BI drawAnnotations " yes | no"
-If set to "no", annotations will not be drawn or printed. The default
-value is "yes".
+.BI enablePathSimplification " yes | no"
+If set to "yes", simplify paths by removing points where it won't make
+a significant difference to the shape. The default value is "no".
.TP
.BI overprintPreview " yes | no"
If set to "yes", generate overprint preview output, honoring the
OP/op/OPM settings in the PDF file. Ignored for non-CMYK output. The
default value is "no".
+.SH VIEWER SETTINGS
+These settings only apply to the Xpdf GUI PDF viewer.
+.TP
+.BR initialZoom " \fIpercentage\fR | 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.
+.TP
+.BI defaultFitZoom " percentage"
+If xpdf is started with fit-page or fit-width zoom and no window
+geometry, it will calculate a desired window size based on the PDF
+page size and this defaultFitZoom value. I.e., the window size will
+be chosen such that exactly one page will fit in the window at this
+zoom factor (which must be a percentage). The default value is
+based on the screen resolution.
+.TP
+.BI initialSidebarState " yes | no"
+If set to "yes", xpdf opens with the sidebar (tabs, outline, etc.)
+visible. If set to "no", xpdf opens with the sidebar collapsed. The
+default is "no".
+.TP
+.BI paperColor " color"
+Set the "paper color", i.e., the background of the page display. The
+color can be #RRGGBB (hexadecimal) or a named color. This option will
+not work well with PDF files that do things like filling in white
+behind the text.
+.TP
+.BI matteColor " color"
+Set the matte color, i.e., the color used for background outside the
+actual page area. The color can be #RRGGBB (hexadecimal) or a named
+color.
+.TP
+.BI fullScreenMatteColor " color"
+Set the matte color for full-screen mode. The color can be #RRGGBB
+(hexadecimal) or a named color.
+.TP
+.BI popupMenuCmd " title command ..."
+Add a command to the popup menu.
+.I Title
+is the text to be displayed in the menu.
+.I Command
+is an Xpdf command (see the COMMANDS section of the
+.BR xpdf (1)
+man page for details). Multiple commands are separated by whitespace.
+.TP
+.BI maxTileWidth " pixels"
+Set the maximum width of tiles to be used by xpdf when rasterizing
+pages. This defaults to 1500.
+.TP
+.BI maxTileHeight " pixels"
+Set the maximum height of tiles to be used by xpdf when rasterizing
+pages. This defaults to 1500.
+.TP
+.BI tileCacheSize " tiles"
+Set the maximum number of tiles to be cached by xpdf when rasterizing
+pages. This defaults to 10.
+.TP
+.BI workerThreads " numThreads"
+Set the number of worker threads to be used by xpdf when rasterizing
+pages. This defaults to 1.
.TP
.BI launchCommand " command"
Sets the command executed when you click on a "launch"-type link. The
@@ -492,45 +569,11 @@ 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).
.TP
-.BI 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.
-.TP
.BI 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.
.TP
-.BI 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".
-.TP
-.BI 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".
-.TP
-.BI 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".
-.TP
-.BI 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".
-.TP
.BI bind " modifiers-key context command ..."
Add a key or mouse button binding.
.I Modifiers
@@ -551,6 +594,7 @@ can be a regular ASCII character, or any one of:
return
enter
backspace
+ esc
insert
delete
home
@@ -561,6 +605,7 @@ can be a regular ASCII character, or any one of:
f1 .. f35 (function keys)
mousePress1 .. mousePress7 (mouse buttons)
mouseRelease1 .. mouseRelease7 (mouse buttons)
+ mouseClick1 .. mouseClick7 (mouse buttons)
.fi
.I Context
@@ -607,6 +652,20 @@ Removes a key binding established with the bind command. This is most
useful to remove default key bindings before establishing new ones
(e.g., if the default key binding is given for "any" context, and you
want to create new key bindings for multiple contexts).
+.SH MISCELLANEOUS SETTINGS
+.TP
+.BI drawAnnotations " yes | no"
+If set to "no", annotations will not be drawn or printed. The default
+value is "yes".
+.TP
+.BI drawFormFields " yes | no"
+If set to "no", form fields will not be drawn or printed. The default
+value is "yes".
+.TP
+.BI 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".
.TP
.BI printCommands " yes | no"
If set to "yes", drawing commands are printed as they're executed
@@ -680,7 +739,7 @@ Depending on build options, it may be placed elsewhere.
This is the user's configuration file. If it exists, it will be read
in place of the system-wide file.
.SH AUTHOR
-The Xpdf software and documentation are copyright 1996-2014 Glyph &
+The Xpdf software and documentation are copyright 1996-2017 Glyph &
Cog, LLC.
.SH "SEE ALSO"
.BR xpdf (1),
@@ -694,4 +753,4 @@ Cog, LLC.
.BR pdftopng (1),
.BR pdfimages (1)
.br
-.B http://www.foolabs.com/xpdf/
+.B http://www.xpdfreader.com/