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"><A NAME="Info">Info</A></H2>
 159
 160 <H3>Examples</H3>
 161
 162 <PRE CLASS="command">
 163 &lt;Class name&gt;
 164   ...
 165   Info My Class
 166 &lt;/Class&gt;
 167 </PRE>
 168
 169 <H3>Description</H3>
 170
 171 <P>The <CODE>Info</CODE> directive defines the string for the
 172 <VAR>printer-info</VAR> attribute. It is normally set using the
 173 <CODE>lpadmin(8)</CODE> command:</P>
 174
 175 <PRE CLASS="command">
 176 <KBD>/usr/sbin/lpadmin -p classname -D "My Class"</KBD>
 177 </PRE>
 178
 179 <P>This directive must appear inside a <A
 180 HREF="#Class"><CODE>Class</CODE></A> or <A
 181 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 182 section.</P>
 183
 184
 185 <H2 CLASS="title"><A NAME="JobSheets">JobSheets</A></H2>
 186
 187 <H3>Examples</H3>
 188
 189 <PRE CLASS="command">
 190 &lt;Class name&gt;
 191   ...
 192   JobSheets none,standard
 193 &lt;/Class&gt;
 194 </PRE>
 195
 196 <H3>Description</H3>
 197
 198 <P>The <CODE>JobSheets</CODE> directive specifies the default
 199 banner pages  to print before and after a print job. In the above
 200 example, only a <VAR>standard</VAR> banner will print after each
 201 job. The <CODE>lpadmin(8)</CODE> command is normally used to set
 202 the default banners:
 203
 204 <PRE CLASS="command">
 205 <KBD>/usr/sbin/lpadmin -p classname -o job-sheets-default=none,standard</KBD>
 206 </PRE>
 207
 208 <P>If only one banner file is specified, it will be printed
 209 before the files in the job. If a second banner file is
 210 specified, it is printed  after the files in the job.</P>
 211
 212 <P>The available banner pages depend on the local system
 213 configuration; CUPS includes the following standard banner
 214 files:</P>
 215
 216 <UL>
 217
 218         <LI><CODE>none</CODE> - Do not produce a banner
 219         page.</LI>
 220
 221         <LI><CODE>classified</CODE> - A banner page with a
 222         &quot;classified&quot; label at the top and bottom.</LI>
 223
 224         <LI><CODE>confidential</CODE> - A banner page with a
 225         &quot;confidential&quot; label at the top and bottom.</LI>
 226
 227         <LI><CODE>secret</CODE> - A banner page with a
 228         &quot;secret&quot; label at the top and bottom.</LI>
 229
 230         <LI><CODE>standard</CODE> - A banner page with no label
 231         at the top and bottom.</LI>
 232
 233         <LI><CODE>topsecret</CODE> - A banner page with a
 234         &quot;top secret&quot; label at the top and bottom.</LI>
 235
 236         <LI><CODE>unclassified</CODE> - A banner page with an
 237         &quot;unclassified&quot; label at the top and bottom.</LI>
 238
 239 </UL>
 240
 241 <P>This directive must appear inside a <A
 242 HREF="#Class"><CODE>Class</CODE></A> or <A
 243 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 244 section.</P>
 245
 246
 247 <H2 CLASS="title"><A NAME="KLimit">KLimit</A></H2>
 248
 249 <H3>Examples</H3>
 250
 251 <PRE CLASS="command">
 252 &lt;Class name&gt;
 253   ...
 254   KLimit 1234
 255 &lt;/Class&gt;
 256 </PRE>
 257
 258 <H3>Description</H3>
 259
 260 <P>The <CODE>KLimit</CODE> directive defines the value of the
 261 <VAR>job-k-limit</VAR> attribute. It is normally set using the
 262 <CODE>lpadmin(8)</CODE> command:</P>
 263
 264 <PRE CLASS="command">
 265 <KBD>/usr/sbin/lpadmin -p classname -o job-k-limit=1234</KBD>
 266 </PRE>
 267
 268 <P>This directive must appear inside a <A
 269 HREF="#Class"><CODE>Class</CODE></A> or <A
 270 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 271 section.</P>
 272
 273
 274 <H2 CLASS="title"><A NAME="Location">Location</A></H2>
 275
 276 <H3>Examples</H3>
 277
 278 <PRE CLASS="command">
 279 &lt;Class name&gt;
 280   ...
 281   Location Building 3321
 282 &lt;/Class&gt;
 283 </PRE>
 284
 285 <H3>Description</H3>
 286
 287 <P>The <CODE>Location</CODE> directive defines the string for the
 288 <VAR>printer-location</VAR> attribute. It is normally set using the
 289 <CODE>lpadmin(8)</CODE> command:</P>
 290
 291 <PRE CLASS="command">
 292 <KBD>/usr/sbin/lpadmin -p classname -L "Building 3321"</KBD>
 293 </PRE>
 294
 295 <P>This directive must appear inside a <A
 296 HREF="#Class"><CODE>Class</CODE></A> or <A
 297 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 298 section.</P>
 299
 300
 301 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="OpPolicy">OpPolicy</A></H2>
 302
 303 <H3>Examples</H3>
 304
 305 <PRE CLASS="command">
 306 &lt;Class name&gt;
 307   ...
 308   OpPolicy default
 309 &lt;/Class&gt;
 310 </PRE>
 311
 312 <H3>Description</H3>
 313
 314 <P>The <CODE>OpPolicy</CODE> directive sets the operation policy
 315 that is used for the printer. The <CODE>lpadmin(8)</CODE> command
 316 sets the current operation policy:</P>
 317
 318 <PRE CLASS="command">
 319 <KBD>/usr/sbin/lpadmin -p classname -o printer-op-policy=default</KBD>
 320 </PRE>
 321
 322 <P>The default policy is named "default". All policies correspond
 323 to those defined using the <VAR>cupsd.conf</VAR> <A
 324 HREF="ref-cupsd-conf.html#Policy"><CODE>Policy</CODE></A>
 325 section.</P>
 326
 327 <P>This directive must appear inside a <A
 328 HREF="#Class"><CODE>Class</CODE></A> or <A
 329 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 330 section.</P>
 331
 332
 333 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="Option">Option</A></H2>
 334
 335 <H3>Examples</H3>
 336
 337 <PRE CLASS="command">
 338 &lt;Class name&gt;
 339   ...
 340   Option name value
 341   Option scaling 100
 342   Option page-left 72
 343 &lt;/Class&gt;
 344 </PRE>
 345
 346 <H3>Description</H3>
 347
 348 <P>The <CODE>Option</CODE> directive specifies a default job
 349 template attribute value. It is mapped to
 350 <CODE>name-default</CODE> in the printer attributes and applied
 351 to jobs as <CODE>name</CODE>.</P>
 352
 353 <P>This directive must appear inside a <A
 354 HREF="#Class"><CODE>Class</CODE></A> or <A
 355 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 356 section.</P>
 357
 358
 359 <H2 CLASS="title"><A NAME="PageLimit">PageLimit</A></H2>
 360
 361 <H3>Examples</H3>
 362
 363 <PRE CLASS="command">
 364 &lt;Class name&gt;
 365   ...
 366   PageLimit 1234
 367 &lt;/Class&gt;
 368 </PRE>
 369
 370 <H3>Description</H3>
 371
 372 <P>The <CODE>PageLimit</CODE> directive defines the value of the
 373 <VAR>job-page-limit</VAR> attribute. It can be set using the
 374 <CODE>lpadmin(8)</CODE> command:</P>
 375
 376 <PRE CLASS="command">
 377 <KBD>/usr/sbin/lpadmin -p classname -o job-page-limit=1234</KBD>
 378 </PRE>
 379
 380 <P>This directive must appear inside a <A
 381 HREF="#Class"><CODE>Class</CODE></A> or <A
 382 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 383 section.</P>
 384
 385
 386 <H2 CLASS="title"><A NAME="Printer">Printer</A></H2>
 387
 388 <H3>Examples</H3>
 389
 390 <PRE CLASS="command">
 391 &lt;Class name&gt;
 392   ...
 393   Printer foo
 394   Printer bar
 395   Printer bleep
 396 &lt;/Class&gt;
 397 </PRE>
 398
 399 <H3>Description</H3>
 400
 401 <P>The <CODE>Printer</CODE> directive adds a printer to a class.
 402 Printers are added to a class using the <CODE>lpadmin(8)</CODE>
 403 command:</P>
 404
 405 <PRE CLASS="command">
 406 <KBD>/usr/sbin/lpadmin -p printername -c classname</KBD>
 407 </PRE>
 408
 409 <P>This directive must appear inside a <A
 410 HREF="#Class"><CODE>Class</CODE></A> or <A
 411 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 412 section.</P>
 413
 414
 415 <H2 CLASS="title"><A NAME="QuotaPeriod">QuotaPeriod</A></H2>
 416
 417 <H3>Examples</H3>
 418
 419 <PRE CLASS="command">
 420 &lt;Class name&gt;
 421   ...
 422   QuotaPeriod 604800
 423 &lt;/Class&gt;
 424 </PRE>
 425
 426 <H3>Description</H3>
 427
 428 <P>The <CODE>QuotaPeriod</CODE> directive defines the value of
 429 the  <VAR>job-quota-period</VAR> attribute. Typical values are
 430 86400 (1 day), 604800 (1 week), 2592000 (1 month), and 31536000
 431 (1 year). It is set using the <CODE>lpadmin(8)</CODE>
 432 command:</P>
 433
 434 <PRE CLASS="command">
 435 <KBD>/usr/sbin/lpadmin -p classname -o job-quota-period=604800</KBD>
 436 </PRE>
 437
 438 <P>This directive must appear inside a <A
 439 HREF="#Class"><CODE>Class</CODE></A> or <A
 440 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 441 section.</P>
 442
 443
 444 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="Shared">Shared</A></H2>
 445
 446 <H3>Examples</H3>
 447
 448 <PRE CLASS="command">
 449 &lt;Class name&gt;
 450   ...
 451   Shared yes
 452 &lt;/Class&gt;
 453 </PRE>
 454
 455 <H3>Description</H3>
 456
 457 <P>The <CODE>Shared</CODE> directive defines the initial value of
 458 the <VAR>printer-is-shared</VAR> attribute. The strings
 459 <VAR>yes</VAR> and <VAR>no</VAR> correspond to the true and false
 460 values, respectively. The <CODE>lpadmin(8)</CODE> command sets
 461 the current state:</P>
 462
 463 <PRE CLASS="command">
 464 <KBD>/usr/sbin/lpadmin -p classname -o printer-is-shared=true</KBD>
 465 </PRE>
 466
 467 <P>This directive must appear inside a <A
 468 HREF="#Class"><CODE>Class</CODE></A> or <A
 469 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 470 section.</P>
 471
 472
 473 <H2 CLASS="title"><A NAME="State">State</A></H2>
 474
 475 <H3>Examples</H3>
 476
 477 <PRE CLASS="command">
 478 &lt;Class name&gt;
 479   ...
 480   State idle
 481 &lt;/Class&gt;
 482 </PRE>
 483
 484 <H3>Description</H3>
 485
 486 <P>The <CODE>State</CODE> directive defines the initial value of
 487 the <VAR>printer-state</VAR> attribute. The strings
 488 <VAR>idle</VAR> and <VAR>stopped</VAR> correspond to the IPP
 489 enumeration values 3 and 5, respectively. The
 490 <CODE>cupsenable(8)</CODE> and <CODE>cupsdisable(8)</CODE>
 491 commands set the current state:</P>
 492
 493 <PRE CLASS="command">
 494 <KBD>/usr/sbin/cupsenable classname</KBD>
 495 <KBD>/usr/sbin/cupsdisable classname</KBD>
 496 </PRE>
 497
 498 <P>This directive must appear inside a <A
 499 HREF="#Class"><CODE>Class</CODE></A> or <A
 500 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 501 section.</P>
 502
 503
 504 <H2 CLASS="title"><A NAME="StateMessage">StateMessage</A></H2>
 505
 506 <H3>Examples</H3>
 507
 508 <PRE CLASS="command">
 509 &lt;Class name&gt;
 510   ...
 511   StateMessage Ready to print.
 512 &lt;/Class&gt;
 513 </PRE>
 514
 515 <H3>Description</H3>
 516
 517 <P>The <CODE>StateMessage</CODE> directive defines the initial
 518 string for the  <VAR>printer-state-message</VAR> attribute. The
 519 following are some example messages:</P>
 520
 521 <PRE CLASS="command">
 522 StateMessage Connected to host_name...
 523 StateMessage Connecting to printer_queue on port port_number...
 524 StateMessage Network host host_name is busy; will retry in 30 seconds...
 525 StateMessage Class busy; will retry in 10 seconds...
 526 StateMessage Class is busy; retrying print job...
 527 StateMessage Print file accepted - job ID id_number.
 528 StateMessage Ready to print.
 529 StateMessage Waiting for job to complete
 530 </PRE>
 531
 532 <P>This directive must appear inside a <A
 533 HREF="#Class"><CODE>Class</CODE></A> or <A
 534 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 535 section.</P>
 536
 537
 538 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="StateTime">StateTime</A></H2>
 539
 540 <H3>Examples</H3>
 541
 542 <PRE CLASS="command">
 543 &lt;Class name&gt;
 544   ...
 545   StateTime 1133542425
 546 &lt;/Class&gt;
 547 </PRE>
 548
 549 <H3>Description</H3>
 550
 551 <P>The <CODE>StateTime</CODE> directive defines the UNIX time
 552 (seconds since Jan 1, 1970) for the last state change of the
 553 queue. It is mapped to the <VAR>printer-state-change-time</VAR>
 554 attribute.</P>
 555
 556 <P>This directive must appear inside a <A
 557 HREF="#Class"><CODE>Class</CODE></A> or <A
 558 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 559 section.</P>
 560
 561
 562 </BODY>
 563 </HTML>