2 <!-- SECTION: References -->
4 <TITLE>classes.conf
</TITLE>
5 <LINK REL=
"STYLESHEET" TYPE=
"text/css" HREF=
"../cups-printable.css">
9 <H1 CLASS=
"title">classes.conf
</H1>
11 <P>The CUPS scheduler (cupsd) uses the
12 <VAR>/etc/cups/classes.conf
</VAR> file to store the list of
13 available classes. This file contains only locally defined
14 classes, not remote classes 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>
19 <P>While the class configuration file consists of plain text and
20 can be modified using your favorite text editor, you should
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 classes instead. If you do choose to edit this file
24 manually, you will need to stop the scheduler first, make your
25 changes, and then start the scheduler to make them active.
</P>
28 <H2 CLASS=
"title"><A NAME=
"Accepting">Accepting
</A></H2>
41 <P>The
<CODE>Accepting
</CODE> directive defines the initial state
42 of the
<VAR>printer-is-accepting-jobs
</VAR> attribute. This state
43 is also set by the
<CODE>accept(
8)
</CODE> and
44 <CODE>reject(
8)
</CODE> commands:
</P>
47 <KBD>/usr/sbin/accept classname
48 /usr/sbin/reject classname
</KBD>
51 <P>This directive must appear inside a
<A
52 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
53 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
57 <H2 CLASS=
"title"><A NAME=
"AllowUser">AllowUser
</A></H2>
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>
76 <KBD>/usr/sbin/lpadmin -p classname -u allow:foo_user,@bar_group
</KBD>
79 <P>This directive must appear inside a
<A
80 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
81 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A> directive.
82 This directive cannot be used with
<A
83 HREF=
"#DenyUser"><CODE>DenyUser
</CODE></A>.
</P>
86 <H2 CLASS=
"title"><A NAME=
"Class">Class
</A></H2>
98 <P>The
<CODE>Class
</CODE> directive begins a class definition.
99 Classes are added using the
<CODE>lpadmin(
8)
</CODE> command:
101 <PRE CLASS=
"command">
102 <KBD>/usr/sbin/lpadmin -p printername -c classname
</KBD>
106 <H2 CLASS=
"title"><A NAME=
"DefaultClass">DefaultClass
</A></H2>
110 <PRE CLASS=
"command">
111 <DefaultClass name
>
118 <P>The
<CODE>DefaultClass
</CODE> directive begins a class
119 definition as the default server destination. The default server
120 destination can be set using the
<CODE>lpadmin(
8)
</CODE>
123 <PRE CLASS=
"command">
124 <KBD>/usr/sbin/lpadmin -d classname
</KBD>
127 <P>Note that the server default destination settings can be
128 overridden by the user's default destination settings which are
129 normally set using the
<CODE>lpoptions(
1)
</CODE> command.
</P>
132 <H2 CLASS=
"title"><A NAME=
"DenyUser">DenyUser
</A></H2>
136 <PRE CLASS=
"command">
146 <P>The
<CODE>DenyUser
</CODE> directive adds a username or group
147 name to the
<VAR>requesting-user-name-denied
</VAR> attribute
148 which can be set by the
<CODE>lpadmin(
8)
</CODE> command:
</P>
150 <PRE CLASS=
"command">
151 <KBD>/usr/sbin/lpadmin -p classname -u deny:foo_user,@bar_group
</KBD>
154 <P>This directive must appear inside a
<A
155 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
156 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A> directive.
157 This directive cannot be used with
<A
158 HREF=
"#AllowUser"><CODE>AllowUser
</CODE></A></P>
161 <H2 CLASS=
"title"><A NAME=
"Info">Info
</A></H2>
165 <PRE CLASS=
"command">
174 <P>The
<CODE>Info
</CODE> directive defines the string for the
175 <VAR>printer-info
</VAR> attribute. It is normally set using the
176 <CODE>lpadmin(
8)
</CODE> command:
</P>
178 <PRE CLASS=
"command">
179 <KBD>/usr/sbin/lpadmin -p classname -D
"My Class"</KBD>
182 <P>This directive must appear inside a
<A
183 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
184 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
188 <H2 CLASS=
"title"><A NAME=
"JobSheets">JobSheets
</A></H2>
192 <PRE CLASS=
"command">
195 JobSheets none,standard
201 <P>The
<CODE>JobSheets
</CODE> directive specifies the default
202 banner pages to print before and after a print job. In the above
203 example, only a
<VAR>standard
</VAR> banner will print after each
204 job. The
<CODE>lpadmin(
8)
</CODE> command is normally used to set
207 <PRE CLASS=
"command">
208 <KBD>/usr/sbin/lpadmin -p classname -o job-sheets-default=none,standard
</KBD>
211 <P>If only one banner file is specified, it will be printed
212 before the files in the job. If a second banner file is
213 specified, it is printed after the files in the job.
</P>
215 <P>The available banner pages depend on the local system
216 configuration; CUPS includes the following standard banner
221 <LI><CODE>none
</CODE> - Do not produce a banner
224 <LI><CODE>classified
</CODE> - A banner page with a
225 "classified
" label at the top and bottom.
</LI>
227 <LI><CODE>confidential
</CODE> - A banner page with a
228 "confidential
" label at the top and bottom.
</LI>
230 <LI><CODE>secret
</CODE> - A banner page with a
231 "secret
" label at the top and bottom.
</LI>
233 <LI><CODE>standard
</CODE> - A banner page with no label
234 at the top and bottom.
</LI>
236 <LI><CODE>topsecret
</CODE> - A banner page with a
237 "top secret
" label at the top and bottom.
</LI>
239 <LI><CODE>unclassified
</CODE> - A banner page with an
240 "unclassified
" label at the top and bottom.
</LI>
244 <P>This directive must appear inside a
<A
245 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
246 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
250 <H2 CLASS=
"title"><A NAME=
"KLimit">KLimit
</A></H2>
254 <PRE CLASS=
"command">
263 <P>The
<CODE>KLimit
</CODE> directive defines the value of the
264 <VAR>job-k-limit
</VAR> attribute. It is normally set using the
265 <CODE>lpadmin(
8)
</CODE> command:
</P>
267 <PRE CLASS=
"command">
268 <KBD>/usr/sbin/lpadmin -p classname -o job-k-limit=
1234</KBD>
271 <P>This directive must appear inside a
<A
272 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
273 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
277 <H2 CLASS=
"title"><A NAME=
"Location">Location
</A></H2>
281 <PRE CLASS=
"command">
284 Location Building
3321
290 <P>The
<CODE>Location
</CODE> directive defines the string for the
291 <VAR>printer-location
</VAR> attribute. It is normally set using the
292 <CODE>lpadmin(
8)
</CODE> command:
</P>
294 <PRE CLASS=
"command">
295 <KBD>/usr/sbin/lpadmin -p classname -L
"Building 3321"</KBD>
298 <P>This directive must appear inside a
<A
299 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
300 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
304 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"OpPolicy">OpPolicy
</A></H2>
308 <PRE CLASS=
"command">
317 <P>The
<CODE>OpPolicy
</CODE> directive sets the operation policy
318 that is used for the printer. The
<CODE>lpadmin(
8)
</CODE> command
319 sets the current operation policy:
</P>
321 <PRE CLASS=
"command">
322 <KBD>/usr/sbin/lpadmin -p classname -o printer-op-policy=default
</KBD>
325 <P>The default policy is named
"default". All policies correspond
326 to those defined using the
<VAR>cupsd.conf
</VAR> <A
327 HREF=
"ref-cupsd-conf.html#Policy"><CODE>Policy
</CODE></A>
330 <P>This directive must appear inside a
<A
331 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
332 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
336 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"Option">Option
</A></H2>
340 <PRE CLASS=
"command">
351 <P>The
<CODE>Option
</CODE> directive specifies a default job
352 template attribute value. It is mapped to
353 <CODE>name-default
</CODE> in the printer attributes and applied
354 to jobs as
<CODE>name
</CODE>.
</P>
356 <P>This directive must appear inside a
<A
357 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
358 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
362 <H2 CLASS=
"title"><A NAME=
"PageLimit">PageLimit
</A></H2>
366 <PRE CLASS=
"command">
375 <P>The
<CODE>PageLimit
</CODE> directive defines the value of the
376 <VAR>job-page-limit
</VAR> attribute. It can be set using the
377 <CODE>lpadmin(
8)
</CODE> command:
</P>
379 <PRE CLASS=
"command">
380 <KBD>/usr/sbin/lpadmin -p classname -o job-page-limit=
1234</KBD>
383 <P>This directive must appear inside a
<A
384 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
385 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
389 <H2 CLASS=
"title"><A NAME=
"Printer">Printer
</A></H2>
393 <PRE CLASS=
"command">
404 <P>The
<CODE>Printer
</CODE> directive adds a printer to a class.
405 Printers are added to a class using the
<CODE>lpadmin(
8)
</CODE>
408 <PRE CLASS=
"command">
409 <KBD>/usr/sbin/lpadmin -p printername -c classname
</KBD>
412 <P>This directive must appear inside a
<A
413 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
414 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
418 <H2 CLASS=
"title"><A NAME=
"QuotaPeriod">QuotaPeriod
</A></H2>
422 <PRE CLASS=
"command">
431 <P>The
<CODE>QuotaPeriod
</CODE> directive defines the value of
432 the
<VAR>job-quota-period
</VAR> attribute. Typical values are
433 86400 (
1 day),
604800 (
1 week),
2592000 (
1 month), and
31536000
434 (
1 year). It is set using the
<CODE>lpadmin(
8)
</CODE>
437 <PRE CLASS=
"command">
438 <KBD>/usr/sbin/lpadmin -p classname -o job-quota-period=
604800</KBD>
441 <P>This directive must appear inside a
<A
442 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
443 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
447 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"Shared">Shared
</A></H2>
451 <PRE CLASS=
"command">
460 <P>The
<CODE>Shared
</CODE> directive defines the initial value of
461 the
<VAR>printer-is-shared
</VAR> attribute. The strings
462 <VAR>yes
</VAR> and
<VAR>no
</VAR> correspond to the true and false
463 values, respectively. The
<CODE>lpadmin(
8)
</CODE> command sets
464 the current state:
</P>
466 <PRE CLASS=
"command">
467 <KBD>/usr/sbin/lpadmin -p classname -o printer-is-shared=true
</KBD>
470 <P>This directive must appear inside a
<A
471 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
472 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
476 <H2 CLASS=
"title"><A NAME=
"State">State
</A></H2>
480 <PRE CLASS=
"command">
489 <P>The
<CODE>State
</CODE> directive defines the initial value of
490 the
<VAR>printer-state
</VAR> attribute. The strings
491 <VAR>idle
</VAR> and
<VAR>stopped
</VAR> correspond to the IPP
492 enumeration values
3 and
5, respectively. The
493 <CODE>cupsenable(
8)
</CODE> and
<CODE>cupsdisable(
8)
</CODE>
494 commands set the current state:
</P>
496 <PRE CLASS=
"command">
497 <KBD>/usr/sbin/cupsenable classname
</KBD>
498 <KBD>/usr/sbin/cupsdisable classname
</KBD>
501 <P>This directive must appear inside a
<A
502 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
503 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
507 <H2 CLASS=
"title"><A NAME=
"StateMessage">StateMessage
</A></H2>
511 <PRE CLASS=
"command">
514 StateMessage Class is lonely.
520 <P>The
<CODE>StateMessage
</CODE> directive defines the initial
521 string for the
<VAR>printer-state-message
</VAR> attribute. The
522 following are some example messages:
</P>
524 <PRE CLASS=
"command">
525 StateMessage Connected to host_name...
526 StateMessage Connecting to printer_queue on port port_number...
527 StateMessage Network host host_name is busy; will retry in
30 seconds...
528 StateMessage Class busy; will retry in
10 seconds...
529 StateMessage Class is busy; retrying print job...
530 StateMessage Print file accepted - job ID id_number.
531 StateMessage Waiting for job to complete
534 <P>This directive must appear inside a
<A
535 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
536 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>
540 <H2 CLASS=
"title"><SPAN CLASS=
"info">CUPS
1.2</SPAN><A NAME=
"StateTime">StateTime
</A></H2>
544 <PRE CLASS=
"command">
553 <P>The
<CODE>StateTime
</CODE> directive defines the UNIX time
554 (seconds since Jan
1,
1970) for the last state change of the
555 queue. It is mapped to the
<VAR>printer-state-change-time
</VAR>
558 <P>This directive must appear inside a
<A
559 HREF=
"#Class"><CODE>Class
</CODE></A> or
<A
560 HREF=
"#DefaultClass"><CODE>DefaultClass
</CODE></A>