2 <!-- SECTION: References -->
4 <TITLE>classes.conf
</TITLE>
8 <P>The CUPS scheduler (cupsd) uses the
9 <VAR>/etc/cups/classes.conf
</VAR> file to store the list of
10 available classes. This file contains only locally defined
11 classes, not remote classes that are created automatically via
12 browsing. Each directive is listed on a line by itself followed
13 by its value. Comments are introduced using the number sign (
"#")
14 character at the beginning of a line.
</P>
16 <P>While the class configuration file consists of plain text and
17 can be modified using your favorite text editor, you should
18 normally use the
<A HREF=
"man-lpadmin.html">lpadmin(
8)
</A>
19 command, web interface, or any of the available GUIs to manage
20 your classes instead. If you do choose to edit this file
21 manually, you will need to restart the scheduler to make them
25 <H2 CLASS=
"title"><A NAME=
"Accepting">Accepting
</A></H2>
38 <P>The
<CODE>Accepting
</CODE> directive defines the initial state
39 of the
<VAR>printer-is-accepting-jobs
</VAR> attribute. This state
40 is also set by the
<CODE>accept(
8)
</CODE> and
41 <CODE>reject(
8)
</CODE> commands:
</P>
44 <KBD>/usr/sbin/accept classname
45 /usr/sbin/reject classname
</KBD>
48 <P>This directive must appear inside a
<A
49 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
50 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
54 <H2 CLASS=
"title"><A NAME=
"AllowUser">AllowUser
</A></H2>
68 <P>The
<CODE>AllowUser
</CODE> directive adds a username or group
69 name to the
<VAR>requesting-user-name-allowed
</VAR> attribute
70 which can be set by the
<CODE>lpadmin(
8)
</CODE> command:
</P>
73 <KBD>/usr/sbin/lpadmin -p classname -u allow:foo_user,@bar_group
</KBD>
76 <P>This directive must appear inside a
<A
77 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
78 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A> directive.
79 This directive cannot be used with
<A
80 HREF=
"#DenyUser"><CODE>DenyUser
</CODE></A>.
</P>
83 <H2 CLASS=
"title"><A NAME=
"Class">Class
</A></H2>
95 <P>The
<CODE>Class
</CODE> directive begins a class definition.
96 Classes are added using the
<CODE>lpadmin(
8)
</CODE> command:
99 <KBD>/usr/sbin/lpadmin -p printername -c classname
</KBD>
103 <H2 CLASS=
"title"><A NAME=
"DefaultClass">DefaultClass
</A></H2>
107 <PRE CLASS=
"command">
108 <DefaultClass name
>
115 <P>The
<CODE>DefaultClass
</CODE> directive begins a class
116 definition as the default server destination. The default server
117 destination can be set using the
<CODE>lpadmin(
8)
</CODE>
120 <PRE CLASS=
"command">
121 <KBD>/usr/sbin/lpadmin -d classname
</KBD>
124 <P>Note that the server default destination settings can be
125 overridden by the user's default destination settings which are
126 normally set using the
<CODE>lpoptions(
1)
</CODE> command.
</P>
129 <H2 CLASS=
"title"><A NAME=
"DenyUser">DenyUser
</A></H2>
133 <PRE CLASS=
"command">
143 <P>The
<CODE>DenyUser
</CODE> directive adds a username or group
144 name to the
<VAR>requesting-user-name-denied
</VAR> attribute
145 which can be set by the
<CODE>lpadmin(
8)
</CODE> command:
</P>
147 <PRE CLASS=
"command">
148 <KBD>/usr/sbin/lpadmin -p classname -u deny:foo_user,@bar_group
</KBD>
151 <P>This directive must appear inside a
<A
152 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
153 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A> directive.
154 This directive cannot be used with
<A
155 HREF=
"#AllowUser"><CODE>AllowUser
</CODE></A></P>
158 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"ErrorPolicy">ErrorPolicy
</A></H2>
162 <PRE CLASS=
"command">
165 ErrorPolicy abort-job
171 <P>The
<CODE>ErrorPolicy
</CODE> directive defines the policy that
172 is used when a backend is unable to send a print job to the
173 printer. The
<CODE>lpadmin(
8)
</CODE> command sets the current
176 <PRE CLASS=
"command">
177 <KBD>/usr/sbin/lpadmin -p classname -o printer-error-policy=stop-printer
</KBD>
180 <P>The following values are supported:
</P>
184 <LI><CODE>abort-job
</CODE> - Abort the job and proceed
185 with the next job in the queue
</LI>
187 <LI><CODE>retry-job
</CODE> - Retry the job after waiting
188 for N seconds; the
<VAR>cupsd.conf
</VAR> <A
189 HREF=
"ref-cupsd-conf.html#JobRetryInterval"><CODE>JobRetryInterval
</CODE></A>
190 directive controls the value of N
</LI>
192 <LI><CODE>stop-printer
</CODE> - Stop the printer and keep
193 the job for future printing; this is the default
198 <P>This directive must appear inside a
<A
199 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
200 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
204 <H2 CLASS=
"title"><A NAME=
"Info">Info
</A></H2>
208 <PRE CLASS=
"command">
217 <P>The
<CODE>Info
</CODE> directive defines the string for the
218 <VAR>printer-info
</VAR> attribute. It is normally set using the
219 <CODE>lpadmin(
8)
</CODE> command:
</P>
221 <PRE CLASS=
"command">
222 <KBD>/usr/sbin/lpadmin -p classname -D
"My Class"</KBD>
225 <P>This directive must appear inside a
<A
226 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
227 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
231 <H2 CLASS=
"title"><A NAME=
"JobSheets">JobSheets
</A></H2>
235 <PRE CLASS=
"command">
238 JobSheets none,standard
244 <P>The
<CODE>JobSheets
</CODE> directive specifies the default
245 banner pages to print before and after a print job. In the above
246 example, only a
<VAR>standard
</VAR> banner will print after each
247 job. The
<CODE>lpadmin(
8)
</CODE> command is normally used to set
250 <PRE CLASS=
"command">
251 <KBD>/usr/sbin/lpadmin -p classname -o job-sheets-default=none,standard
</KBD>
254 <P>If only one banner file is specified, it will be printed
255 before the files in the job. If a second banner file is
256 specified, it is printed after the files in the job.
</P>
258 <P>The available banner pages depend on the local system
259 configuration; CUPS includes the following standard banner
264 <LI><CODE>none
</CODE> - Do not produce a banner
267 <LI><CODE>classified
</CODE> - A banner page with a
268 "classified
" label at the top and bottom.
</LI>
270 <LI><CODE>confidential
</CODE> - A banner page with a
271 "confidential
" label at the top and bottom.
</LI>
273 <LI><CODE>secret
</CODE> - A banner page with a
274 "secret
" label at the top and bottom.
</LI>
276 <LI><CODE>standard
</CODE> - A banner page with no label
277 at the top and bottom.
</LI>
279 <LI><CODE>topsecret
</CODE> - A banner page with a
280 "top secret
" label at the top and bottom.
</LI>
282 <LI><CODE>unclassified
</CODE> - A banner page with an
283 "unclassified
" label at the top and bottom.
</LI>
287 <P>This directive must appear inside a
<A
288 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
289 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
293 <H2 CLASS=
"title"><A NAME=
"KLimit">KLimit
</A></H2>
297 <PRE CLASS=
"command">
306 <P>The
<CODE>KLimit
</CODE> directive defines the value of the
307 <VAR>job-k-limit
</VAR> attribute. It is normally set using the
308 <CODE>lpadmin(
8)
</CODE> command:
</P>
310 <PRE CLASS=
"command">
311 <KBD>/usr/sbin/lpadmin -p classname -o job-k-limit=
1234</KBD>
314 <P>This directive must appear inside a
<A
315 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
316 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
320 <H2 CLASS=
"title"><A NAME=
"Location">Location
</A></H2>
324 <PRE CLASS=
"command">
327 Location Building
3321
333 <P>The
<CODE>Location
</CODE> directive defines the string for the
334 <VAR>printer-location
</VAR> attribute. It is normally set using the
335 <CODE>lpadmin(
8)
</CODE> command:
</P>
337 <PRE CLASS=
"command">
338 <KBD>/usr/sbin/lpadmin -p classname -L
"Building 3321"</KBD>
341 <P>This directive must appear inside a
<A
342 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
343 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
347 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"OpPolicy">OpPolicy
</A></H2>
351 <PRE CLASS=
"command">
360 <P>The
<CODE>OpPolicy
</CODE> directive sets the operation policy
361 that is used for the printer. The
<CODE>lpadmin(
8)
</CODE> command
362 sets the current operation policy:
</P>
364 <PRE CLASS=
"command">
365 <KBD>/usr/sbin/lpadmin -p classname -o printer-op-policy=default
</KBD>
368 <P>The default policy is named
"default". All policies correspond
369 to those defined using the
<VAR>cupsd.conf
</VAR> <A
370 HREF=
"ref-cupsd-conf.html#Policy"><CODE>Policy
</CODE></A>
373 <P>This directive must appear inside a
<A
374 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
375 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
379 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"Option">Option
</A></H2>
383 <PRE CLASS=
"command">
394 <P>The
<CODE>Option
</CODE> directive specifies a default job
395 template attribute value. It is mapped to
396 <CODE>name-default
</CODE> in the printer attributes and applied
397 to jobs as
<CODE>name
</CODE>.
</P>
399 <P>This directive must appear inside a
<A
400 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
401 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
405 <H2 CLASS=
"title"><A NAME=
"PageLimit">PageLimit
</A></H2>
409 <PRE CLASS=
"command">
418 <P>The
<CODE>PageLimit
</CODE> directive defines the value of the
419 <VAR>job-page-limit
</VAR> attribute. It can be set using the
420 <CODE>lpadmin(
8)
</CODE> command:
</P>
422 <PRE CLASS=
"command">
423 <KBD>/usr/sbin/lpadmin -p classname -o job-page-limit=
1234</KBD>
426 <P>This directive must appear inside a
<A
427 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
428 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
432 <H2 CLASS=
"title"><A NAME=
"Printer">Printer
</A></H2>
436 <PRE CLASS=
"command">
447 <P>The
<CODE>Printer
</CODE> directive adds a printer to a class.
448 Printers are added to a class using the
<CODE>lpadmin(
8)
</CODE>
451 <PRE CLASS=
"command">
452 <KBD>/usr/sbin/lpadmin -p printername -c classname
</KBD>
455 <P>This directive must appear inside a
<A
456 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
457 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
461 <H2 CLASS=
"title"><A NAME=
"QuotaPeriod">QuotaPeriod
</A></H2>
465 <PRE CLASS=
"command">
474 <P>The
<CODE>QuotaPeriod
</CODE> directive defines the value of
475 the
<VAR>job-quota-period
</VAR> attribute. Typical values are
476 86400 (
1 day),
604800 (
1 week),
2592000 (
1 month), and
31536000
477 (
1 year). It is set using the
<CODE>lpadmin(
8)
</CODE>
480 <PRE CLASS=
"command">
481 <KBD>/usr/sbin/lpadmin -p classname -o job-quota-period=
604800</KBD>
484 <P>This directive must appear inside a
<A
485 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
486 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
490 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"Shared">Shared
</A></H2>
494 <PRE CLASS=
"command">
503 <P>The
<CODE>Shared
</CODE> directive defines the initial value of
504 the
<VAR>printer-is-shared
</VAR> attribute. The strings
505 <VAR>yes
</VAR> and
<VAR>no
</VAR> correspond to the true and false
506 values, respectively. The
<CODE>lpadmin(
8)
</CODE> command sets
507 the current state:
</P>
509 <PRE CLASS=
"command">
510 <KBD>/usr/sbin/lpadmin -p classname -o printer-is-shared=true
</KBD>
513 <P>This directive must appear inside a
<A
514 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
515 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
519 <H2 CLASS=
"title"><A NAME=
"State">State
</A></H2>
523 <PRE CLASS=
"command">
532 <P>The
<CODE>State
</CODE> directive defines the initial value of
533 the
<VAR>printer-state
</VAR> attribute. The strings
534 <VAR>idle
</VAR> and
<VAR>stopped
</VAR> correspond to the IPP
535 enumeration values
3 and
5, respectively. The
536 <CODE>cupsenable(
8)
</CODE> and
<CODE>cupsdisable(
8)
</CODE>
537 commands set the current state:
</P>
539 <PRE CLASS=
"command">
540 <KBD>/usr/sbin/cupsenable classname
</KBD>
541 <KBD>/usr/sbin/cupsdisable classname
</KBD>
544 <P>This directive must appear inside a
<A
545 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
546 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
550 <H2 CLASS=
"title"><A NAME=
"StateMessage">StateMessage
</A></H2>
554 <PRE CLASS=
"command">
557 StateMessage Ready to print.
563 <P>The
<CODE>StateMessage
</CODE> directive defines the initial
564 string for the
<VAR>printer-state-message
</VAR> attribute. The
565 following are some example messages:
</P>
567 <PRE CLASS=
"command">
568 StateMessage Connected to host_name...
569 StateMessage Connecting to printer_queue on port port_number...
570 StateMessage Network host host_name is busy; will retry in
30 seconds...
571 StateMessage Class busy; will retry in
10 seconds...
572 StateMessage Class is busy; retrying print job...
573 StateMessage Print file accepted - job ID id_number.
574 StateMessage Ready to print.
575 StateMessage Waiting for job to complete
578 <P>This directive must appear inside a
<A
579 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
580 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
584 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"StateTime">StateTime
</A></H2>
588 <PRE CLASS=
"command">
597 <P>The
<CODE>StateTime
</CODE> directive defines the UNIX time
598 (seconds since Jan
1,
1970) for the last state change of the
599 queue. It is mapped to the
<VAR>printer-state-change-time
</VAR>
602 <P>This directive must appear inside a
<A
603 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
604 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>