Documentation

[ Design | Developer | User | CUPS 1.1 | CUPS 1.2 ]

CUPS 1.3 User Documentation

• CUPS: Common UNIX Printing System [ HTML Errata ] - this book provides the definitive tutorial and reference for CUPS and was written by the primary developer of CUPS, Michael R. Sweet. You can order the CUPS book with a special companion CD-ROM from Easy Software Products.
• Overview of CUPS [ HTML ] - this whitepaper provides an overview of the CUPS software and architecture.
• CUPS License [ HTML ] - the CUPS software license agreement, a combination of the GNU GPL and GNU LGPL.
• Printing and Options [ HTML ] - how to print and use printer options.
• Managing Operation Policies [ HTML ] - this document describes the new Policy directive in CUPS 1.2 for fine-grained access control.
• Using Kerberos Authentication [ HTML ] - this document provides Kerberos configuration instructions and links to useful Kerberos information.
• Server Security [ HTML ] - discusses the known security issues when configuring CUPS as a server.
• Using Network Printers [ HTML ] - shows how to configure and use various network printers.
• What's New in CUPS 1.3 [ HTML ] - A list of the new features and changes in CUPS 1.3.
• Man Pages - these pages are available on your system by running the man(1) command:

  man accept man backend man cancel man classes.conf man client.conf man cups-config man cups-deviced man cups-driverd man cups-lpd

  man cups-polld man cups-snmp.conf man cupsaddsmb man cupsd man cupsd.conf man cupsenable man cupstestdsc man cupstestppd man filter

  man lp man lpadmin man lpc man lpinfo man lpmove man lpoptions man lppasswd man lpq man lpr

  man lprm man lpstat man mailto.conf man mime.convs man mime.types man printers.conf man subscriptions.conf

• Reference Pages - these pages are available on your system via the CUPS help pages:
  • access_log Reference
  • classes.conf Reference
  • client.conf Reference
  • cupsd.conf Reference
  • error_log Reference
  • mailto.conf Reference
  • page_log Reference
  • printers.conf Reference
  • snmp.conf Reference
  • subscriptions.conf Reference
• Frequently Asked Questions [ HTML ] - find answers to common questions.
• CUPS How-To by Kurt Pfeifle [ HTML ] - this document provides step-by-step instructions for common CUPS tasks.
• Release Notes [ HTML ] - the release notes page provides detailed change information for each CUPS release.

CUPS 1.3 Developer Documentation

• Array API [ HTML ] - This describes the array functions provided by the CUPS library.
• CUPS API [ HTML ] - This describes the convenience functions provided by the CUPS library.
• File and Directory APIs [ HTML ] - This describes the file and directory functions provided by the CUPS library.
• Filter and Backend APIs [ HTML ] - This describes the filter and backend functions provided by the CUPS library.
• HTTP and IPP APIs [ HTML ] - This describes the HTTP and IPP functions provided by the CUPS library.
• PPD API [ HTML ] - This describes the PPD functions provided by the CUPS library.
• Raster API [ HTML ] - This describes the raster functions provided by the CUPS Imaging library.
• Translating CUPS [ HTML ] - how to translate CUPS into other languages; also how to customize the web interface.
• Using CGI Programs [ HTML ] - This describes how to add CGI programs and scripts to the CUPS web interface.

CUPS 1.3 Design Documentation

• CUPS Developer Guide (formerly the Configuration Management Plan) [ HTML ] - this document describes the processes and coding standards used for the development and maintenance of the CUPS software. The software trouble report form is used as a core part of our processes.
• CUPS Command File Format [ HTML ] - This documents the CUPS command file format, which is used to provide basic printer maintenance functions such as self-test pages and head cleaning.
• CUPS Design Description [ HTML ] - This documents the overall design of the Common UNIX Printing System.
• CUPS Implementation of IPP [ HTML ] - This documents the CUPS extensions and implementation of the Internet Printing Protocol.
• CUPS PPD Extensions [ HTML ] - This documents the extensions CUPS uses to the basic Adobe PostScript Printer Description file format.
• CUPS Raster Format [ HTML ] - This documents the CUPS raster format as used by all CUPS-based raster printer drivers and RIP filters.
• CUPS Software Test Plan [ HTML ] - This describes the automated testing framework provided by the CUPS build system.
• RFCs: - the following IETF Request For Comment documents were used to develop CUPS:
  • RFC 1179: Line Printer Daemon Protocol
  • RFC 2046: Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types
  • RFC 2567: Design Goals for an Internet Printing Protocol
  • RFC 2568: Rationale for the Structure of the Model and Protocol for the Internet Printing Protocol
  • RFC 2569: Mapping between LPD and IPP Protocols
  • RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1
  • RFC 2617: An Extension to HTTP: Digest Access Authentication
  • RFC 2910: Internet Printing Protocol/1.1: Encoding and Transport
  • RFC 2911: Internet Printing Protocol/1.1: Model and Semantics
  • RFC 3196: Internet Printing Protocol/1.1: Implementor's Guide
  • RFC 3239: Internet Printing Protocol (IPP): Requirements for Job, Printer, and Device Administrative Operations
  • RFC 3380: Internet Printing Protocol (IPP): Job and Printer Set Operations
  • RFC 3381: Internet Printing Protocol (IPP): Job Progress Attributes
  • RFC 3382: Internet Printing Protocol (IPP): The 'collection' attribute syntax
  • RFC 3510: Internet Printing Protocol/1.1: IPP URL Scheme

CUPS 1.2 Documentation

• What's New in CUPS 1.2 [ HTML ] - A list of the new features and changes in CUPS 1.2.

CUPS 1.1 Documentation

• Software Administrators Manual, CUPS v1.1.22 [ HTML | PDF ] - the administrators manual describes how to compile, install, configure, and manage the CUPS software.
• Software Users Manual, CUPS v1.1.22 [ HTML | PDF ] - the users manual describes how to print files, control printer options, manage jobs, and configure common applications with CUPS.