INSTALL.txt

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