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