Skip to content

Latest commit

 

History

History
110 lines (74 loc) · 3.83 KB

INSTALL.md

File metadata and controls

110 lines (74 loc) · 3.83 KB

Building and Installing the CUPS Library (libcups)

This file describes how to compile and install the CUPS library from source code. For more information on libcups see the file called README.md.

Before You Begin

You'll need a C99-compliant C compiler, POSIX make and shell programs, and the following libraries:

  • Avahi (0.8 or later) or mDNSResponder for mDNS/DNS-SD support
  • GNU TLS (3.0 or later), LibreSSL (3.0 or later), or OpenSSL (1.1 or later) for TLS support
  • LIBPNG (1.6 or later) for PNG image support (optional)
  • LIBPAM for authentication support in ippeveprinter (optional)
  • PDFio (1.6 or later) for PDF support (optional, also included with libcups)
  • ZLIB 1.2 or later for compression support

The GNU compiler tools and Bash work well and we have tested the current CUPS code against several versions of Clang and GCC with excellent results. The makefiles used by the project should work with POSIX-compliant versions of make. We've tested them with GNU make as well as several vendor make programs. BSD users should use GNU make (gmake) since BSD make is not POSIX-compliant and does not support the include directive.

On a stock Ubuntu install, the following command will install the required prerequisites:

sudo apt-get install autoconf build-essential libavahi-client-dev \
     libnss-mdns libpng-dev libssl-dev zlib1g-dev

Configuration

The CUPS library uses GNU autoconf, so you will find the usual "configure" script in the main source directory. To configure libcups for your system, type:

./configure

Note: Do not run autoheader, automake, or libtoolize. This will render your copy of the CUPS source unbuildable and you will need to start over.

The default installation will put the CUPS library under the /usr/local directory on your system. Use the --prefix option to install the CUPS library in another location:

./configure --prefix=/SOME/DIRECTORY

To see a complete list of configuration options, use the --help option:

./configure --help

The --enable-debug option compiles CUPS with debugging information and logging enabled. Debug logging is enabled using the CUPS_DEBUG_xxx environment variables at run-time - see "Enabling Debug Logging" below.

Once you have configured things, just type the following to build the software:

make

Enabling Debug Logging

When configured with the --enable-debug option, libcups includes additional debug logging support. The following environment variables are used to enable and control debug logging:

  • CUPS_DEBUG_FILTER: Specifies a POSIX regular expression to control which messages are logged.
  • CUPS_DEBUG_LEVEL: Specifies a number from 0 to 9 to control the verbosity of the logging. The default level is 1.
  • CUPS_DEBUG_LOG: Specifies a log file to use. Specify the name "-" to send the messages to stderr. Prefix a filename with "+" to append to an existing file. You can include a single "%d" in the filename to embed the current process ID.

Testing the Software

Aside from the built-in unit tests, libcups includes an automated test framework for the client/server support. Type the following to run the unit tests and test suite:

make test

Installing the Software

Note: Build the software before you try to install it.

Once you have built the software you need to install it. The "install" target provides a quick way to install the software on your local system:

sudo make install

Use the BUILDROOT variable to install to an alternate root directory:

make BUILDROOT=/some/other/root/directory install

Note: libcups also supports the GNU DSTROOT and Apple/Darwin DESTDIR variables to specify an alternate root directory.