<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- SECTION: Specifications --> <head> <title>CUPS Banner File Format</title> <meta name='keywords' content='job-sheets'> <link rel='stylesheet' type='text/css' href='../cups-printable.css'> </head> <body> <!-- Banner file format specification for CUPS. Copyright © 2008-2011 by Apple Inc. Licensed under Apache License v2.0. See the file "LICENSE" for more information. --> <H1 CLASS="title">CUPS Banner File Format</H1> <h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2> <p>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:</p> <pre class='command'> #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 </pre> <h2 class='title'><a name='KEYWORDS'>Standard Keywords</a></h2> <h3><a name='Footer'>Footer</a></h3> <p class='summary'> Footer text for footer </p> <p>The <code>Footer</code> key defines the text that is centered at the bottom of the page. Only one <code>Footer</code> key can be specified.</p> <h3><a name='Header'>Header</a></h3> <p class='summary'> Header text for Header </p> <p>The <code>Header</code> key defines the text that is centered at the top of the page. Only one <code>Header</code> key can be specified.</p> <h3><a name='Image'>Image</a></h3> <p class='summary'> Image /path/to/image/filename<br> Image relative/path/in/DocumentRoot/filename </p> <p>The <code>Image</code> 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.</p> <h3><a name='Notice'>Notice</a></h3> <p class='summary'> Notice Text to display below the job information.<br> Notice More text to display below the job information. </p> <p>The <code>Notice</code> key defines lines of text that are centered below the job information.</p> <h3><a name='Show'>Show</a></h3> <p class='summary'> Show <em>value value ... value</em> </p> <p>The <code>Show</code> key lists the job information that is shown. The following values are supported:</p> <ul> <li><code>imageable-area</code>: The imageable area of the current page size</li> <li><code>job-billing</code>: Billing information for the job</li> <li><code>job-id</code>: The job ID</li> <li><code>job-name</code>: The title of the job</li> <li><code>job-originating-host-name</code>: The computer that printed the job</li> <li><code>job-originating-user-name</code>: The user that printed the job</li> <li><code>job-uuid</code>: The job UUID</li> <li><code>options</code>: The options that were provided with the job</li> <li><code>paper-name</code>: The name of the paper size used</li> <li><code>paper-size</code>: The dimensions of the paper size used.</li> <li><code>printer-driver-name</code>: The printer driver used</li> <li><code>printer-driver-version</code>: The driver version</li> <li><code>printer-info</code>: The printer description</li> <li><code>printer-location</code>: The location of the printer</li> <li><code>printer-make-and-model</code>: The make and model strings reported by the printer driver</li> <li><code>printer-name</code>: The printer used</li> <li><code>time-at-creation</code>: When the job was submitted</li> <li><code>time-at-processing</code>: The current date and time</li> </ul> </body> </html>
| Name | Type | Size | Permission | Actions |
|---|---|---|---|---|
| accounting.html | File | 2.63 KB | 0644 |
|
| admin.html | File | 11.66 KB | 0644 |
|
| api-admin.html | File | 19.99 KB | 0644 |
|
| api-filter.html | File | 61.66 KB | 0644 |
|
| api-ppd.html | File | 92.21 KB | 0644 |
|
| api-raster.html | File | 59.02 KB | 0644 |
|
| cgi.html | File | 2.58 KB | 0644 |
|
| cupspm.html | File | 370.35 KB | 0644 |
|
| encryption.html | File | 4.21 KB | 0644 |
|
| firewalls.html | File | 3.94 KB | 0644 |
|
| glossary.html | File | 2.66 KB | 0644 |
|
| kerberos.html | File | 4.21 KB | 0644 |
|
| license.html | File | 11.78 KB | 0644 |
|
| man-backend.html | File | 9.35 KB | 0644 |
|
| man-cancel.html | File | 2.56 KB | 0644 |
|
| man-classes.conf.html | File | 1.15 KB | 0644 |
|
| man-client.conf.html | File | 6.91 KB | 0644 |
|
| man-cups-config.html | File | 3.3 KB | 0644 |
|
| man-cups-files.conf.html | File | 12.26 KB | 0644 |
|
| man-cups-lpd.html | File | 4.75 KB | 0644 |
|
| man-cups-snmp.html | File | 2.72 KB | 0644 |
|
| man-cups.html | File | 7.43 KB | 0644 |
|
| man-cupsaccept.html | File | 2.48 KB | 0644 |
|
| man-cupsd-helper.html | File | 2.59 KB | 0644 |
|
| man-cupsd-logs.html | File | 9.55 KB | 0644 |
|
| man-cupsd.conf.html | File | 37.78 KB | 0644 |
|
| man-cupsd.html | File | 3.22 KB | 0644 |
|
| man-cupsenable.html | File | 2.97 KB | 0644 |
|
| man-cupstestppd.html | File | 4.83 KB | 0644 |
|
| man-filter.html | File | 11.36 KB | 0644 |
|
| man-ippevepcl.html | File | 1.88 KB | 0644 |
|
| man-ippeveprinter.html | File | 9.88 KB | 0644 |
|
| man-ippfind.html | File | 9.72 KB | 0644 |
|
| man-ipptool.html | File | 7.53 KB | 0644 |
|
| man-ipptoolfile.html | File | 27.3 KB | 0644 |
|
| man-lp.html | File | 7.32 KB | 0644 |
|
| man-lpadmin.html | File | 10.04 KB | 0644 |
|
| man-lpc.html | File | 2.11 KB | 0644 |
|
| man-lpinfo.html | File | 3.66 KB | 0644 |
|
| man-lpmove.html | File | 1.91 KB | 0644 |
|
| man-lpoptions.html | File | 3.88 KB | 0644 |
|
| man-lpq.html | File | 1.97 KB | 0644 |
|
| man-lpr.html | File | 5.93 KB | 0644 |
|
| man-lprm.html | File | 2.08 KB | 0644 |
|
| man-lpstat.html | File | 4.55 KB | 0644 |
|
| man-mime.convs.html | File | 2.59 KB | 0644 |
|
| man-mime.types.html | File | 5.47 KB | 0644 |
|
| man-notifier.html | File | 1.35 KB | 0644 |
|
| man-ppdc.html | File | 3.5 KB | 0644 |
|
| man-ppdhtml.html | File | 1.83 KB | 0644 |
|
| man-ppdi.html | File | 1.99 KB | 0644 |
|
| man-ppdmerge.html | File | 1.75 KB | 0644 |
|
| man-ppdpo.html | File | 2.09 KB | 0644 |
|
| man-printers.conf.html | File | 1.18 KB | 0644 |
|
| man-subscriptions.conf.html | File | 1.22 KB | 0644 |
|
| network.html | File | 18.56 KB | 0644 |
|
| options.html | File | 16.42 KB | 0644 |
|
| overview.html | File | 3.4 KB | 0644 |
|
| policies.html | File | 21.25 KB | 0644 |
|
| postscript-driver.html | File | 23.26 KB | 0644 |
|
| ppd-compiler.html | File | 45.13 KB | 0644 |
|
| raster-driver.html | File | 20.32 KB | 0644 |
|
| ref-ppdcfile.html | File | 69.29 KB | 0644 |
|
| security.html | File | 4.44 KB | 0644 |
|
| sharing.html | File | 4.45 KB | 0644 |
|
| spec-banner.html | File | 4.05 KB | 0644 |
|
| spec-command.html | File | 6.08 KB | 0644 |
|
| spec-design.html | File | 13.05 KB | 0644 |
|
| spec-ipp.html | File | 65.4 KB | 0644 |
|
| spec-ppd.html | File | 90.33 KB | 0644 |
|
| spec-raster.html | File | 23.34 KB | 0644 |
|
| spec-stp.html | File | 3.79 KB | 0644 |
|
| translation.html | File | 24.29 KB | 0644 |
|