doc/help/spec-banner.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/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.css'>
   8 </head>
   9 <body>
  10 <!--
  11   "$Id$"
  12
  13   Banner file format specification for the Common UNIX Printing System (CUPS).
  14
  15   Copyright 2008 by Apple Inc.
  16
  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/".
  22 -->
  23
  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'>
 101 Show <em>keyword keyword ... keyword</em>
 102 </p>
 103
 104 <p>The <code>Show</code> key lists the job information that is shown. The
 105 following keywords are supported:</p>
 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
 129         <li><code>printer-driver-name</code>: The printer driver used</li>
 130
 131         <li><code>printer-driver-version</code>: The driver version</li>
 132
 133         <li><code>printer-info</code>: The printer description</li>
 134
 135         <li><code>printer-location</code>: The location of the printer</li>
 136
 137         <li><code>printer-make-and-model</code>: The make and model strings
 138         reported by the printer driver</li>
 139
 140         <li><code>printer-name</code>: The printer used</li>
 141
 142         <li><code>time-at-creation</code>: When the job was submitted</li>
 143
 144 </ul>
 145
 146
 147 </body>
 148 </html>