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-printable.css'
>
13 Banner file format specification for CUPS.
15 Copyright 2008-2011 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 <H1 CLASS=
"title">CUPS Banner File Format
</H1>
26 <h2 class='title'
><a name='INTRODUCTION'
>Introduction
</a></h2>
28 <p>This specification describes the CUPS banner file format
29 (application/vnd.cups-banner) which is used to generate print job cover pages
30 and the CUPS test page. The format itself consists of a header followed by
31 lines of UTF-
8 text containing comments or keywords and values:
</p>
36 # What to show on the cover page
37 Show job-id job-name job-originating-user-name time-at-creation
39 # The header and footer text
43 # Arbitrary
"notice" text
44 Notice All work and no play makes Johnny a dull boy.
45 Notice All work and no play makes Johnny a dull boy.
46 Notice All work and no play makes Johnny a dull boy.
47 Notice All work and no play makes Johnny a dull boy.
49 # Images to place below the rest
50 Image /usr/share/doc/cups/images/cups-icon.png
51 Image /usr/share/doc/cups/images/smiley.jpg
55 <h2 class='title'
><a name='KEYWORDS'
>Standard Keywords
</a></h2>
57 <h3><a name='Footer'
>Footer
</a></h3>
60 Footer text for footer
63 <p>The
<code>Footer
</code> key defines the text that is centered at the bottom
64 of the page. Only one
<code>Footer
</code> key can be specified.
</p>
67 <h3><a name='Header'
>Header
</a></h3>
70 Header text for Header
73 <p>The
<code>Header
</code> key defines the text that is centered at the top
74 of the page. Only one
<code>Header
</code> key can be specified.
</p>
77 <h3><a name='Image'
>Image
</a></h3>
80 Image /path/to/image/filename
<br>
81 Image relative/path/in/DocumentRoot/filename
84 <p>The
<code>Image
</code> key defines images that are centered above the footer
85 text. Multiple images are centered as a group from left to right. Images are
86 scaled as needed to fit on the page with a nominal size of
1"/25cm.</p>
89 <h3><a name='Notice'>Notice</a></h3>
92 Notice Text to display below the job information.<br>
93 Notice More text to display below the job information.
96 <p>The <code>Notice</code> key defines lines of text that are centered below
97 the job information.</p>
100 <h3><a name='Show'>Show</a></h3>
103 Show <em>value value ... value</em>
106 <p>The <code>Show</code> key lists the job information that is shown. The
107 following values are supported:</p>
111 <li><code>imageable-area</code>: The imageable area of the current
114 <li><code>job-billing</code>: Billing information for the job</li>
116 <li><code>job-id</code>: The job ID</li>
118 <li><code>job-name</code>: The title of the job</li>
120 <li><code>job-originating-host-name</code>: The computer that printed
123 <li><code>job-originating-user-name</code>: The user that printed the
126 <li><code>job-uuid</code>: The job UUID</li>
128 <li><code>options</code>: The options that were provided with the
131 <li><code>paper-name</code>: The name of the paper size used</li>
133 <li><code>paper-size</code>: The dimensions of the paper size used.</li>
135 <li><code>printer-driver-name</code>: The printer driver used</li>
137 <li><code>printer-driver-version</code>: The driver version</li>
139 <li><code>printer-info</code>: The printer description</li>
141 <li><code>printer-location</code>: The location of the printer</li>
143 <li><code>printer-make-and-model</code>: The make and model strings
144 reported by the printer driver</li>
146 <li><code>printer-name</code>: The printer used</li>
148 <li><code>time-at-creation</code>: When the job was submitted</li>
150 <li><code>time-at-processing</code>: The current date and time</li>