]>
Commit | Line | Data |
---|---|---|
ef416fc2 | 1 | <HTML> |
2 | <!-- SECTION: References --> | |
3 | <HEAD> | |
4 | <TITLE>printers.conf</TITLE> | |
178cb736 | 5 | <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css"> |
ef416fc2 | 6 | </HEAD> |
7 | <BODY> | |
8 | ||
178cb736 MS |
9 | <H1 CLASS="title">printers.conf</H1> |
10 | ||
ef416fc2 | 11 | <P>The CUPS scheduler (cupsd) uses the |
12 | <VAR>/etc/cups/printers.conf</VAR> file to store the list of | |
13 | available printers. This file contains only locally defined | |
14 | printers, not remote printers that are created automatically via | |
15 | browsing. Each directive is listed on a line by itself followed | |
16 | by its value. Comments are introduced using the number sign ("#") | |
17 | character at the beginning of a line.</P> | |
18 | ||
19 | <P>While the printer configuration file consists of plain text | |
20 | and can be modified using your favorite text editor, you should | |
480ef0fe | 21 | normally use the <A HREF="man-lpadmin.html">lpadmin(8)</A> |
22 | command, web interface, or any of the available GUIs to manage | |
23 | your printers instead. If you do choose to edit this file | |
b226ab99 MS |
24 | manually, you will need to stop the scheduler first, make your |
25 | changes, and then start the scheduler to make them active.</P> | |
ef416fc2 | 26 | |
27 | ||
480ef0fe | 28 | <H2 CLASS="title"><A NAME="Accepting">Accepting</A></H2> |
ef416fc2 | 29 | |
480ef0fe | 30 | <H3>Examples</H3> |
ef416fc2 | 31 | |
32 | <PRE CLASS="command"> | |
480ef0fe | 33 | <Printer name> |
34 | ... | |
35 | Accepting yes | |
36 | </Printer> | |
ef416fc2 | 37 | </PRE> |
38 | ||
480ef0fe | 39 | <H3>Description</H3> |
ef416fc2 | 40 | |
41 | <P>The <CODE>Accepting</CODE> directive defines the initial state | |
42 | of the <VAR>printer-is-accepting-jobs</VAR> attribute. This state | |
58dc1933 MS |
43 | is also set by the <CODE>cupsaccept(8)</CODE> and |
44 | <CODE>cupsreject(8)</CODE> commands:</P> | |
ef416fc2 | 45 | |
46 | <PRE CLASS="command"> | |
58dc1933 MS |
47 | <KBD>/usr/sbin/cupsaccept printername |
48 | /usr/sbin/cupsreject printername</KBD> | |
ef416fc2 | 49 | </PRE> |
50 | ||
51 | <P>This directive must appear inside a <A | |
52 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
53 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 54 | section.</P> |
ef416fc2 | 55 | |
56 | ||
480ef0fe | 57 | <H2 CLASS="title"><A NAME="AllowUser">AllowUser</A></H2> |
ef416fc2 | 58 | |
480ef0fe | 59 | <H3>Examples</H3> |
ef416fc2 | 60 | |
61 | <PRE CLASS="command"> | |
480ef0fe | 62 | <Printer name> |
63 | ... | |
64 | AllowUser foo_user | |
65 | AllowUser @bar_group | |
66 | </Printer> | |
ef416fc2 | 67 | </PRE> |
68 | ||
480ef0fe | 69 | <H3>Description</H3> |
ef416fc2 | 70 | |
71 | <P>The <CODE>AllowUser</CODE> directive adds a username or group | |
72 | name to the <VAR>requesting-user-name-allowed</VAR> attribute | |
73 | which can be set by the <CODE>lpadmin(8)</CODE> command:</P> | |
74 | ||
75 | <PRE CLASS="command"> | |
76 | <KBD>/usr/sbin/lpadmin -p printername -u allow:foo_user,@bar_group</KBD> | |
77 | </PRE> | |
78 | ||
79 | <P>This directive must appear inside a <A | |
80 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
81 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> directive. | |
82 | This directive cannot be used with <A | |
83 | HREF="#DenyUser"><CODE>DenyUser</CODE></A>.</P> | |
84 | ||
85 | ||
480ef0fe | 86 | <H2 CLASS="title"><A NAME="DefaultPrinter">DefaultPrinter</A></H2> |
ef416fc2 | 87 | |
480ef0fe | 88 | <H3>Examples</H3> |
ef416fc2 | 89 | |
90 | <PRE CLASS="command"> | |
91 | <DefaultPrinter name> | |
480ef0fe | 92 | ... |
ef416fc2 | 93 | </Printer> |
94 | </PRE> | |
95 | ||
480ef0fe | 96 | <H3>Description</H3> |
ef416fc2 | 97 | |
98 | <P>The <CODE>DefaultPrinter</CODE> directive begins a printer | |
99 | definition as the default server destination. The default server | |
100 | destination can be set using the <CODE>lpadmin(8)</CODE> | |
101 | command:</P> | |
102 | ||
103 | <PRE CLASS="command"> | |
104 | <KBD>/usr/sbin/lpadmin -d printername</KBD> | |
105 | </PRE> | |
106 | ||
107 | <P>Note that the server default destination settings can be | |
108 | overridden by the user's default destination settings which are | |
109 | normally set using the <CODE>lpoptions(1)</CODE> command.</P> | |
110 | ||
111 | ||
480ef0fe | 112 | <H2 CLASS="title"><A NAME="DenyUser">DenyUser</A></H2> |
ef416fc2 | 113 | |
480ef0fe | 114 | <H3>Examples</H3> |
ef416fc2 | 115 | |
116 | <PRE CLASS="command"> | |
480ef0fe | 117 | <Printer name> |
118 | ... | |
119 | DenyUser foo_user | |
120 | DenyUser @bar_group | |
121 | </Printer> | |
ef416fc2 | 122 | </PRE> |
123 | ||
480ef0fe | 124 | <H3>Description</H3> |
ef416fc2 | 125 | |
126 | <P>The <CODE>DenyUser</CODE> directive adds a username or group | |
127 | name to the <VAR>requesting-user-name-denied</VAR> attribute | |
128 | which can be set by the <CODE>lpadmin(8)</CODE> command:</P> | |
129 | ||
130 | <PRE CLASS="command"> | |
131 | <KBD>/usr/sbin/lpadmin -p printername -u deny:foo_user,@bar_group</KBD> | |
132 | </PRE> | |
133 | ||
134 | <P>This directive must appear inside a <A | |
135 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
136 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> directive. | |
137 | This directive cannot be used with <A | |
138 | HREF="#AllowUser"><CODE>AllowUser</CODE></A></P> | |
139 | ||
140 | ||
480ef0fe | 141 | <H2 CLASS="title"><A NAME="DeviceURI">DeviceURI</A></H2> |
ef416fc2 | 142 | |
480ef0fe | 143 | <H3>Examples</H3> |
ef416fc2 | 144 | |
145 | <PRE CLASS="command"> | |
480ef0fe | 146 | <Printer name> |
147 | ... | |
148 | DeviceURI socket://foo.bar.com:9100 | |
149 | </Printer> | |
ef416fc2 | 150 | </PRE> |
151 | ||
480ef0fe | 152 | <H3>Description</H3> |
ef416fc2 | 153 | |
f3c17241 | 154 | <P>The <CODE>DeviceURI</CODE> directive defines the value of the |
ef416fc2 | 155 | <VAR>device-uri-attribute</VAR> attribute. It is normally set |
156 | using the <CODE>lpadmin(8)</CODE> command:</P> | |
157 | ||
158 | <PRE CLASS="command"> | |
159 | <KBD>/usr/sbin/lpadmin -p printername -v device-uri</KBD> | |
160 | </PRE> | |
161 | ||
162 | <P>This directive must appear inside a <A | |
163 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
164 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 165 | section.</P> |
ef416fc2 | 166 | |
167 | ||
480ef0fe | 168 | <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="ErrorPolicy">ErrorPolicy</A></H2> |
ef416fc2 | 169 | |
480ef0fe | 170 | <H3>Examples</H3> |
ef416fc2 | 171 | |
172 | <PRE CLASS="command"> | |
480ef0fe | 173 | <Printer name> |
174 | ... | |
07725fee | 175 | ErrorPolicy abort-job |
480ef0fe | 176 | </Printer> |
ef416fc2 | 177 | </PRE> |
178 | ||
480ef0fe | 179 | <H3>Description</H3> |
ef416fc2 | 180 | |
181 | <P>The <CODE>ErrorPolicy</CODE> directive defines the policy that | |
182 | is used when a backend is unable to send a print job to the | |
183 | printer. The <CODE>lpadmin(8)</CODE> command sets the current | |
184 | error policy:</P> | |
185 | ||
186 | <PRE CLASS="command"> | |
187 | <KBD>/usr/sbin/lpadmin -p printername -o printer-error-policy=stop-printer</KBD> | |
188 | </PRE> | |
189 | ||
190 | <P>The following values are supported:</P> | |
191 | ||
192 | <UL> | |
193 | ||
07725fee | 194 | <LI><CODE>abort-job</CODE> - Abort the job and proceed |
ef416fc2 | 195 | with the next job in the queue</LI> |
196 | ||
ee571f26 MS |
197 | <LI><CODE>retry-current-job</CODE> - Retry the current job |
198 | immediately</LI> | |
199 | ||
ef416fc2 | 200 | <LI><CODE>retry-job</CODE> - Retry the job after waiting |
201 | for N seconds; the <VAR>cupsd.conf</VAR> <A | |
4744bd90 | 202 | HREF="ref-cupsd-conf.html#JobRetryInterval"><CODE>JobRetryInterval</CODE></A> |
ef416fc2 | 203 | directive controls the value of N</LI> |
204 | ||
205 | <LI><CODE>stop-printer</CODE> - Stop the printer and keep | |
206 | the job for future printing; this is the default | |
207 | value</LI> | |
208 | ||
209 | </UL> | |
210 | ||
211 | <P>This directive must appear inside a <A | |
212 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
213 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 214 | section.</P> |
ef416fc2 | 215 | |
216 | ||
58dc1933 MS |
217 | <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4</SPAN><A NAME="Filter">Filter</A></H2> |
218 | ||
219 | <H3>Examples</H3> | |
220 | ||
221 | <PRE CLASS="command"> | |
222 | <Printer name> | |
223 | ... | |
224 | Filter mime/type 100 program | |
225 | </Printer> | |
226 | </PRE> | |
227 | ||
228 | <H3>Description</H3> | |
229 | ||
230 | <P>The <CODE>Filter</CODE> directive lists a single filter program as defined | |
231 | in the printer's PPD file.</P> | |
232 | ||
233 | <P>This directive must appear inside a | |
234 | <A HREF="#Printer"><CODE>Printer</CODE></A> or | |
235 | <A HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> section.</P> | |
236 | ||
237 | ||
480ef0fe | 238 | <H2 CLASS="title"><A NAME="Info">Info</A></H2> |
ef416fc2 | 239 | |
480ef0fe | 240 | <H3>Examples</H3> |
ef416fc2 | 241 | |
242 | <PRE CLASS="command"> | |
480ef0fe | 243 | <Printer name> |
244 | ... | |
245 | Info My Printer | |
246 | </Printer> | |
ef416fc2 | 247 | </PRE> |
248 | ||
480ef0fe | 249 | <H3>Description</H3> |
ef416fc2 | 250 | |
f3c17241 | 251 | <P>The <CODE>Info</CODE> directive defines the string for the |
ef416fc2 | 252 | <VAR>printer-info</VAR> attribute. It is normally set using the |
253 | <CODE>lpadmin(8)</CODE> command:</P> | |
254 | ||
255 | <PRE CLASS="command"> | |
256 | <KBD>/usr/sbin/lpadmin -p printername -D "My Printer"</KBD> | |
257 | </PRE> | |
258 | ||
259 | <P>This directive must appear inside a <A | |
260 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
261 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 262 | section.</P> |
ef416fc2 | 263 | |
264 | ||
480ef0fe | 265 | <H2 CLASS="title"><A NAME="JobSheets">JobSheets</A></H2> |
ef416fc2 | 266 | |
480ef0fe | 267 | <H3>Examples</H3> |
ef416fc2 | 268 | |
269 | <PRE CLASS="command"> | |
480ef0fe | 270 | <Printer name> |
271 | ... | |
272 | JobSheets none,standard | |
273 | </Printer> | |
ef416fc2 | 274 | </PRE> |
275 | ||
480ef0fe | 276 | <H3>Description</H3> |
ef416fc2 | 277 | |
278 | <P>The <CODE>JobSheets</CODE> directive specifies the default | |
279 | banner pages to print before and after a print job. In the above | |
280 | example, only a <VAR>standard</VAR> banner will print after each | |
281 | job. The <CODE>lpadmin(8)</CODE> command is normally used to set | |
282 | the default banners: | |
283 | ||
284 | <PRE CLASS="command"> | |
285 | <KBD>/usr/sbin/lpadmin -p printername -o job-sheets-default=none,standard</KBD> | |
286 | </PRE> | |
287 | ||
288 | <P>If only one banner file is specified, it will be printed | |
289 | before the files in the job. If a second banner file is | |
290 | specified, it is printed after the files in the job.</P> | |
291 | ||
292 | <P>The available banner pages depend on the local system | |
293 | configuration; CUPS includes the following standard banner | |
294 | files:</P> | |
295 | ||
296 | <UL> | |
297 | ||
298 | <LI><CODE>none</CODE> - Do not produce a banner | |
299 | page.</LI> | |
300 | ||
301 | <LI><CODE>classified</CODE> - A banner page with a | |
302 | "classified" label at the top and bottom.</LI> | |
303 | ||
304 | <LI><CODE>confidential</CODE> - A banner page with a | |
305 | "confidential" label at the top and bottom.</LI> | |
306 | ||
307 | <LI><CODE>secret</CODE> - A banner page with a | |
308 | "secret" label at the top and bottom.</LI> | |
309 | ||
310 | <LI><CODE>standard</CODE> - A banner page with no label | |
311 | at the top and bottom.</LI> | |
312 | ||
313 | <LI><CODE>topsecret</CODE> - A banner page with a | |
314 | "top secret" label at the top and bottom.</LI> | |
315 | ||
316 | <LI><CODE>unclassified</CODE> - A banner page with an | |
317 | "unclassified" label at the top and bottom.</LI> | |
318 | ||
319 | </UL> | |
320 | ||
321 | <P>This directive must appear inside a <A | |
322 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
323 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 324 | section.</P> |
ef416fc2 | 325 | |
326 | ||
480ef0fe | 327 | <H2 CLASS="title"><A NAME="KLimit">KLimit</A></H2> |
ef416fc2 | 328 | |
480ef0fe | 329 | <H3>Examples</H3> |
ef416fc2 | 330 | |
331 | <PRE CLASS="command"> | |
480ef0fe | 332 | <Printer name> |
333 | ... | |
334 | KLimit 1234 | |
335 | </Printer> | |
ef416fc2 | 336 | </PRE> |
337 | ||
480ef0fe | 338 | <H3>Description</H3> |
ef416fc2 | 339 | |
f3c17241 | 340 | <P>The <CODE>KLimit</CODE> directive defines the value of the |
ef416fc2 | 341 | <VAR>job-k-limit</VAR> attribute. It is normally set using the |
342 | <CODE>lpadmin(8)</CODE> command:</P> | |
343 | ||
344 | <PRE CLASS="command"> | |
345 | <KBD>/usr/sbin/lpadmin -p printername -o job-k-limit=1234</KBD> | |
346 | </PRE> | |
347 | ||
348 | <P>This directive must appear inside a <A | |
349 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
350 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 351 | section.</P> |
ef416fc2 | 352 | |
353 | ||
480ef0fe | 354 | <H2 CLASS="title"><A NAME="Location">Location</A></H2> |
ef416fc2 | 355 | |
480ef0fe | 356 | <H3>Examples</H3> |
ef416fc2 | 357 | |
358 | <PRE CLASS="command"> | |
480ef0fe | 359 | <Printer name> |
360 | ... | |
361 | Location Building 3321 | |
362 | </Printer> | |
ef416fc2 | 363 | </PRE> |
364 | ||
480ef0fe | 365 | <H3>Description</H3> |
ef416fc2 | 366 | |
f3c17241 | 367 | <P>The <CODE>Location</CODE> directive defines the string for the |
ef416fc2 | 368 | <VAR>printer-location</VAR> attribute. It is normally set using the |
369 | <CODE>lpadmin(8)</CODE> command:</P> | |
370 | ||
371 | <PRE CLASS="command"> | |
372 | <KBD>/usr/sbin/lpadmin -p printername -L "Building 3321"</KBD> | |
373 | </PRE> | |
374 | ||
375 | <P>This directive must appear inside a <A | |
376 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
377 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 378 | section.</P> |
ef416fc2 | 379 | |
380 | ||
480ef0fe | 381 | <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="OpPolicy">OpPolicy</A></H2> |
ef416fc2 | 382 | |
480ef0fe | 383 | <H3>Examples</H3> |
ef416fc2 | 384 | |
385 | <PRE CLASS="command"> | |
480ef0fe | 386 | <Printer name> |
387 | ... | |
388 | OpPolicy default | |
389 | </Printer> | |
ef416fc2 | 390 | </PRE> |
391 | ||
480ef0fe | 392 | <H3>Description</H3> |
ef416fc2 | 393 | |
394 | <P>The <CODE>OpPolicy</CODE> directive sets the operation policy | |
395 | that is used for the printer. The <CODE>lpadmin(8)</CODE> command | |
396 | sets the current operation policy:</P> | |
397 | ||
398 | <PRE CLASS="command"> | |
399 | <KBD>/usr/sbin/lpadmin -p printername -o printer-op-policy=default</KBD> | |
400 | </PRE> | |
401 | ||
402 | <P>The default policy is named "default". All policies correspond | |
403 | to those defined using the <VAR>cupsd.conf</VAR> <A | |
4744bd90 | 404 | HREF="ref-cupsd-conf.html#Policy"><CODE>Policy</CODE></A> |
480ef0fe | 405 | section.</P> |
ef416fc2 | 406 | |
407 | <P>This directive must appear inside a <A | |
408 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
409 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 410 | section.</P> |
ef416fc2 | 411 | |
412 | ||
480ef0fe | 413 | <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="Option">Option</A></H2> |
ef416fc2 | 414 | |
480ef0fe | 415 | <H3>Examples</H3> |
ef416fc2 | 416 | |
417 | <PRE CLASS="command"> | |
480ef0fe | 418 | <Printer name> |
419 | ... | |
420 | Option name value | |
421 | Option scaling 100 | |
422 | Option page-left 72 | |
423 | </Printer> | |
ef416fc2 | 424 | </PRE> |
425 | ||
480ef0fe | 426 | <H3>Description</H3> |
427 | ||
428 | <P>The <CODE>Option</CODE> directive specifies a default job | |
429 | template attribute value. It is mapped to | |
430 | <CODE>name-default</CODE> in the printer attributes and applied | |
431 | to jobs as <CODE>name</CODE>.</P> | |
432 | ||
433 | <P>This directive must appear inside a <A | |
434 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
435 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
436 | section.</P> | |
437 | ||
438 | ||
439 | <H2 CLASS="title"><A NAME="PageLimit">PageLimit</A></H2> | |
440 | ||
441 | <H3>Examples</H3> | |
442 | ||
443 | <PRE CLASS="command"> | |
444 | <Printer name> | |
445 | ... | |
446 | PageLimit 1234 | |
447 | </Printer> | |
448 | </PRE> | |
449 | ||
450 | <H3>Description</H3> | |
ef416fc2 | 451 | |
f3c17241 | 452 | <P>The <CODE>PageLimit</CODE> directive defines the value of the |
ef416fc2 | 453 | <VAR>job-page-limit</VAR> attribute. It can be set using the |
454 | <CODE>lpadmin(8)</CODE> command:</P> | |
455 | ||
456 | <PRE CLASS="command"> | |
457 | <KBD>/usr/sbin/lpadmin -p printername -o job-page-limit=1234</KBD> | |
458 | </PRE> | |
459 | ||
460 | <P>This directive must appear inside a <A | |
461 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
462 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 463 | section.</P> |
ef416fc2 | 464 | |
465 | ||
480ef0fe | 466 | <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="PortMonitor">PortMonitor</A></H2> |
ef416fc2 | 467 | |
480ef0fe | 468 | <H3>Examples</H3> |
ef416fc2 | 469 | |
470 | <PRE CLASS="command"> | |
480ef0fe | 471 | <Printer name> |
472 | ... | |
473 | PortMonitor bcp | |
474 | </Printer> | |
ef416fc2 | 475 | </PRE> |
476 | ||
480ef0fe | 477 | <H3>Description</H3> |
ef416fc2 | 478 | |
479 | <P>The <CODE>PortMonitor</CODE> directive sets the filter program that | |
480 | is used for every print job, typically to encode or package the print | |
481 | data in a format acceptable for a particular printer interface. It is | |
482 | set using the <CODE>lpadmin(8)</CODE> command:</P> | |
483 | ||
484 | <PRE CLASS="command"> | |
485 | <KBD>/usr/sbin/lpadmin -p printername -o port-monitor=tbcp</KBD> | |
486 | </PRE> | |
487 | ||
488 | <P>The following standard port monitors are included with CUPS:</P> | |
489 | ||
490 | <UL> | |
491 | ||
492 | <LI><CODE>bcp</CODE> - Encode PostScript print data using | |
493 | the Adobe Binary Control Protocol (BCP)</LI> | |
494 | ||
495 | <LI><CODE>none</CODE> - Do not use a port monitor</LI> | |
496 | ||
497 | <LI><CODE>tbcp</CODE> - Encode PostScript print data | |
498 | using the Adobe Tagged Binary Control Protocol | |
499 | (TBCP)</LI> | |
500 | ||
501 | </UL> | |
502 | ||
503 | <P>This directive must appear inside a <A | |
504 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
505 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 506 | section.</P> |
ef416fc2 | 507 | |
508 | ||
58dc1933 MS |
509 | <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4</SPAN><A NAME="PreFilter">PreFilter</A></H2> |
510 | ||
511 | <H3>Examples</H3> | |
512 | ||
513 | <PRE CLASS="command"> | |
514 | <Printer name> | |
515 | ... | |
516 | PreFilter mime/type 100 program | |
517 | </Printer> | |
518 | </PRE> | |
519 | ||
520 | <H3>Description</H3> | |
521 | ||
522 | <P>The <CODE>PreFilter</CODE> directive lists a single pre-filter program as | |
523 | defined in the printer's PPD file.</P> | |
524 | ||
525 | <P>This directive must appear inside a | |
526 | <A HREF="#Printer"><CODE>Printer</CODE></A> or | |
527 | <A HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> section.</P> | |
528 | ||
529 | ||
480ef0fe | 530 | <H2 CLASS="title"><A NAME="Printer">Printer</A></H2> |
ef416fc2 | 531 | |
480ef0fe | 532 | <H3>Examples</H3> |
ef416fc2 | 533 | |
534 | <PRE CLASS="command"> | |
535 | <Printer name> | |
480ef0fe | 536 | ... |
ef416fc2 | 537 | </Printer> |
538 | </PRE> | |
539 | ||
480ef0fe | 540 | <H3>Description</H3> |
ef416fc2 | 541 | |
542 | <P>The <CODE>Printer</CODE> directive begins a printer | |
543 | definition. Printers are added using the <CODE>lpadmin(8)</CODE> | |
544 | command: | |
545 | ||
546 | <PRE CLASS="command"> | |
547 | <KBD>/usr/sbin/lpadmin -p printername ...</KBD> | |
548 | </PRE> | |
549 | ||
550 | ||
58dc1933 MS |
551 | <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.4</SPAN><A NAME="Product">Product</A></H2> |
552 | ||
553 | <H3>Examples</H3> | |
554 | ||
555 | <PRE CLASS="command"> | |
556 | <Printer name> | |
557 | ... | |
558 | Product Acme PaperWriter | |
559 | </Printer> | |
560 | </PRE> | |
561 | ||
562 | <H3>Description</H3> | |
563 | ||
564 | <P>The <CODE>Product</CODE> directive defines the main product string from the | |
565 | printer's PPD file and is used when advertising the queue via DNS-SD.</P> | |
566 | ||
567 | <P>This directive must appear inside a | |
568 | <A HREF="#Printer"><CODE>Printer</CODE></A> or | |
569 | <A HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> section.</P> | |
570 | ||
571 | ||
480ef0fe | 572 | <H2 CLASS="title"><A NAME="QuotaPeriod">QuotaPeriod</A></H2> |
ef416fc2 | 573 | |
480ef0fe | 574 | <H3>Examples</H3> |
ef416fc2 | 575 | |
576 | <PRE CLASS="command"> | |
480ef0fe | 577 | <Printer name> |
578 | ... | |
579 | QuotaPeriod 604800 | |
580 | </Printer> | |
ef416fc2 | 581 | </PRE> |
582 | ||
480ef0fe | 583 | <H3>Description</H3> |
ef416fc2 | 584 | |
585 | <P>The <CODE>QuotaPeriod</CODE> directive defines the value of | |
586 | the <VAR>job-quota-period</VAR> attribute. Typical values are | |
587 | 86400 (1 day), 604800 (1 week), 2592000 (1 month), and 31536000 | |
588 | (1 year). It is set using the <CODE>lpadmin(8)</CODE> | |
589 | command:</P> | |
590 | ||
591 | <PRE CLASS="command"> | |
592 | <KBD>/usr/sbin/lpadmin -p printername -o job-quota-period=604800</KBD> | |
593 | </PRE> | |
594 | ||
595 | <P>This directive must appear inside a <A | |
596 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
597 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 598 | section.</P> |
ef416fc2 | 599 | |
600 | ||
480ef0fe | 601 | <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="Shared">Shared</A></H2> |
ef416fc2 | 602 | |
480ef0fe | 603 | <H3>Examples</H3> |
ef416fc2 | 604 | |
605 | <PRE CLASS="command"> | |
480ef0fe | 606 | <Printer name> |
607 | ... | |
608 | Shared yes | |
609 | </Printer> | |
ef416fc2 | 610 | </PRE> |
611 | ||
480ef0fe | 612 | <H3>Description</H3> |
ef416fc2 | 613 | |
614 | <P>The <CODE>Shared</CODE> directive defines the initial value of | |
615 | the <VAR>printer-is-shared</VAR> attribute. The strings | |
616 | <VAR>yes</VAR> and <VAR>no</VAR> correspond to the true and false | |
617 | values, respectively. The <CODE>lpadmin(8)</CODE> command sets | |
618 | the current state:</P> | |
619 | ||
620 | <PRE CLASS="command"> | |
621 | <KBD>/usr/sbin/lpadmin -p printername -o printer-is-shared=true</KBD> | |
622 | </PRE> | |
623 | ||
624 | <P>This directive must appear inside a <A | |
625 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
626 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 627 | section.</P> |
ef416fc2 | 628 | |
629 | ||
480ef0fe | 630 | <H2 CLASS="title"><A NAME="State">State</A></H2> |
ef416fc2 | 631 | |
480ef0fe | 632 | <H3>Examples</H3> |
ef416fc2 | 633 | |
634 | <PRE CLASS="command"> | |
480ef0fe | 635 | <Printer name> |
636 | ... | |
637 | State idle | |
638 | </Printer> | |
ef416fc2 | 639 | </PRE> |
640 | ||
480ef0fe | 641 | <H3>Description</H3> |
ef416fc2 | 642 | |
643 | <P>The <CODE>State</CODE> directive defines the initial value of | |
644 | the <VAR>printer-state</VAR> attribute. The strings | |
645 | <VAR>idle</VAR> and <VAR>stopped</VAR> correspond to the IPP | |
646 | enumeration values 3 and 5, respectively. The | |
647 | <CODE>cupsenable(8)</CODE> and <CODE>cupsdisable(8)</CODE> | |
648 | commands set the current state:</P> | |
649 | ||
650 | <PRE CLASS="command"> | |
651 | <KBD>/usr/sbin/cupsenable printername</KBD> | |
652 | <KBD>/usr/sbin/cupsdisable printername</KBD> | |
653 | </PRE> | |
654 | ||
655 | <P>This directive must appear inside a <A | |
656 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
657 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 658 | section.</P> |
ef416fc2 | 659 | |
660 | ||
480ef0fe | 661 | <H2 CLASS="title"><A NAME="StateMessage">StateMessage</A></H2> |
ef416fc2 | 662 | |
480ef0fe | 663 | <H3>Examples</H3> |
ef416fc2 | 664 | |
665 | <PRE CLASS="command"> | |
480ef0fe | 666 | <Printer name> |
667 | ... | |
f3c17241 | 668 | StateMessage Printer is lonely. |
480ef0fe | 669 | </Printer> |
ef416fc2 | 670 | </PRE> |
671 | ||
480ef0fe | 672 | <H3>Description</H3> |
ef416fc2 | 673 | |
674 | <P>The <CODE>StateMessage</CODE> directive defines the initial | |
675 | string for the <VAR>printer-state-message</VAR> attribute. The | |
676 | following are some example messages:</P> | |
677 | ||
678 | <PRE CLASS="command"> | |
679 | StateMessage Connected to host_name... | |
680 | StateMessage Connecting to printer_queue on port port_number... | |
681 | StateMessage Network host host_name is busy; will retry in 30 seconds... | |
682 | StateMessage Printer busy; will retry in 10 seconds... | |
683 | StateMessage Printer is busy; retrying print job... | |
684 | StateMessage Print file accepted - job ID id_number. | |
ef416fc2 | 685 | StateMessage Waiting for job to complete |
686 | </PRE> | |
687 | ||
688 | <P>This directive must appear inside a <A | |
689 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
690 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 691 | section.</P> |
ef416fc2 | 692 | |
693 | ||
480ef0fe | 694 | <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="StateTime">StateTime</A></H2> |
ef416fc2 | 695 | |
480ef0fe | 696 | <H3>Examples</H3> |
ef416fc2 | 697 | |
698 | <PRE CLASS="command"> | |
480ef0fe | 699 | <Printer name> |
700 | ... | |
701 | StateTime 1133542425 | |
702 | </Printer> | |
ef416fc2 | 703 | </PRE> |
704 | ||
480ef0fe | 705 | <H3>Description</H3> |
ef416fc2 | 706 | |
707 | <P>The <CODE>StateTime</CODE> directive defines the UNIX time | |
708 | (seconds since Jan 1, 1970) for the last state change of the | |
709 | queue. It is mapped to the <VAR>printer-state-change-time</VAR> | |
710 | attribute.</P> | |
711 | ||
712 | <P>This directive must appear inside a <A | |
713 | HREF="#Printer"><CODE>Printer</CODE></A> or <A | |
714 | HREF="#DefaultPrinter"><CODE>DefaultPrinter</CODE></A> | |
480ef0fe | 715 | section.</P> |
ef416fc2 | 716 | |
717 | ||
718 | </BODY> | |
719 | </HTML> |