*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->Linux man pages -> xpdfrc (5)              
Title
Content
Arch
Section
 

xpdfrc(5)

Contents


NAME    [Toc]    [Back]

       xpdfrc - configuration file for Xpdf tools (version 1.00)

DESCRIPTION    [Toc]    [Back]

       All  of the Xpdf tools read a single configuration file.  If you have a
       .xpdfrc file in your home directory, it will  be  read.	 Otherwise,  a
       system-wide configuration file will be read from /usr/local/etc/xpdfrc,
       if it exists.  (This  is  its  default  location;  depending  on  build
       options,  it  may  be  placed elsewhere.)  On Win32 systems, the xpdfrc
       file should be placed in the same directory as the executables.

       The xpdfrc file consists of a series of configuration options, one  per
       line.   Blank  lines  and  lines  starting  with  a  '#' (comments) are
       ignored.

       The following sections list all of the  configuration  options,	sorted
       into functional groups.	There is an examples section at the end.

CHARACTER MAPPING    [Toc]    [Back]

       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:

		   hex-string name

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

       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:


		   hex-string

	      The  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.

       unicodeMap encoding-name map-file
	      Specifies  the  file with mapping from Unicode to encoding-name.
	      These encodings are used for X display  fonts  and  text	output
	      (see  below).  Each line of a unicodeMap file represents a range
	      of one or more Unicode characters which maps linearly to a range
	      in the output encoding:

		   in-start-hex in-end-hex out-start-hex

	      Entries for single characters can be abbreviated to:

		   in-hex out-hex

	      The  in-start-hex  and  in-end-hex  fields (or the single in-hex
	      field) specify the Unicode range.  The out-start-hex  field  (or
	      the  out-hex  field)  specifies the start of the output encoding
	      range.  The length of  the  out-start-hex  (or  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  Latin1, ASCII7, Symbol, ZapfDingbats, and UTF-8
	      encodings are predefined.

       cMapDir registry-ordering dir
	      Specifies a search  directory,  dir,  for  CMaps	for  the  reg-
	      istry-ordering  character  collection.   There  can  be multiple
	      directories for a particular collection.	There are  no  default
	      CMap directories.

       toUnicodeDir dir
	      Specifies  a  search directory, dir, for ToUnicode CMaps.  There
	      can be multiple ToUnicode directories.   There  are  no  default
	      ToUnicode directories.

DISPLAY FONTS    [Toc]    [Back]

       displayFontX PDF-font-name XLFD encoding-name
	      Maps a PDF font, PDF-font-name, to an X font, XLFD, for display.
	      The XLFD (X Logical Font Descriptor) should contain  the	string
	      "%s", which will be replaced by xpdf with the font size.	If the
	      XLFD contains spaces it must be quoted.  The encoding-name  must
	      be defined with the unicodeMap command (see above).  By default,
	      the Base-14 fonts are mapped to  standard  X  fonts,  using  the
	      Latin1, Symbol, and ZapfDingbats encodings.

       displayFontT1 PDF-font-name T1-file
	      Maps  a  PDF  font, PDF-font-name, to a Type 1 font for display.
	      The Type 1 font file, T1-file, should be a standard .pfa or .pfb
	      file.

       displayFontTT PDF-font-name TT-file
	      Maps  a PDF font, PDF-font-name, to a TrueType font for display.
	      The TrueType font file, TT-file, should be a standard .ttf file.

       displayCIDFontX registry-ordering XLFD encoding-name
	      Maps  the  registry-ordering character collection to the X font,
	      XLFD, for display.  The encoding given by encoding-name must  be
	      defined  with the unicodeMap command.  There are no default display
 CID font mappings.

       fontDir dir
	      Specifies a search directory for external font files.  There can
	      be  multiple fontDir directories.  If a PDF file uses a font but
	      doesn't embed it, these  directories  will  be  searched	for  a
	      matching font file.  These fonts are used by both xpdf (for display)
 and pdftops (for embedding in the  generated  PostScript).
	      Only  files  with  suffixes of ".pfa", ".pfb", or ".ttf" will be
	      used; other files in these directories will be  ignored.	 There
	      are no default fontDir directories.

POSTSCRIPT CONTROL    [Toc]    [Back]

       psPaperSize width(pts) height(pts)
	      Sets the paper size for PostScript output.  The width and height
	      parameters give the paper size in PostScript points.

       psPaperSize letter | legal | A4 | A3
	      Sets the paper size for PostScript output to  a  standard  size.
	      The  default  paper size is set when xpdf and pdftops are built,
	      typically to "letter" or "A4".

       psDuplex yes | no
	      If set to "yes", the generated PostScript will set the  "Duplex"
	      pagedevice  entry.  This tells duplex-capable printers to enable
	      duplexing.  This defaults to "no".

       psLevel level1 | level1sep | level2 | level2sep
	      Sets  the  PostScript  level  to	generate.   This  defaults  to
	      "level2".

       psFont PDF-font-name PS-font-name
	      When  the  PDF-font-name	font is used in a PDF file, it will be
	      translated to the PostScript font PS-font-name, which is assumed
	      to  be  resident	in  the printer.  Typically, PDF-font-name and
	      PS-font-name are the same.  By default, only the	Base-14  fonts
	      are assumed to be resident.

       psEmbedType1Fonts yes | no
	      If  set to "no", prevents embedding of Type 1 fonts in generated
	      PostScript.  This defaults to "yes".

       psEmbedTrueTypeFonts yes | no
	      If set to "no", prevents embedding of TrueType fonts  in	generated
 PostScript.	This defaults to "yes".

       psOPI yes | no
	      If  set  to  "yes",  generates  PostScript  OPI comments for all
	      images and forms which have OPI  information.   This  option  is
	      only available if the Xpdf tools were compiled with OPI support.
	      This defaults to "no".

       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 name or command contains spaces it must  be  quoted.
	      This  defaults  to unset, which tells xpdf to generate a name of
	      the form <file>.ps for a PDF file <file>.pdf.

       fontDir dir
	      See the description above, in the DISPLAY FONTS section.

TEXT CONTROL    [Toc]    [Back]

       textEncoding encoding-name
	      Sets the encoding to use for text output.  (This can be overridden
  with  the  "-enc"  switch on the command line.)  The encod-
	      ing-name must  be  defined  with	the  unicodeMap  command  (see
	      above).  This defaults to "Latin1".

       textEOL unix | dos | mac
	      Sets  the  end-of-line  convention  to use for text output.  The
	      options are:

		  unix = LF
		  dos  = CR+LF
		  mac  = CR

	      (This can be overridden with the "-eol" switch  on  the  command
	      line.)   The  default  value  is	based on the OS where xpdf and
	      pdftotext were built.

MISCELLANEOUS SETTINGS    [Toc]    [Back]

       t1libControl none | plain | low | high
	      Sets the type of font rendering for t1lib (the  Type  1  rasterizer)
  to  use.	Options  are  "none" (don't use t1lib at all),
	      "plain" (use non-anti-aliased fonts), "low" or "high" (use  lowlevel
  or  high-level  anti-aliased  fonts).   This  defaults to
	      "low".

       freetypeControl none | plain | low | high
	      Sets the type of font rendering for FreeType (the TrueType  rasterizer)
	to  use.   Options  are  "none" (don't use FreeType at
	      all), "plain" (use non-anti-aliased fonts), "low" or "high" (use
	      anti-aliased  fonts; these two are identical).  This defaults to
	      "low".

       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.

       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".

       errQuiet yes | no
	      If set to "yes", this suppresses all error and warning  messages
	      from all of the Xpdf tools.  This defaults to "no".

EXAMPLES    [Toc]    [Back]

       The following is a sample xpdfrc file.

       # from the Thai support package
       nameToUnicode /usr/local/share/xpdf/Thai.nameToUnicode

       # from the Japanese support package
       cidToUnicode Adobe-Japan1 /usr/local/share/xpdf/Adobe-Japan1.cidToUnicode
       unicodeMap   JISX0208	 /usr/local/share/xpdf/JISX0208.unicodeMap
       cMapDir	    Adobe-Japan1 /usr/local/share/xpdf/cmap/Adobe-Japan1

       # use an X server font for Times-Roman
       # (this is the built-in default)
       displayFontX Times-Roman "-*-times-medium-r-normal-*-%s-*-*-*-*-*-iso8859-1" Latin1

       # use the Base-14 Type 1 fonts from ghostscript
       # (note that this overrides the displayFontX command above)
       displayFontT1 Times-Roman	   /usr/local/share/ghostscript/fonts/n021003l.pfb
       displayFontT1 Times-Italic	   /usr/local/share/ghostscript/fonts/n021023l.pfb
       displayFontT1 Times-Bold 	   /usr/local/share/ghostscript/fonts/n021004l.pfb
       displayFontT1 Times-BoldItalic	   /usr/local/share/ghostscript/fonts/n021024l.pfb
       displayFontT1 Helvetica		   /usr/local/share/ghostscript/fonts/n019003l.pfb
       displayFontT1 Helvetica-Oblique	   /usr/local/share/ghostscript/fonts/n019023l.pfb
       displayFontT1 Helvetica-Bold	   /usr/local/share/ghostscript/fonts/n019004l.pfb
       displayFontT1 Helvetica-BoldOblique /usr/local/share/ghostscript/fonts/n019024l.pfb
       displayFontT1 Courier		   /usr/local/share/ghostscript/fonts/n022003l.pfb
       displayFontT1 Courier-Oblique	   /usr/local/share/ghostscript/fonts/n022023l.pfb
       displayFontT1 Courier-Bold	   /usr/local/share/ghostscript/fonts/n022004l.pfb
       displayFontT1 Courier-BoldOblique   /usr/local/share/ghostscript/fonts/n022024l.pfb
       displayFontT1 Symbol		   /usr/local/share/ghostscript/fonts/s050000l.pfb
       displayFontT1 ZapfDingbats	   /usr/local/share/ghostscript/fonts/d050000l.pfb

       # from the Japanese support package
       displayCIDFontX Adobe-Japan1 "-*-fixed-medium-r-normal-*-%s-*-*-*-*-*-jisx0208.1983-0" JISX0208

       # use the Bakoma Type 1 fonts
       # (this assumes they happen to be installed in /usr/local/fonts/bakoma)
       fontDir /usr/local/fonts/bakoma

       # set some PostScript options
       psPaperSize	    letter
       psDuplex 	    no
       psLevel		    level2
       psEmbedType1Fonts    yes
       psEmbedTrueTypeFonts yes
       psFile		    "| lpr -Pprinter5"

       # assume that the PostScript printer has the Univers and
       # Univers-Bold fonts
       psFont Univers	   Univers
       psFont Univers-Bold Univers-Bold

       # set the text output options
       textEncoding UTF-8
       textEOL	    unix

       # misc options
       t1libControl    low
       freetypeControl low
       urlCommand      "netscape -remove 'openURL(%s)'"

FILES    [Toc]    [Back]

       /usr/local/etc/xpdfrc
	      This  is	the default location for the system-wide configuration
	      file.  Depending on build options, it may be placed elsewhere.

       $HOME/.xpdfrc
	      This is the user's configuration file.  If it exists, it will be
	      read in place of the system-wide file.

AUTHOR    [Toc]    [Back]

       The  Xpdf  software  and documentation are copyright 1996-2002 Derek B.
       Noonburg (derekn@foolabs.com).

SEE ALSO    [Toc]    [Back]

      
      
       xpdf(1),  pdftops(1),  pdftotext(1),  pdfinfo(1),  pdftopbm(1),	pdfim-
       ages(1)
       http://www.foolabs.com/xpdf/



				  01 Feb 2002			     xpdfrc(5)
[ Back ]
 Similar pages
Name OS Title
usermgmt.conf OpenBSD user management tools configuration file
ximconf IRIX Configuration file of Input Manager of the X Window System Version 11 (xwnmo(1X))
peer_encaps_config IRIX SNMP version one subagent encapsulator configuration
versw Tru64 Manages the transition from the active version of the operating system to a new version
xfs_chver IRIX change the version of a filesystem to enable the extent unwritten version.
get HP-UX get a version of an SCCS file
get IRIX get a version of an SCCS file
dpkg-divert Linux override a package's version of a file
autoupdate2.13 Linux updates an old configure.in file to version 2
autoupdate Linux updates an old configure.in file to version 2
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service