INSTALL.txt

   1 INSTALL - CUPS v1.2b1 - 2006-03-03
   2 ----------------------------------
   3
   4 This file describes how to compile and install CUPS from source
   5 code. For more information on CUPS see the file called
   6 "README.txt".  A complete change log can be found in
   7 "CHANGES.txt".
   8
   9 **** IF YOU HAVE A NON-POSTSCRIPT PRINTER, YOU WILL ALSO    ****
  10 **** NEED TO INSTALL ESP GHOSTSCRIPT AFTER YOU INSTALL CUPS ****
  11
  12
  13 BEFORE YOU BEGIN
  14
  15     You'll need ANSI-compliant C and C++ compilers, plus a make
  16     program and Bourne shell.  The GNU compiler tools work well -
  17     we've tested the current CUPS code against several versions
  18     of GCC with excellent results.
  19
  20     The makefiles used by the project should work with all
  21     versions of make.  We've tested them with GNU make as well as
  22     the make programs shipped by Compaq, HP, SGI, and Sun.
  23     FreeBSD users should use GNU make (gmake).
  24
  25     Besides these tools you'll want the JPEG, PNG, TIFF, and ZLIB
  26     libraries for image support, the CDSA, GNU TLS, or OpenSSL
  27     libraries for encryption support, and the OpenLDAP and
  28     OpenSLP libraries for directory services support. CUPS will
  29     compile and run without these, however you'll miss out on
  30     many of the features provided by CUPS.
  31
  32     Also, please note that CUPS no longer includes the
  33     Ghostscript- based pstoraster filter.  You *must* download
  34     ESP Ghostscript separately from the CUPS web site if you want
  35     to print PostScript files to non-PostScript printers.
  36
  37
  38 COMPILING FROM SUBVERSION
  39
  40     The CUPS Subversion repository doesn't hold a copy of the
  41     pre-built configure script.  You'll need to run the GNU
  42     autoconf software (2.52 or higher) before compiling the
  43     software from Subversion:
  44
  45         autoconf -f
  46
  47
  48 CONFIGURATION
  49
  50     CUPS uses GNU autoconf, so you should find the usual
  51     "configure" script in the main CUPS source directory.  To
  52     configure CUPS for your system, type:
  53
  54         ./configure
  55
  56     The default installation will put the CUPS software in the
  57     "/etc", "/usr", and "/var" directories on your system, which
  58     will overwrite any existing printing commands on your system.
  59     Use the "--prefix" option to install the CUPS software in
  60     another location:
  61
  62         ./configure --prefix=/some/directory
  63
  64     To see a complete list of configuration options, use the
  65     --help option:
  66
  67         ./configure --help
  68
  69     If any of the dependent libraries are not installed in a
  70     system default location (typically "/usr/include" and
  71     "/usr/lib") you'll need to set the CFLAGS, CPPFLAGS,
  72     CXXFLAGS, DSOFLAGS, and LDFLAGS environment variables prior
  73     to running configure:
  74
  75         setenv CFLAGS "-I/some/directory"
  76         setenv CPPFLAGS "-I/some/directory"
  77         setenv CXXFLAGS "-I/some/directory"
  78         setenv DSOFLAGS "-L/some/directory"
  79         setenv LDFLAGS "-L/some/directory"
  80         ./configure ...
  81
  82     or:
  83
  84         CFLAGS="-I/some/directory" \
  85         CPPFLAGS="-I/some/directory" \
  86         CXXFLAGS="-I/some/directory" \
  87         DSOFLAGS="-L/some/directory" \
  88         LDFLAGS="-L/some/directory" \
  89         ./configure ...
  90
  91     Once you have configured things, just type:
  92
  93         make ENTER
  94
  95     or if you have FreeBSD, NetBSD, or OpenBSD type:
  96
  97         gmake ENTER
  98
  99     to build the software.
 100
 101
 102 INSTALLING THE SOFTWARE
 103
 104     Once you have built the software you need to install it.  The
 105     "install" target provides a quick way to install the software
 106     on your local system:
 107
 108         make install ENTER
 109
 110     or for FreeBSD, NetBSD, or OpenBSD:
 111
 112         gmake install ENTER
 113
 114     You can also build binary packages that can be installed on
 115     other machines using the RPM spec file
 116     ("packaging/cups.spec") or EPM list file
 117     ("packaging/cups.list").  The latter also supports building
 118     of binary RPMs, so it may be more convenient to use - we use
 119     EPM to build all of our binary distributions.
 120
 121     You can find the RPM software at:
 122
 123         http://www.rpm.org/
 124
 125     The EPM software is available at:
 126
 127         http://www.easysw.com/epm/
 128
 129
 130 CREATING BINARY DISTRIBUTIONS WITH EPM
 131
 132     The top level makefile supports generation of many types of binary
 133     distributions using EPM.  To build a binary distribution type:
 134
 135         make <format> ENTER
 136
 137     or
 138
 139         gmake <format> ENTER
 140
 141     for FreeBSD, NetBSD, and OpenBSD.  The <format> target is one of
 142     the following:
 143
 144         epm       - Builds a script + tarfile package
 145         aix       - Builds an AIX package
 146         bsd       - Builds a *BSD package
 147         deb       - Builds a Debian package
 148         depot     - Builds a HP-UX package (also swinstall)
 149         inst      - Builds an IRIX package (also tardist)
 150         osx       - Builds a MacOS X package
 151         pkg       - Builds a Solaris package
 152         rpm       - Builds a RPM package
 153         setld     - Build a Tru64 UNIX package
 154         slackware - Build a Slackware package
 155         swinstall - Build a HP-UX package (also depot)
 156         tardist   - Builds an IRIX package (also inst)
 157
 158
 159 REPORTING PROBLEMS
 160
 161     If you have problems, READ THE DOCUMENTATION FIRST!  If the
 162     documentation does not solve your problems, please post a
 163     message on the "cups.general" forum at:
 164
 165         http://www.cups.org/newsgroups.php
 166
 167     Include your operating system and version, compiler and
 168     version, and any errors or problems you've run into. The
 169     "config.log" file and the output from the configure script
 170     and make should also be sent, as it often helps to determine
 171     the cause of your problem.
 172
 173     If you are running a version of Linux, be sure to provide the
 174     Linux distribution you have, too.