Scope

Identification

System Overview

CUPS uses the Internet Printing Protocol (IETF-IPP) as the basis for managing print jobs and queues. The Line Printer Daemon (LPD, RFC1179), Server Message Block (SMB), and AppSocket protocols are also supported with reduced functionality.

CUPS adds network printer browsing and PostScript Printer Description ("PPD")-based printing options to support real world applications under UNIX.

CUPS also includes a customized version of GNU GhostScript (currently based off GNU GhostScript 4.03) and an image file RIP that can be used to support non-PostScript printers.

Document Overview

• 1 - Scope
• 2 - References
• 3 - File Management
• 4 - Trouble Report Processing
• 5 - Software Releases
• A - Glossary
• B - Coding Requirements

References

CUPS Documentation

• CUPS-CMP-1.0: CUPS Configuration Management Plan
• CUPS-IDD-1.0: CUPS System Interface Design Description
• CUPS-SAM-1.0.x: CUPS Software Administrators Manual
• CUPS-SDD-1.0: CUPS Software Design Description
• CUPS-SPM-1.0: CUPS Software Programming Manual
• CUPS-SSR-1.0: CUPS Software Security Report
• CUPS-STP-1.0: CUPS Software Test Plan
• CUPS-SUM-1.0.x: CUPS Software Users Manual
• CUPS-SVD-1.0.x: CUPS Software Version Description

Other Documents

• IEEE 1387.4, System Administration: Printing (draft)
• IPP/1.0: Additional Optional Operations - Set 1
• RFC 1179, Line Printer Daemon Protocol
• RFC 2565, IPP/1.0: Encoding and Transport
• RFC 2566, IPP/1.0: Model and Semantics
• RFC 2639, IPP/1.0: Implementers Guide

File Management

Directory Structure

Source Files

Configuration Management

Documentation on the CVS software is included with the whitepaper, "CVS II: Parallelizing Software Development".

Trouble Report Processing

1. STR is closed with complete resolution
2. STR is closed without resolution
3. STR is active
4. STR is pending (new STR or additional information available)

Classification

1. Request for enhancement
2. Documentation error
3. Unable to print a file
4. Unable to print to a printer
5. Unable to print at all

1. Specific to a machine
2. Specific to an operating system
3. Applies to all machines and operating systems

Identification

When the sub-system(s) involved have been identified, an engineer will then determine the change(s) needed and estimate the time required for the change(s).

Correction

Notification

Software Releases

Version Numbering

major.minor.patch
1.0.0

major.minor.patchbbuild
1.0.0b1

v1_0_0b1
v1_0_0

1.0.0b1    First beta release
1.0.0b2    Second beta release
1.0.0      First production release
1.0.1b1    First beta of 1.0.1
1.0.1      Production release of 1.0.1
1.1.0b1    First beta of 1.1.0
1.1.0      Production release of 1.1.0
2.0.0b1    First beta of 2.0.0
2.0.0      Production release of 2.0.0

Generation

Testing

Release

Glossary

Terms

C

A computer language.

parallel

Sending or receiving data more than 1 bit at a time.

pipe

A one-way communications channel between two programs.

serial

Sending or receiving data 1 bit at a time.

socket

A two-way network communications channel.

Acronyms

ASCII

American Standard Code for Information Interchange

CUPS

Common UNIX Printing System

ESC/P

EPSON Standard Code for Printers

FTP

File Transfer Protocol

HP-GL

Hewlett-Packard Graphics Language

HP-PCL

Hewlett-Packard Printer Control Language

HP-PJL

Hewlett-Packard Printer Job Language

IETF

Internet Engineering Task Force

IPP

Internet Printing Protocol

ISO

International Standards Organization

LPD

Line Printer Daemon

MIME

Multimedia Internet Mail Exchange

PCL

Page Control Language

PPD

PostScript Printer Description

SMB

Server Message Block

TFTP

Trivial File Transfer Protocol

Coding Requirements

Source Files

Naming

Documentation

