CUPS Banner File Format

Introduction

This specification describes the CUPS banner file format (application/vnd.cups-banner) which is used to generate print job cover pages and the CUPS test page. The format itself consists of a header followed by lines of UTF-8 text containing comments or keywords and values:

#CUPS-BANNER

# What to show on the cover page
Show job-id job-name job-originating-user-name time-at-creation

# The header and footer text
Header Cover Page
Footer Cover Page

# Arbitrary "notice" text
Notice All work and no play makes Johnny a dull boy.
Notice All work and no play makes Johnny a dull boy.
Notice All work and no play makes Johnny a dull boy.
Notice All work and no play makes Johnny a dull boy.

# Images to place below the rest
Image /usr/share/doc/cups/images/cups-icon.png
Image /usr/share/doc/cups/images/smiley.jpg

Standard Keywords

Footer

Footer text for footer

The Footer key defines the text that is centered at the bottom of the page. Only one Footer key can be specified.

Header

Header text for Header

The Header key defines the text that is centered at the top of the page. Only one Header key can be specified.

Image

Image /path/to/image/filename
Image relative/path/in/DocumentRoot/filename

The Image key defines images that are centered above the footer text. Multiple images are centered as a group from left to right. Images are scaled as needed to fit on the page with a nominal size of 1"/25cm.

Notice

Notice Text to display below the job information.
Notice More text to display below the job information.

The Notice key defines lines of text that are centered below the job information.

Show

Show value value ... value

The Show key lists the job information that is shown. The following values are supported:

• imageable-area: The imageable area of the current page size
• job-billing: Billing information for the job
• job-id: The job ID
• job-name: The title of the job
• job-originating-host-name: The computer that printed the job
• job-originating-user-name: The user that printed the job
• job-uuid: The job UUID
• options: The options that were provided with the job
• paper-name: The name of the paper size used
• paper-size: The dimensions of the paper size used.
• printer-driver-name: The printer driver used
• printer-driver-version: The driver version
• printer-info: The printer description
• printer-location: The location of the printer
• printer-make-and-model: The make and model strings reported by the printer driver
• printer-name: The printer used
• time-at-creation: When the job was submitted
• time-at-processing: The current date and time