1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
3 <!-- SECTION: Specifications -->
5 <title>CUPS Banner File Format
</title>
6 <meta name='keywords' content='job-sheets'
>
7 <link rel='stylesheet' type='text/css' href='../cups.css'
>
13 Banner file format specification for the Common UNIX Printing System (CUPS).
15 Copyright 2008 by Apple Inc.
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/".
24 <h2 class='title'
><a name='INTRODUCTION'
>Introduction
</a></h2>
26 <p>This specification describes the CUPS banner file format
27 (application/vnd.cups-banner) which is used to generate print job cover pages
28 and the CUPS test page. The format itself consists of a header followed by
29 lines of UTF-
8 text containing comments or keywords and values:
</p>
34 # What to show on the cover page
35 Show job-id job-name job-originating-user-name time-at-creation
37 # The header and footer text
41 # Arbitrary
"notice" text
42 Notice All work and no play makes Johnny a dull boy.
43 Notice All work and no play makes Johnny a dull boy.
44 Notice All work and no play makes Johnny a dull boy.
45 Notice All work and no play makes Johnny a dull boy.
47 # Images to place below the rest
48 Image /usr/share/doc/cups/images/cups-icon.png
49 Image /usr/share/doc/cups/images/smiley.jpg
53 <h2 class='title'
><a name='KEYWORDS'
>Standard Keywords
</a></h2>
55 <h3><a name='Footer'
>Footer
</a></h3>
58 Footer text for footer
61 <p>The
<code>Footer
</code> key defines the text that is centered at the bottom
62 of the page. Only one
<code>Footer
</code> key can be specified.
</p>
65 <h3><a name='Header'
>Header
</a></h3>
68 Header text for Header
71 <p>The
<code>Header
</code> key defines the text that is centered at the top
72 of the page. Only one
<code>Header
</code> key can be specified.
</p>
75 <h3><a name='Image'
>Image
</a></h3>
78 Image /path/to/image/filename
<br>
79 Image relative/path/in/DocumentRoot/filename
82 <p>The
<code>Image
</code> key defines images that are centered above the footer
83 text. Multiple images are centered as a group from left to right. Images are
84 scaled as needed to fit on the page with a nominal size of
1"/25cm.</p>
87 <h3><a name='Notice'>Notice</a></h3>
90 Notice Text to display below the job information.<br>
91 Notice More text to display below the job information.
94 <p>The <code>Notice</code> key defines lines of text that are centered below
95 the job information.</p>
98 <h3><a name='Show'>Show</a></h3>
101 Show <em>value value ... value</em>
104 <p>The <code>Show</code> key lists the job information that is shown. The
105 following values are supported:</p>
109 <li><code>imageable-area</code>: The imageable area of the current
112 <li><code>job-billing</code>: Billing information for the job</li>
114 <li><code>job-id</code>: The job ID</li>
116 <li><code>job-name</code>: The title of the job</li>
118 <li><code>job-originating-host-name</code>: The computer that printed
121 <li><code>job-originating-user-name</code>: The user that printed the
124 <li><code>job-uuid</code>: The job UUID</li>
126 <li><code>options</code>: The options that were provided with the
129 <li><code>paper-name</code>: The name of the paper size used</li>
131 <li><code>paper-size</code>: The dimensions of the paper size used.</li>
133 <li><code>printer-driver-name</code>: The printer driver used</li>
135 <li><code>printer-driver-version</code>: The driver version</li>
137 <li><code>printer-info</code>: The printer description</li>
139 <li><code>printer-location</code>: The location of the printer</li>
141 <li><code>printer-make-and-model</code>: The make and model strings
142 reported by the printer driver</li>
144 <li><code>printer-name</code>: The printer used</li>
146 <li><code>time-at-creation</code>: When the job was submitted</li>
148 <li><code>time-at-processing</code>: The current date and time</li>