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 Banner file format specification for CUPS. 12 13 Copyright © 2020-2024 by OpenPrinting. 14 Copyright © 2008-2011 by Apple Inc. 15 16 Licensed under Apache License v2.0. See the file "LICENSE" for more 17 information. 18--> 19 20<H1 CLASS="title">CUPS Banner File Format</H1> 21 22<h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2> 23 24<p>This specification describes the CUPS banner file format 25(application/vnd.cups-banner) which is used to generate print job cover pages 26and the CUPS test page. The format itself consists of a header followed by 27lines of UTF-8 text containing comments or keywords and values:</p> 28 29<pre class='command'> 30#CUPS-BANNER 31 32# What to show on the cover page 33Show job-id job-name job-originating-user-name time-at-creation 34 35# The header and footer text 36Header Cover Page 37Footer Cover Page 38 39# Arbitrary "notice" text 40Notice All work and no play makes Johnny a dull boy. 41Notice All work and no play makes Johnny a dull boy. 42Notice All work and no play makes Johnny a dull boy. 43Notice All work and no play makes Johnny a dull boy. 44 45# Images to place below the rest 46Image /usr/local/share/company-logo.png 47Image /usr/share/doc/cups/images/smiley.jpg 48</pre> 49 50 51<h2 class='title'><a name='KEYWORDS'>Standard Keywords</a></h2> 52 53<h3><a name='Footer'>Footer</a></h3> 54 55<p class='summary'> 56Footer text for footer 57</p> 58 59<p>The <code>Footer</code> key defines the text that is centered at the bottom 60of the page. Only one <code>Footer</code> key can be specified.</p> 61 62 63<h3><a name='Header'>Header</a></h3> 64 65<p class='summary'> 66Header text for Header 67</p> 68 69<p>The <code>Header</code> key defines the text that is centered at the top 70of the page. Only one <code>Header</code> key can be specified.</p> 71 72 73<h3><a name='Image'>Image</a></h3> 74 75<p class='summary'> 76Image /path/to/image/filename<br> 77Image relative/path/in/DocumentRoot/filename 78</p> 79 80<p>The <code>Image</code> key defines images that are centered above the footer 81text. Multiple images are centered as a group from left to right. Images are 82scaled as needed to fit on the page with a nominal size of 1"/25cm.</p> 83 84 85<h3><a name='Notice'>Notice</a></h3> 86 87<p class='summary'> 88Notice Text to display below the job information.<br> 89Notice More text to display below the job information. 90</p> 91 92<p>The <code>Notice</code> key defines lines of text that are centered below 93the job information.</p> 94 95 96<h3><a name='Show'>Show</a></h3> 97 98<p class='summary'> 99Show <em>value value ... value</em> 100</p> 101 102<p>The <code>Show</code> key lists the job information that is shown. The 103following values are supported:</p> 104 105<ul> 106 107 <li><code>imageable-area</code>: The imageable area of the current 108 page size</li> 109 110 <li><code>job-billing</code>: Billing information for the job</li> 111 112 <li><code>job-id</code>: The job ID</li> 113 114 <li><code>job-name</code>: The title of the job</li> 115 116 <li><code>job-originating-host-name</code>: The computer that printed 117 the job</li> 118 119 <li><code>job-originating-user-name</code>: The user that printed the 120 job</li> 121 122 <li><code>job-uuid</code>: The job UUID</li> 123 124 <li><code>options</code>: The options that were provided with the 125 job</li> 126 127 <li><code>paper-name</code>: The name of the paper size used</li> 128 129 <li><code>paper-size</code>: The dimensions of the paper size used.</li> 130 131 <li><code>printer-driver-name</code>: The printer driver used</li> 132 133 <li><code>printer-driver-version</code>: The driver version</li> 134 135 <li><code>printer-info</code>: The printer description</li> 136 137 <li><code>printer-location</code>: The location of the printer</li> 138 139 <li><code>printer-make-and-model</code>: The make and model strings 140 reported by the printer driver</li> 141 142 <li><code>printer-name</code>: The printer used</li> 143 144 <li><code>time-at-creation</code>: When the job was submitted</li> 145 146 <li><code>time-at-processing</code>: The current date and time</li> 147 148</ul> 149 150 151</body> 152</html> 153
