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