]>
Commit | Line | Data |
---|---|---|
745129be | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
1f6f3dbc MS |
2 | <html> |
3 | <!-- SECTION: Specifications --> | |
4 | <head> | |
5 | <title>CUPS Banner File Format</title> | |
6 | <meta name='keywords' content='job-sheets'> | |
178cb736 | 7 | <link rel='stylesheet' type='text/css' href='../cups-printable.css'> |
1f6f3dbc MS |
8 | </head> |
9 | <body> | |
10 | <!-- | |
eac3a0a0 | 11 | Banner file format specification for CUPS. |
1f6f3dbc | 12 | |
eac3a0a0 | 13 | Copyright 2008-2011 by Apple Inc. |
1f6f3dbc MS |
14 | |
15 | These coded instructions, statements, and computer programs are the | |
16 | property of Apple Inc. and are protected by Federal copyright | |
17 | law. Distribution and use rights are outlined in the file "LICENSE.txt" | |
18 | which should have been included with this file. If this file is | |
19 | file is missing or damaged, see the license at "http://www.cups.org/". | |
20 | --> | |
21 | ||
178cb736 MS |
22 | <H1 CLASS="title">CUPS Banner File Format</H1> |
23 | ||
1f6f3dbc MS |
24 | <h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2> |
25 | ||
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> | |
30 | ||
31 | <pre class='command'> | |
32 | #CUPS-BANNER | |
33 | ||
34 | # What to show on the cover page | |
35 | Show job-id job-name job-originating-user-name time-at-creation | |
36 | ||
37 | # The header and footer text | |
38 | Header Cover Page | |
39 | Footer Cover Page | |
40 | ||
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. | |
46 | ||
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 | |
50 | </pre> | |
51 | ||
52 | ||
53 | <h2 class='title'><a name='KEYWORDS'>Standard Keywords</a></h2> | |
54 | ||
55 | <h3><a name='Footer'>Footer</a></h3> | |
56 | ||
57 | <p class='summary'> | |
58 | Footer text for footer | |
59 | </p> | |
60 | ||
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> | |
63 | ||
64 | ||
65 | <h3><a name='Header'>Header</a></h3> | |
66 | ||
67 | <p class='summary'> | |
68 | Header text for Header | |
69 | </p> | |
70 | ||
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> | |
73 | ||
74 | ||
75 | <h3><a name='Image'>Image</a></h3> | |
76 | ||
77 | <p class='summary'> | |
78 | Image /path/to/image/filename<br> | |
79 | Image relative/path/in/DocumentRoot/filename | |
80 | </p> | |
81 | ||
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> | |
85 | ||
86 | ||
87 | <h3><a name='Notice'>Notice</a></h3> | |
88 | ||
89 | <p class='summary'> | |
90 | Notice Text to display below the job information.<br> | |
91 | Notice More text to display below the job information. | |
92 | </p> | |
93 | ||
94 | <p>The <code>Notice</code> key defines lines of text that are centered below | |
95 | the job information.</p> | |
96 | ||
97 | ||
98 | <h3><a name='Show'>Show</a></h3> | |
99 | ||
100 | <p class='summary'> | |
cda47a96 | 101 | Show <em>value value ... value</em> |
1f6f3dbc MS |
102 | </p> |
103 | ||
104 | <p>The <code>Show</code> key lists the job information that is shown. The | |
cda47a96 | 105 | following values are supported:</p> |
1f6f3dbc MS |
106 | |
107 | <ul> | |
108 | ||
109 | <li><code>imageable-area</code>: The imageable area of the current | |
110 | page size</li> | |
111 | ||
112 | <li><code>job-billing</code>: Billing information for the job</li> | |
113 | ||
114 | <li><code>job-id</code>: The job ID</li> | |
115 | ||
116 | <li><code>job-name</code>: The title of the job</li> | |
117 | ||
118 | <li><code>job-originating-host-name</code>: The computer that printed | |
119 | the job</li> | |
120 | ||
121 | <li><code>job-originating-user-name</code>: The user that printed the | |
122 | job</li> | |
123 | ||
124 | <li><code>job-uuid</code>: The job UUID</li> | |
125 | ||
126 | <li><code>options</code>: The options that were provided with the | |
127 | job</li> | |
128 | ||
cda47a96 MS |
129 | <li><code>paper-name</code>: The name of the paper size used</li> |
130 | ||
131 | <li><code>paper-size</code>: The dimensions of the paper size used.</li> | |
132 | ||
1f6f3dbc MS |
133 | <li><code>printer-driver-name</code>: The printer driver used</li> |
134 | ||
135 | <li><code>printer-driver-version</code>: The driver version</li> | |
136 | ||
137 | <li><code>printer-info</code>: The printer description</li> | |
138 | ||
139 | <li><code>printer-location</code>: The location of the printer</li> | |
140 | ||
141 | <li><code>printer-make-and-model</code>: The make and model strings | |
142 | reported by the printer driver</li> | |
143 | ||
144 | <li><code>printer-name</code>: The printer used</li> | |
145 | ||
146 | <li><code>time-at-creation</code>: When the job was submitted</li> | |
147 | ||
cda47a96 MS |
148 | <li><code>time-at-processing</code>: The current date and time</li> |
149 | ||
1f6f3dbc MS |
150 | </ul> |
151 | ||
152 | ||
153 | </body> | |
154 | </html> |