1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<!-- SECTION: Specifications --> 4<head> 5 <title>CUPS Banner File Format</title> 6 <meta name='keywords' content='job-sheets'> 7 <link rel='stylesheet' type='text/css' href='/cups-printable.css'> 8</head> 9<body> 10<!-- 11 "$Id$" 12 13 Banner file format specification for CUPS. 14 15 Copyright 2008-2011 by Apple Inc. 16 17 These coded instructions, statements, and computer programs are the 18 property of Apple Inc. and are protected by Federal copyright 19 law. Distribution and use rights are outlined in the file "LICENSE.txt" 20 which should have been included with this file. If this file is 21 file is missing or damaged, see the license at "http://www.cups.org/". 22--> 23 24<H1 CLASS="title">CUPS Banner File Format</H1> 25 26<h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2> 27 28<p>This specification describes the CUPS banner file format 29(application/vnd.cups-banner) which is used to generate print job cover pages 30and the CUPS test page. The format itself consists of a header followed by 31lines of UTF-8 text containing comments or keywords and values:</p> 32 33<pre class='command'> 34#CUPS-BANNER 35 36# What to show on the cover page 37Show job-id job-name job-originating-user-name time-at-creation 38 39# The header and footer text 40Header Cover Page 41Footer Cover Page 42 43# Arbitrary "notice" text 44Notice All work and no play makes Johnny a dull boy. 45Notice All work and no play makes Johnny a dull boy. 46Notice All work and no play makes Johnny a dull boy. 47Notice All work and no play makes Johnny a dull boy. 48 49# Images to place below the rest 50Image /usr/share/doc/cups/images/cups-icon.png 51Image /usr/share/doc/cups/images/smiley.jpg 52</pre> 53 54 55<h2 class='title'><a name='KEYWORDS'>Standard Keywords</a></h2> 56 57<h3><a name='Footer'>Footer</a></h3> 58 59<p class='summary'> 60Footer text for footer 61</p> 62 63<p>The <code>Footer</code> key defines the text that is centered at the bottom 64of the page. Only one <code>Footer</code> key can be specified.</p> 65 66 67<h3><a name='Header'>Header</a></h3> 68 69<p class='summary'> 70Header text for Header 71</p> 72 73<p>The <code>Header</code> key defines the text that is centered at the top 74of the page. Only one <code>Header</code> key can be specified.</p> 75 76 77<h3><a name='Image'>Image</a></h3> 78 79<p class='summary'> 80Image /path/to/image/filename<br> 81Image relative/path/in/DocumentRoot/filename 82</p> 83 84<p>The <code>Image</code> key defines images that are centered above the footer 85text. Multiple images are centered as a group from left to right. Images are 86scaled as needed to fit on the page with a nominal size of 1"/25cm.</p> 87 88 89<h3><a name='Notice'>Notice</a></h3> 90 91<p class='summary'> 92Notice Text to display below the job information.<br> 93Notice More text to display below the job information. 94</p> 95 96<p>The <code>Notice</code> key defines lines of text that are centered below 97the job information.</p> 98 99 100<h3><a name='Show'>Show</a></h3> 101 102<p class='summary'> 103Show <em>value value ... value</em> 104</p> 105 106<p>The <code>Show</code> key lists the job information that is shown. The 107following values are supported:</p> 108 109<ul> 110 111 <li><code>imageable-area</code>: The imageable area of the current 112 page size</li> 113 114 <li><code>job-billing</code>: Billing information for the job</li> 115 116 <li><code>job-id</code>: The job ID</li> 117 118 <li><code>job-name</code>: The title of the job</li> 119 120 <li><code>job-originating-host-name</code>: The computer that printed 121 the job</li> 122 123 <li><code>job-originating-user-name</code>: The user that printed the 124 job</li> 125 126 <li><code>job-uuid</code>: The job UUID</li> 127 128 <li><code>options</code>: The options that were provided with the 129 job</li> 130 131 <li><code>paper-name</code>: The name of the paper size used</li> 132 133 <li><code>paper-size</code>: The dimensions of the paper size used.</li> 134 135 <li><code>printer-driver-name</code>: The printer driver used</li> 136 137 <li><code>printer-driver-version</code>: The driver version</li> 138 139 <li><code>printer-info</code>: The printer description</li> 140 141 <li><code>printer-location</code>: The location of the printer</li> 142 143 <li><code>printer-make-and-model</code>: The make and model strings 144 reported by the printer driver</li> 145 146 <li><code>printer-name</code>: The printer used</li> 147 148 <li><code>time-at-creation</code>: When the job was submitted</li> 149 150 <li><code>time-at-processing</code>: The current date and time</li> 151 152</ul> 153 154 155</body> 156</html> 157