/*
 * "$Id: cmp.shtml,v 1.4 1999/09/22 20:06:18 mike Exp $"
 *
 *   Description of file contents.
 *
 *   Copyright 1997-1999 by Easy Software Products, all rights
 *   reserved.
 *
 *   These coded instructions, statements, and computer programs are
 *   the property of Easy Software Products and are protected by
 *   Federal copyright law.  Distribution and use rights are outlined
 *   in the file "LICENSE.txt" which should have been included with
 *   this file.  If this file is missing or damaged please contact
 *   Easy Software Products at:
 *
 *       Attn: CUPS Licensing Information
 *       Easy Software Products
 *       44145 Airport View Drive, Suite 204
 *       Hollywood, Maryland 20636-3111 USA
 *
 *       Voice: (301) 373-9603
 *       EMail: cups-info@cups.org
 *         WWW: http://www.cups.org
 *
 * Contents:
 *
 *   function1() - Description 1.
 *   function2() - Description 2.
 *   function3() - Description 3.
 */

/*
 * End of "$Id: cmp.shtml,v 1.4 1999/09/22 20:06:18 mike Exp $".
 */

Functions

Naming

Functions with a local scope shall be declared "static" and be lowercase with underscores between words ("do_this", "do_that", "do_something_else", etc.)

Documentation

/*
 * 'do_this()' - Compute y = this(x).
 *
 * Notes: none.
 */

static float     /* O - Inverse power value, 0.0 <= y <= 1.0 */
do_this(float x) /* I - Power value (0.0 <= x <= 1.0) */
{
 ...
 return (y);
}

Methods

Naming

Documentation

/*
 * 'class::do_this()' - Compute y = this(x).
 *
 * Notes: none.
 */

float                   /* O - Inverse power value, 0.0 <= y <= 1.0 */
class::do_this(float x) /* I - Power value (0.0 <= x <= 1.0) */
{
 ...
 return (y);
}

Variables

Naming

Variables with a local scope shall be lowercase with underscores between words ("this_variable", "that_variable", etc.) Any local variables shared by functions within a source file shall be declared "static".

Documentation

int this_variable;   /* The current state of this */
int that_variable;   /* The current state of that */

Types

Naming

Documentation

/*
 * This type is for CUPS foobar options.
 */
typedef int cups_this_type_t;

Structures

Naming

Documentation

/*
 * This structure is for CUPS foobar options.
 */
struct cups_this_struct_str
{
  int this_member;   /* Current state for this */
  int that_member;   /* Current state for that */
};

Classes

Naming

Documentation

/*
 * This class is for CUPS foobar options.
 */
class cups_this_class
{
  int this_member;   /* Current state for this */
  int that_member;   /* Current state for that */
};

Constants

Naming

Typed enumerations shall be used whenever possible to allow for type checking by the compiler.

Documentation

enum
{
  CUPS_THIS_TRAY,   /* This tray */
  CUPS_THAT_TRAY    /* That tray */
};

Code

Documentation

/*
 * Clear the state array before we begin...
 */

for (i = 0; i < (sizeof(array) / sizeof(sizeof(array[0])); i ++)
  array[i] = STATE_IDLE;

/*
 * Wait for state changes...
 */

do
{
  for (i = 0; i < (sizeof(array) / sizeof(sizeof(array[0])); i ++)
    if (array[i] != STATE_IDLE)
      break;

  if (i == (sizeof(array) / sizeof(array[0])))
    sleep(1);
} while (i == (sizeof(array) / sizeof(array[0])));

Style

Indentation

{
  int i; /* Looping var */

 /*
  * Process foobar values from 0 to 999...
  */

  for (i = 0; i < 1000; i ++)
  {
    do_this(i);
    do_that(i);
  }
}

switch (array[i])
{
  case STATE_IDLE :
      do_this(i);
      do_that(i);
      break;
  default :
      do_nothing(i);
      break;
}

Spacing

Return Values

return (STATE_IDLE);

Loops

for (i = sizeof(array) / sizeof(array[0]) - 1; i >= 0; i --)
  array[i] = STATE_IDLE;

Software Trouble Report Form