Load cups into easysw/current.
[thirdparty/cups.git] / doc / help / spec-command.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 Command File Format</title>
6         <meta name='keywords' content='Programming, CUPS Command File Format'>
7         <link rel='stylesheet' type='text/css' href='../cups.css'>
8 </head>
9 <body>
10 <!--
11   "$Id$"
12
13   CUPS command file format specification for the Common UNIX Printing
14   System (CUPS).
15
16   Copyright 1997-2006 by Easy Software Products.
17
18   These coded instructions, statements, and computer programs are the
19   property of Easy Software Products and are protected by Federal
20   copyright law.  Distribution and use rights are outlined in the file
21   "LICENSE.txt" which should have been included with this file.  If this
22   file is missing or damaged please contact Easy Software Products
23   at:
24
25       Attn: CUPS Licensing Information
26       Easy Software Products
27       44141 Airport View Drive, Suite 204
28       Hollywood, Maryland 20636 USA
29
30       Voice: (301) 373-9600
31       EMail: cups-info@cups.org
32         WWW: http://www.cups.org
33 -->
34
35 <h2 class='title'><a name='INTRODUCTION'>Introduction</a></h2>
36
37 <p>This specification describes the CUPS command file format
38 (application/vnd.cups-command) which is used to send printer
39 maintenance commands to a printer in a device-independent way.
40 The current specification supports basic maintenance functions
41 such as head cleaning and self-test pages.</p>
42
43 <p>Printer drivers advertise support for the CUPS command file
44 format by providing a filter for the
45 <var>application/vnd.cups-command</var> file type. Applications
46 can determine if a printer supports printing of CUPS command
47 files by checking the <code>printer-type</code> attribute for the
48 <code>CUPS_PRINTER_COMMANDS</code> capability bit.</p>
49
50 <h2 class='title'><a name='SYNTAX'>File Syntax</a></h2>
51
52 <p>CUPS command files are ASCII text files.  The first line of a
53 CUPS command file MUST contain:</p>
54
55 <pre class='command'>
56 #CUPS-COMMAND
57 </pre>
58
59 <p>After that, each line is either a command or a comment.
60 Comments begin with the # character, e.g.:</p>
61
62 <pre class='command'>
63 # This is a comment
64 </pre>
65
66 <p>The printer commands are described below. Printer commands are
67 case-insensitive, so "PRINTSELFTESTPAGE", "printselftestpage",
68 and "PrintSelfTestPage" are equivalent. Commands that accept
69 arguments have their arguments on the same line separated by
70 whitespace.</p>
71
72 <h2 class='title'><a name='COMMANDS'>Commands</a></h2>
73
74 <h3>Clean</h3>
75
76 <p class='summary'>Clean colorname</p>
77
78 <p>Does a standard print head cleaning.  If a printer does not
79 support cleaning of individual colors or cartridges, then all
80 print heads are cleaned. Command filters MUST support the "all"
81 colorname. Other standard color names include "black", "color",
82 "photo", "cyan", "magenta", "yellow", "light-cyan",
83 "light-magenta", "light-black", "light-gray", and
84 "dark-gray".</p>
85
86 <p>Example:</p>
87
88 <pre class='command'>
89 #CUPS-COMMAND
90 Clean all
91 </pre>
92
93 <h3>PrintSelfTestPage</h3>
94
95 <p class='summary'>PrintSelfTestPage</p>
96
97 <p>Print a self-test page on the printer. Typically this page
98 shows if all jets on a print head are functioning properly.</p>
99
100 <p>Example:</p>
101
102 <pre class='command'>
103 #CUPS-COMMAND
104 PrintSelfTestPage
105 </pre>
106
107 </body>
108 </html>