doc/help/ref-classes-conf.html

   1 <HTML>
   2 <!-- SECTION: References -->
   3 <HEAD>
   4         <TITLE>classes.conf</TITLE>
   5 </HEAD>
   6 <BODY>
   7
   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>
  15
  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
  22 active.</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;Class name&gt;
  31   ...
  32   Accepting yes
  33 &lt;/Class&gt;
  34 </PRE>
  35
  36 <H3>Description</H3>
  37
  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>
  42
  43 <PRE CLASS="command">
  44 <KBD>/usr/sbin/accept classname
  45 /usr/sbin/reject classname</KBD>
  46 </PRE>
  47
  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>
  51 section.</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;Class name&gt;
  60   ...
  61   AllowUser foo_user
  62   AllowUser @bar_group
  63 &lt;/Class&gt;
  64 </PRE>
  65
  66 <H3>Description</H3>
  67
  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>
  71
  72 <PRE CLASS="command">
  73 <KBD>/usr/sbin/lpadmin -p classname -u allow:foo_user,@bar_group</KBD>
  74 </PRE>
  75
  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>
  81
  82
  83 <H2 CLASS="title"><A NAME="Class">Class</A></H2>
  84
  85 <H3>Examples</H3>
  86
  87 <PRE CLASS="command">
  88 &lt;Class name&gt;
  89   ...
  90 &lt;/Class&gt;
  91 </PRE>
  92
  93 <H3>Description</H3>
  94
  95 <P>The <CODE>Class</CODE> directive begins a class definition.
  96 Classes are added using the <CODE>lpadmin(8)</CODE> command:
  97
  98 <PRE CLASS="command">
  99 <KBD>/usr/sbin/lpadmin -p printername -c classname</KBD>
 100 </PRE>
 101
 102
 103 <H2 CLASS="title"><A NAME="DefaultClass">DefaultClass</A></H2>
 104
 105 <H3>Examples</H3>
 106
 107 <PRE CLASS="command">
 108 &lt;DefaultClass name&gt;
 109   ...
 110 &lt;/Class&gt;
 111 </PRE>
 112
 113 <H3>Description</H3>
 114
 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>
 118 command:</P>
 119
 120 <PRE CLASS="command">
 121 <KBD>/usr/sbin/lpadmin -d classname</KBD>
 122 </PRE>
 123
 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>
 127
 128
 129 <H2 CLASS="title"><A NAME="DenyUser">DenyUser</A></H2>
 130
 131 <H3>Examples</H3>
 132
 133 <PRE CLASS="command">
 134 &lt;Class name&gt;
 135   ...
 136   DenyUser foo_user
 137   DenyUser @bar_group
 138 &lt;/Class&gt;
 139 </PRE>
 140
 141 <H3>Description</H3>
 142
 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>
 146
 147 <PRE CLASS="command">
 148 <KBD>/usr/sbin/lpadmin -p classname -u deny:foo_user,@bar_group</KBD>
 149 </PRE>
 150
 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>
 156
 157
 158 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="ErrorPolicy">ErrorPolicy</A></H2>
 159
 160 <H3>Examples</H3>
 161
 162 <PRE CLASS="command">
 163 &lt;Class name&gt;
 164   ...
 165   ErrorPolicy abort-job
 166 &lt;/Class&gt;
 167 </PRE>
 168
 169 <H3>Description</H3>
 170
 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
 174 error policy:</P>
 175
 176 <PRE CLASS="command">
 177 <KBD>/usr/sbin/lpadmin -p classname -o printer-error-policy=stop-printer</KBD>
 178 </PRE>
 179
 180 <P>The following values are supported:</P>
 181
 182 <UL>
 183
 184         <LI><CODE>abort-job</CODE> - Abort the job and proceed
 185         with the next job in the queue</LI>
 186
 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>
 191
 192         <LI><CODE>stop-printer</CODE> - Stop the printer and keep
 193         the job for future printing; this is the default
 194         value</LI>
 195
 196 </UL>
 197
 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>
 201 section.</P>
 202
 203
 204 <H2 CLASS="title"><A NAME="Info">Info</A></H2>
 205
 206 <H3>Examples</H3>
 207
 208 <PRE CLASS="command">
 209 &lt;Class name&gt;
 210   ...
 211   Info My Class
 212 &lt;/Class&gt;
 213 </PRE>
 214
 215 <H3>Description</H3>
 216
 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>
 220
 221 <PRE CLASS="command">
 222 <KBD>/usr/sbin/lpadmin -p classname -D "My Class"</KBD>
 223 </PRE>
 224
 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>
 228 section.</P>
 229
 230
 231 <H2 CLASS="title"><A NAME="JobSheets">JobSheets</A></H2>
 232
 233 <H3>Examples</H3>
 234
 235 <PRE CLASS="command">
 236 &lt;Class name&gt;
 237   ...
 238   JobSheets none,standard
 239 &lt;/Class&gt;
 240 </PRE>
 241
 242 <H3>Description</H3>
 243
 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
 248 the default banners:
 249
 250 <PRE CLASS="command">
 251 <KBD>/usr/sbin/lpadmin -p classname -o job-sheets-default=none,standard</KBD>
 252 </PRE>
 253
 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>
 257
 258 <P>The available banner pages depend on the local system
 259 configuration; CUPS includes the following standard banner
 260 files:</P>
 261
 262 <UL>
 263
 264         <LI><CODE>none</CODE> - Do not produce a banner
 265         page.</LI>
 266
 267         <LI><CODE>classified</CODE> - A banner page with a
 268         &quot;classified&quot; label at the top and bottom.</LI>
 269
 270         <LI><CODE>confidential</CODE> - A banner page with a
 271         &quot;confidential&quot; label at the top and bottom.</LI>
 272
 273         <LI><CODE>secret</CODE> - A banner page with a
 274         &quot;secret&quot; label at the top and bottom.</LI>
 275
 276         <LI><CODE>standard</CODE> - A banner page with no label
 277         at the top and bottom.</LI>
 278
 279         <LI><CODE>topsecret</CODE> - A banner page with a
 280         &quot;top secret&quot; label at the top and bottom.</LI>
 281
 282         <LI><CODE>unclassified</CODE> - A banner page with an
 283         &quot;unclassified&quot; label at the top and bottom.</LI>
 284
 285 </UL>
 286
 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>
 290 section.</P>
 291
 292
 293 <H2 CLASS="title"><A NAME="KLimit">KLimit</A></H2>
 294
 295 <H3>Examples</H3>
 296
 297 <PRE CLASS="command">
 298 &lt;Class name&gt;
 299   ...
 300   KLimit 1234
 301 &lt;/Class&gt;
 302 </PRE>
 303
 304 <H3>Description</H3>
 305
 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>
 309
 310 <PRE CLASS="command">
 311 <KBD>/usr/sbin/lpadmin -p classname -o job-k-limit=1234</KBD>
 312 </PRE>
 313
 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>
 317 section.</P>
 318
 319
 320 <H2 CLASS="title"><A NAME="Location">Location</A></H2>
 321
 322 <H3>Examples</H3>
 323
 324 <PRE CLASS="command">
 325 &lt;Class name&gt;
 326   ...
 327   Location Building 3321
 328 &lt;/Class&gt;
 329 </PRE>
 330
 331 <H3>Description</H3>
 332
 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>
 336
 337 <PRE CLASS="command">
 338 <KBD>/usr/sbin/lpadmin -p classname -L "Building 3321"</KBD>
 339 </PRE>
 340
 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>
 344 section.</P>
 345
 346
 347 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="OpPolicy">OpPolicy</A></H2>
 348
 349 <H3>Examples</H3>
 350
 351 <PRE CLASS="command">
 352 &lt;Class name&gt;
 353   ...
 354   OpPolicy default
 355 &lt;/Class&gt;
 356 </PRE>
 357
 358 <H3>Description</H3>
 359
 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>
 363
 364 <PRE CLASS="command">
 365 <KBD>/usr/sbin/lpadmin -p classname -o printer-op-policy=default</KBD>
 366 </PRE>
 367
 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>
 371 section.</P>
 372
 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>
 376 section.</P>
 377
 378
 379 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="Option">Option</A></H2>
 380
 381 <H3>Examples</H3>
 382
 383 <PRE CLASS="command">
 384 &lt;Class name&gt;
 385   ...
 386   Option name value
 387   Option scaling 100
 388   Option page-left 72
 389 &lt;/Class&gt;
 390 </PRE>
 391
 392 <H3>Description</H3>
 393
 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>
 398
 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>
 402 section.</P>
 403
 404
 405 <H2 CLASS="title"><A NAME="PageLimit">PageLimit</A></H2>
 406
 407 <H3>Examples</H3>
 408
 409 <PRE CLASS="command">
 410 &lt;Class name&gt;
 411   ...
 412   PageLimit 1234
 413 &lt;/Class&gt;
 414 </PRE>
 415
 416 <H3>Description</H3>
 417
 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>
 421
 422 <PRE CLASS="command">
 423 <KBD>/usr/sbin/lpadmin -p classname -o job-page-limit=1234</KBD>
 424 </PRE>
 425
 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>
 429 section.</P>
 430
 431
 432 <H2 CLASS="title"><A NAME="Printer">Printer</A></H2>
 433
 434 <H3>Examples</H3>
 435
 436 <PRE CLASS="command">
 437 &lt;Class name&gt;
 438   ...
 439   Printer foo
 440   Printer bar
 441   Printer bleep
 442 &lt;/Class&gt;
 443 </PRE>
 444
 445 <H3>Description</H3>
 446
 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>
 449 command:</P>
 450
 451 <PRE CLASS="command">
 452 <KBD>/usr/sbin/lpadmin -p printername -c classname</KBD>
 453 </PRE>
 454
 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>
 458 section.</P>
 459
 460
 461 <H2 CLASS="title"><A NAME="QuotaPeriod">QuotaPeriod</A></H2>
 462
 463 <H3>Examples</H3>
 464
 465 <PRE CLASS="command">
 466 &lt;Class name&gt;
 467   ...
 468   QuotaPeriod 604800
 469 &lt;/Class&gt;
 470 </PRE>
 471
 472 <H3>Description</H3>
 473
 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>
 478 command:</P>
 479
 480 <PRE CLASS="command">
 481 <KBD>/usr/sbin/lpadmin -p classname -o job-quota-period=604800</KBD>
 482 </PRE>
 483
 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>
 487 section.</P>
 488
 489
 490 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="Shared">Shared</A></H2>
 491
 492 <H3>Examples</H3>
 493
 494 <PRE CLASS="command">
 495 &lt;Class name&gt;
 496   ...
 497   Shared yes
 498 &lt;/Class&gt;
 499 </PRE>
 500
 501 <H3>Description</H3>
 502
 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>
 508
 509 <PRE CLASS="command">
 510 <KBD>/usr/sbin/lpadmin -p classname -o printer-is-shared=true</KBD>
 511 </PRE>
 512
 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>
 516 section.</P>
 517
 518
 519 <H2 CLASS="title"><A NAME="State">State</A></H2>
 520
 521 <H3>Examples</H3>
 522
 523 <PRE CLASS="command">
 524 &lt;Class name&gt;
 525   ...
 526   State idle
 527 &lt;/Class&gt;
 528 </PRE>
 529
 530 <H3>Description</H3>
 531
 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>
 538
 539 <PRE CLASS="command">
 540 <KBD>/usr/sbin/cupsenable classname</KBD>
 541 <KBD>/usr/sbin/cupsdisable classname</KBD>
 542 </PRE>
 543
 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>
 547 section.</P>
 548
 549
 550 <H2 CLASS="title"><A NAME="StateMessage">StateMessage</A></H2>
 551
 552 <H3>Examples</H3>
 553
 554 <PRE CLASS="command">
 555 &lt;Class name&gt;
 556   ...
 557   StateMessage Ready to print.
 558 &lt;/Class&gt;
 559 </PRE>
 560
 561 <H3>Description</H3>
 562
 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>
 566
 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
 576 </PRE>
 577
 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>
 581 section.</P>
 582
 583
 584 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="StateTime">StateTime</A></H2>
 585
 586 <H3>Examples</H3>
 587
 588 <PRE CLASS="command">
 589 &lt;Class name&gt;
 590   ...
 591   StateTime 1133542425
 592 &lt;/Class&gt;
 593 </PRE>
 594
 595 <H3>Description</H3>
 596
 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>
 600 attribute.</P>
 601
 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>
 605 section.</P>
 606
 607
 608 </BODY>
 609 </HTML>