INSTALL.txt

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