"Fossies" - the Fresh Open Source Software Archive

Member "xpdf-4.04/INSTALL" (18 Apr 2022, 5614 Bytes) of package /linux/misc/xpdf-4.04.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 Xpdf
    2 ====
    3 
    4 version 4.04
    5 2022-apr-18
    6 
    7 The Xpdf software and documentation are
    8 copyright 1996-2022 Glyph & Cog, LLC.
    9 
   10 Email: xpdf@xpdfreader.com
   11 WWW: http://www.xpdfreader.com/
   12 
   13 
   14 Compiling xpdf
   15 --------------
   16 
   17 Xpdf is written in C++ (with a little bit of C).  It should work with
   18 any ANSI-compliant C++ and C compilers.  The systems and compilers
   19 it's been tested with are listed on the xpdf web page.
   20 
   21 Xpdf requires the Qt toolkit.  The non-GUI command line tools do not
   22 use Qt.
   23 
   24 The following notes give specific instructions for compiling on
   25 different systems.
   26 
   27 
   28 *********************
   29 ***  Linux, OS X  ***
   30 *********************
   31 
   32 * Make sure you have the following installed:
   33 
   34     - CMake 2.8.8 or newer
   35     - FreeType 2.0.5 or newer
   36     - Qt 5.x or 6.x (for xpdf only)
   37     - libpng (for pdftoppm and pdftohtml)
   38     - zlib (for pdftoppm and pdftohtml)
   39 
   40   If Qt isn't found, the GUI viewer (xpdf) won't be built, but the
   41   command line tools will still be built.
   42 
   43 * Create a build directory.  These instructions assume that you create
   44   a directory called "build" under the top-level xpdf source
   45   directory, but the build directory can be anywhere you like.  Create
   46   the directory and cd into it:
   47 
   48       cd ..../xpdf-X.YY
   49       mkdir build
   50       cd build
   51 
   52 * Run cmake:
   53 
   54       cmake -DCMAKE_BUILD_TYPE=Release {other options - see below} ..
   55 
   56   If your build directory isn't under the source, use the full path to
   57   the source directory:
   58 
   59       cmake -DCMAKE_BUILD_TYPE=Release {other options} ..../xpdf-X.YY
   60 
   61 * If cmake doesn't find FreeType, you can set FREETYPE_DIR to point to
   62   the FreeType install directory.  Add this to the cmake command line:
   63 
   64       -DFREETYPE_DIR=/opt/freetype
   65 
   66   Cmake will look for ${FREETYPE_DIR}/include.
   67 
   68   You can also set the FreeType library location with:
   69 
   70       -DFREETYPE_LIBRARY=/opt/freetype/lib/libfreetype.so
   71 
   72 * If cmake doesn't find Qt, make sure qmake is on your executable
   73   search path.
   74 
   75 * To change the xpdf install directory, use:
   76 
   77       -DCMAKE_INSTALL_PREFIX=/opt/xpdf
   78 
   79   If you're familiar with autoconf, this is similar to the "--prefix"
   80   option.
   81 
   82 * Other configuration options are:
   83 
   84     -DSPLASH_CMYK=ON
   85         Enable CMYK rasterization support.
   86 
   87     -DA4_PAPER=ON
   88         Switches the default paper size for PostScript output (xpdf
   89         and pdftops) to A4.  The default is Letter size.
   90 
   91     -DNO_TEXT_SELECT=ON
   92         With this option, xpdf will not copy text.  (This is only
   93         useful on closed systems where the user can't get at the PDF
   94         file directly.)
   95 
   96     -DOPI_SUPPORT=ON
   97         Enables support for generation of OPI (Open Prepress
   98         Interface) comments with pdftops.
   99 
  100     -DNO_FONTCONFIG=ON
  101         Disables use of libfontconfig, which is used to locate system
  102         fonts on Linux/Unix systems.  The default is to search for the
  103         library, and to use it if found.
  104 
  105     -DMULTITHREADED=0
  106         Disables multithreading, which also disables building the GUI
  107         viewer (xpdf).  This does not affect the command line tools.
  108         Disabling multithreading should only be necessary if you're
  109         building with a compiler other than gcc, clang, or Microsoft
  110         Visual Studio.
  111 
  112     -DXPDFWIDGET_PRINTING=OFF
  113         Disable printing support.
  114 
  115     -DSYSTEM_XPDFRC="/etc/xpdfrc"
  116         Look for a system-wide xpdfrc config file in this directory.
  117 
  118     -DXPDFRC_DATADIR="/usr/share/xpdf"
  119         The ${DATADIR} variable in xpdfrc config files will expand to
  120         this string.
  121 
  122     -DCMAKE_DISABLE_FIND_PACKAGE_Qt4=1
  123     -DCMAKE_DISABLE_FIND_PACKAGE_Qt5Widgets=1
  124         Do not search for the Qt4/Qt5 libraries.  This will disable
  125         building the GUI viewer (xpdf).  Cmake will look for a "qmake"
  126         binary -- make sure the first qmake binary on your executable
  127         search path matches the desired version of Qt.
  128 
  129     -DCMAKE_C_FLAGS="..."
  130     -DCMAKE_CXX_FLAGS="..."
  131         Set additional options to pass to the C and/or C++ compilers.
  132 
  133     -DCMAKE_EXE_LINKER_FLAGS="..."
  134         Set additional options to pass to the linker.
  135 
  136     -DCMAKE_INSTALL_BINDIR
  137         Set the bin directory, relative to CMAKE_INSTALL_PREFIX
  138         (typically "bin").
  139 
  140     -DCMAKE_INSTALL_MANDIR
  141         Set the man directory, relative to CMAKE_INSTALL_PREFIX
  142         (typically "man" or "share/man").
  143 
  144 * Build:
  145 
  146       make
  147 
  148   This will build the executables in the build directory:
  149 
  150       xpdf/xpdf
  151       xpdf/pdftops
  152       xpdf/pdftotext
  153       xpdf/pdftohtml
  154       xpdf/pdfinfo
  155       xpdf/pdffonts
  156       xpdf/pdfdetach
  157       xpdf/pdftoppm
  158       xpdf/pdftopng
  159       xpdf/pdfimages
  160       xpdf-qt/xpdf
  161 
  162 * If desired, install the binaries and man pages:
  163 
  164       make install
  165 
  166 If you want to run a quick test, there is a tiny PDF file included
  167 with xpdf, as misc/hello.pdf .
  168 
  169 
  170 *****************
  171 ***  Windows  ***
  172 *****************
  173 
  174 The Windows build procedure is essentially the same as for Unix.  If
  175 building with cygwin, the procedure is identical to Unix.
  176 
  177 If building with Visual Studio:
  178 
  179 * Make sure you have CMake, FreeType, libpng, and zlib installed.
  180 
  181 * You'll need to set the FREETYPE_DIR variable to point to your
  182   FreeType installation, CMAKE_INCLUDE_PATH to point to your libpng
  183   includes, CMAKE_LIBRARY_PATH to point to your libpng library, and
  184   ZLIB_ROOT to point to your zlib installation.
  185 
  186       cmake -G "NMake Makefiles"
  187             -DCMAKE_BUILD_TYPE=Release
  188             -DFREETYPE_DIR="c:/software/freetype"
  189             -DCMAKE_INCLUDE_PATH="c:/software/libpng"
  190             -DCMAKE_LIBRARY_PATH="c:/software/libpng"
  191             -DZLIB_ROOT="c:/software/zlib"
  192             ..
  193 
  194 * Build:
  195 
  196       nmake