doc/help/spec-banner.html

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