INSTALL.txt

   1 INSTALL - CUPS v1.2.0a1 - 01/07/2003
   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 OR A PATCHED VERSION ****
  11 **** OF THE STANDARD GHOSTSCRIPT RELEASES.                ****
  12
  13
  14 BEFORE YOU BEGIN
  15
  16 You'll need ANSI-compliant C and C++ compilers, plus a make
  17 program and Bourne shell.  The GNU compiler tools work well -
  18 we've tested the current CUPS code against GCC 2.95.x with
  19 excellent results.
  20
  21 The makefiles used by the project should work with all versions
  22 of make.  We've tested them with GNU make as well as the make
  23 programs shipped by Compaq, HP, SGI, and Sun.  FreeBSD users
  24 should use GNU make (gmake).
  25
  26 Besides these tools you'll want the following libraries:
  27
  28     - JPEG 6b or higher
  29     - PNG 1.0.6 or higher
  30     - TIFF 3.4 or higher
  31     - ZLIB 1.1.3 or higher
  32
  33 CUPS will compile and run without these, however you'll miss out on
  34 many of the features provided by CUPS.
  35
  36 Also, please note that CUPS no longer includes the Ghostscript-
  37 based pstoraster filter.  You *must* download Ghostscript
  38 separately and patch it using the files in the pstoraster
  39 subdirectory, or download the ESP Ghostscript distribution from
  40 the CUPS web site. For more information see the README file in
  41 the pstoraster subdirectory.
  42
  43
  44 COMPILING FROM CVS
  45
  46 The CUPS CVS repository doesn't hold a copy of the pre-built
  47 configure script.  You'll need to run the GNU autoconf software
  48 (2.52 or higher) before compiling the software from CVS:
  49
  50     autoconf ENTER
  51
  52
  53 CONFIGURATION
  54
  55 CUPS uses GNU autoconf, so you should find the usual "configure"
  56 script in the main CUPS source directory.  To configure CUPS for
  57 your system, type:
  58
  59     ./configure ENTER
  60
  61 The default installation will put the CUPS software in the
  62 "/etc", "/usr", and "/var" directories on your system, which
  63 will overwrite any existing printing commands on your system.
  64 Use the "--prefix" option to install the CUPS software in
  65 another location:
  66
  67     ./configure --prefix=/some/directory ENTER
  68
  69 If the PNG, JPEG, TIFF, and ZLIB libraries are not installed in
  70 a system default location (typically "/usr/include" and
  71 "/usr/lib") you'll need to set the CFLAGS, CXXFLAGS, DSOFLAGS,
  72 and LDFLAGS environment variables prior to running configure:
  73
  74     setenv CFLAGS "-I/some/directory" ENTER
  75     setenv CXXFLAGS "-I/some/directory" ENTER
  76     setenv DSOFLAGS "-L/some/directory" ENTER
  77     setenv LDFLAGS "-L/some/directory" ENTER
  78     ./configure ... ENTER
  79
  80 or:
  81
  82     CFLAGS="-I/some/directory"; export CFLAGS ENTER
  83     CXXFLAGS="-I/some/directory"; export CXXFLAGS ENTER
  84     DSOFLAGS="-L/some/directory"; export DSOFLAGS ENTER
  85     LDFLAGS="-L/some/directory"; export LDFLAGS ENTER
  86     ./configure ... ENTER
  87
  88 To enable support for encryption, you'll also want to add the
  89 "--enable-ssl" option:
  90
  91     ./configure --enable-ssl
  92
  93 SSL and TLS support require the OpenSSL library, available at:
  94
  95     http://www.openssl.org
  96
  97 If the OpenSSL header files and libraries are not in a standard
  98 location, specify the locations of these files using the
  99 --with-openssl-includes and --with-openssl-libs directives:
 100
 101     ./configure --enable-ssl \
 102         --with-openssl-includes=/foo/bar/include \
 103         --with-openssl-libs=/foo/bar/lib
 104
 105 See the file "ENCRYPTION.txt" for information on using the
 106 encryption support in CUPS.
 107
 108 Once you have configured things, just type:
 109
 110     make ENTER
 111
 112 or if you have FreeBSD, NetBSD, or OpenBSD type:
 113
 114     gmake ENTER
 115
 116 to build the software.
 117
 118
 119 INSTALLING THE SOFTWARE
 120
 121 Once you have built the software you need to install it.  The
 122 "install" target provides a quick way to install the software on
 123 your local system:
 124
 125     make install ENTER
 126
 127 or for FreeBSD, NetBSD, or OpenBSD:
 128
 129     gmake install ENTER
 130
 131 You can also build binary packages that can be installed on other
 132 machines using the RPM spec file ("cups.spec") or EPM list file
 133 ("cups.list").  The latter also supports building of binary RPMs,
 134 so it may be more convenient to use - we use EPM to build all of
 135 our binary distributions.
 136
 137 You can find the RPM software at:
 138
 139     http://www.rpm.org
 140
 141 The EPM software is at:
 142
 143     http://www.easysw.com/epm/
 144
 145
 146 CREATING BINARY DISTRIBUTIONS WITH EPM
 147
 148 The top level makefile supports generation of many types of binary
 149 distributions using EPM.  To build a binary distribution type:
 150
 151     make <format> ENTER
 152
 153 or
 154
 155     gmake <format> ENTER
 156
 157 for FreeBSD, NetBSD, and OpenBSD.  The <format> target is one of
 158 the following:
 159
 160     epm      - Builds a portable shell script and tar file based
 161                distribution.  This format will also backup your
 162                existing printing system if you decide to remove
 163                CUPS at some future time.
 164     aix      - Builds an AIX binary distribution.
 165     bsd      - Builds a *BSD binary distribution.
 166     deb      - Builds a Debian binary distribution.
 167     depot    - Builds a HP-UX binary distribution.
 168     pkg      - Builds a Solaris binary distribution.
 169     rpm      - Builds a RPM binary distribution.
 170     tardist  - Builds an IRIX binary distribution.
 171
 172
 173 REPORTING PROBLEMS
 174
 175 If you have problems, READ THE DOCUMENTATION FIRST!  If the
 176 documentation does not solve your problems please send an email
 177 to "cups-support@cups.org".  Include your operating system and
 178 version, compiler and version, and any errors or problems you've
 179 run into. The "/var/log/cups/error_log" file should also be sent,
 180 as it often helps to determine the cause of your problem.
 181
 182 If you are running a version of Linux, be sure to provide the
 183 Linux distribution you have, too.
 184
 185 Please note that the "cups-support@cups.org" email address goes
 186 to the CUPS developers; they are busy people, so your email may
 187 go unanswered for days or weeks.  In general, only general build
 188 or distribution problems will actually get answered - for
 189 end-user support see the "README.txt" for a summary of the
 190 resources available.