doc/help/ref-classes-conf.html

   1 <HTML>
   2 <!-- SECTION: References -->
   3 <HEAD>
   4         <TITLE>classes.conf</TITLE>
   5         <LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css">
   6 </HEAD>
   7 <BODY>
   8
   9 <H1 CLASS="title">classes.conf</H1>
  10
  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>
  18
  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 restart the scheduler to make them
  25 active.</P>
  26
  27
  28 <H2 CLASS="title"><A NAME="Accepting">Accepting</A></H2>
  29
  30 <H3>Examples</H3>
  31
  32 <PRE CLASS="command">
  33 &lt;Class name&gt;
  34   ...
  35   Accepting yes
  36 &lt;/Class&gt;
  37 </PRE>
  38
  39 <H3>Description</H3>
  40
  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>
  45
  46 <PRE CLASS="command">
  47 <KBD>/usr/sbin/accept classname
  48 /usr/sbin/reject classname</KBD>
  49 </PRE>
  50
  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>
  54 section.</P>
  55
  56
  57 <H2 CLASS="title"><A NAME="AllowUser">AllowUser</A></H2>
  58
  59 <H3>Examples</H3>
  60
  61 <PRE CLASS="command">
  62 &lt;Class name&gt;
  63   ...
  64   AllowUser foo_user
  65   AllowUser @bar_group
  66 &lt;/Class&gt;
  67 </PRE>
  68
  69 <H3>Description</H3>
  70
  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>
  74
  75 <PRE CLASS="command">
  76 <KBD>/usr/sbin/lpadmin -p classname -u allow:foo_user,@bar_group</KBD>
  77 </PRE>
  78
  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>
  84
  85
  86 <H2 CLASS="title"><A NAME="Class">Class</A></H2>
  87
  88 <H3>Examples</H3>
  89
  90 <PRE CLASS="command">
  91 &lt;Class name&gt;
  92   ...
  93 &lt;/Class&gt;
  94 </PRE>
  95
  96 <H3>Description</H3>
  97
  98 <P>The <CODE>Class</CODE> directive begins a class definition.
  99 Classes are added using the <CODE>lpadmin(8)</CODE> command:
 100
 101 <PRE CLASS="command">
 102 <KBD>/usr/sbin/lpadmin -p printername -c classname</KBD>
 103 </PRE>
 104
 105
 106 <H2 CLASS="title"><A NAME="DefaultClass">DefaultClass</A></H2>
 107
 108 <H3>Examples</H3>
 109
 110 <PRE CLASS="command">
 111 &lt;DefaultClass name&gt;
 112   ...
 113 &lt;/Class&gt;
 114 </PRE>
 115
 116 <H3>Description</H3>
 117
 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>
 121 command:</P>
 122
 123 <PRE CLASS="command">
 124 <KBD>/usr/sbin/lpadmin -d classname</KBD>
 125 </PRE>
 126
 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>
 130
 131
 132 <H2 CLASS="title"><A NAME="DenyUser">DenyUser</A></H2>
 133
 134 <H3>Examples</H3>
 135
 136 <PRE CLASS="command">
 137 &lt;Class name&gt;
 138   ...
 139   DenyUser foo_user
 140   DenyUser @bar_group
 141 &lt;/Class&gt;
 142 </PRE>
 143
 144 <H3>Description</H3>
 145
 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>
 149
 150 <PRE CLASS="command">
 151 <KBD>/usr/sbin/lpadmin -p classname -u deny:foo_user,@bar_group</KBD>
 152 </PRE>
 153
 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>
 159
 160
 161 <H2 CLASS="title"><A NAME="Info">Info</A></H2>
 162
 163 <H3>Examples</H3>
 164
 165 <PRE CLASS="command">
 166 &lt;Class name&gt;
 167   ...
 168   Info My Class
 169 &lt;/Class&gt;
 170 </PRE>
 171
 172 <H3>Description</H3>
 173
 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>
 177
 178 <PRE CLASS="command">
 179 <KBD>/usr/sbin/lpadmin -p classname -D "My Class"</KBD>
 180 </PRE>
 181
 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>
 185 section.</P>
 186
 187
 188 <H2 CLASS="title"><A NAME="JobSheets">JobSheets</A></H2>
 189
 190 <H3>Examples</H3>
 191
 192 <PRE CLASS="command">
 193 &lt;Class name&gt;
 194   ...
 195   JobSheets none,standard
 196 &lt;/Class&gt;
 197 </PRE>
 198
 199 <H3>Description</H3>
 200
 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
 205 the default banners:
 206
 207 <PRE CLASS="command">
 208 <KBD>/usr/sbin/lpadmin -p classname -o job-sheets-default=none,standard</KBD>
 209 </PRE>
 210
 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>
 214
 215 <P>The available banner pages depend on the local system
 216 configuration; CUPS includes the following standard banner
 217 files:</P>
 218
 219 <UL>
 220
 221         <LI><CODE>none</CODE> - Do not produce a banner
 222         page.</LI>
 223
 224         <LI><CODE>classified</CODE> - A banner page with a
 225         &quot;classified&quot; label at the top and bottom.</LI>
 226
 227         <LI><CODE>confidential</CODE> - A banner page with a
 228         &quot;confidential&quot; label at the top and bottom.</LI>
 229
 230         <LI><CODE>secret</CODE> - A banner page with a
 231         &quot;secret&quot; label at the top and bottom.</LI>
 232
 233         <LI><CODE>standard</CODE> - A banner page with no label
 234         at the top and bottom.</LI>
 235
 236         <LI><CODE>topsecret</CODE> - A banner page with a
 237         &quot;top secret&quot; label at the top and bottom.</LI>
 238
 239         <LI><CODE>unclassified</CODE> - A banner page with an
 240         &quot;unclassified&quot; label at the top and bottom.</LI>
 241
 242 </UL>
 243
 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>
 247 section.</P>
 248
 249
 250 <H2 CLASS="title"><A NAME="KLimit">KLimit</A></H2>
 251
 252 <H3>Examples</H3>
 253
 254 <PRE CLASS="command">
 255 &lt;Class name&gt;
 256   ...
 257   KLimit 1234
 258 &lt;/Class&gt;
 259 </PRE>
 260
 261 <H3>Description</H3>
 262
 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>
 266
 267 <PRE CLASS="command">
 268 <KBD>/usr/sbin/lpadmin -p classname -o job-k-limit=1234</KBD>
 269 </PRE>
 270
 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>
 274 section.</P>
 275
 276
 277 <H2 CLASS="title"><A NAME="Location">Location</A></H2>
 278
 279 <H3>Examples</H3>
 280
 281 <PRE CLASS="command">
 282 &lt;Class name&gt;
 283   ...
 284   Location Building 3321
 285 &lt;/Class&gt;
 286 </PRE>
 287
 288 <H3>Description</H3>
 289
 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>
 293
 294 <PRE CLASS="command">
 295 <KBD>/usr/sbin/lpadmin -p classname -L "Building 3321"</KBD>
 296 </PRE>
 297
 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>
 301 section.</P>
 302
 303
 304 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="OpPolicy">OpPolicy</A></H2>
 305
 306 <H3>Examples</H3>
 307
 308 <PRE CLASS="command">
 309 &lt;Class name&gt;
 310   ...
 311   OpPolicy default
 312 &lt;/Class&gt;
 313 </PRE>
 314
 315 <H3>Description</H3>
 316
 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>
 320
 321 <PRE CLASS="command">
 322 <KBD>/usr/sbin/lpadmin -p classname -o printer-op-policy=default</KBD>
 323 </PRE>
 324
 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>
 328 section.</P>
 329
 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>
 333 section.</P>
 334
 335
 336 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="Option">Option</A></H2>
 337
 338 <H3>Examples</H3>
 339
 340 <PRE CLASS="command">
 341 &lt;Class name&gt;
 342   ...
 343   Option name value
 344   Option scaling 100
 345   Option page-left 72
 346 &lt;/Class&gt;
 347 </PRE>
 348
 349 <H3>Description</H3>
 350
 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>
 355
 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>
 359 section.</P>
 360
 361
 362 <H2 CLASS="title"><A NAME="PageLimit">PageLimit</A></H2>
 363
 364 <H3>Examples</H3>
 365
 366 <PRE CLASS="command">
 367 &lt;Class name&gt;
 368   ...
 369   PageLimit 1234
 370 &lt;/Class&gt;
 371 </PRE>
 372
 373 <H3>Description</H3>
 374
 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>
 378
 379 <PRE CLASS="command">
 380 <KBD>/usr/sbin/lpadmin -p classname -o job-page-limit=1234</KBD>
 381 </PRE>
 382
 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>
 386 section.</P>
 387
 388
 389 <H2 CLASS="title"><A NAME="Printer">Printer</A></H2>
 390
 391 <H3>Examples</H3>
 392
 393 <PRE CLASS="command">
 394 &lt;Class name&gt;
 395   ...
 396   Printer foo
 397   Printer bar
 398   Printer bleep
 399 &lt;/Class&gt;
 400 </PRE>
 401
 402 <H3>Description</H3>
 403
 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>
 406 command:</P>
 407
 408 <PRE CLASS="command">
 409 <KBD>/usr/sbin/lpadmin -p printername -c classname</KBD>
 410 </PRE>
 411
 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>
 415 section.</P>
 416
 417
 418 <H2 CLASS="title"><A NAME="QuotaPeriod">QuotaPeriod</A></H2>
 419
 420 <H3>Examples</H3>
 421
 422 <PRE CLASS="command">
 423 &lt;Class name&gt;
 424   ...
 425   QuotaPeriod 604800
 426 &lt;/Class&gt;
 427 </PRE>
 428
 429 <H3>Description</H3>
 430
 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>
 435 command:</P>
 436
 437 <PRE CLASS="command">
 438 <KBD>/usr/sbin/lpadmin -p classname -o job-quota-period=604800</KBD>
 439 </PRE>
 440
 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>
 444 section.</P>
 445
 446
 447 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="Shared">Shared</A></H2>
 448
 449 <H3>Examples</H3>
 450
 451 <PRE CLASS="command">
 452 &lt;Class name&gt;
 453   ...
 454   Shared yes
 455 &lt;/Class&gt;
 456 </PRE>
 457
 458 <H3>Description</H3>
 459
 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>
 465
 466 <PRE CLASS="command">
 467 <KBD>/usr/sbin/lpadmin -p classname -o printer-is-shared=true</KBD>
 468 </PRE>
 469
 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>
 473 section.</P>
 474
 475
 476 <H2 CLASS="title"><A NAME="State">State</A></H2>
 477
 478 <H3>Examples</H3>
 479
 480 <PRE CLASS="command">
 481 &lt;Class name&gt;
 482   ...
 483   State idle
 484 &lt;/Class&gt;
 485 </PRE>
 486
 487 <H3>Description</H3>
 488
 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>
 495
 496 <PRE CLASS="command">
 497 <KBD>/usr/sbin/cupsenable classname</KBD>
 498 <KBD>/usr/sbin/cupsdisable classname</KBD>
 499 </PRE>
 500
 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>
 504 section.</P>
 505
 506
 507 <H2 CLASS="title"><A NAME="StateMessage">StateMessage</A></H2>
 508
 509 <H3>Examples</H3>
 510
 511 <PRE CLASS="command">
 512 &lt;Class name&gt;
 513   ...
 514   StateMessage Ready to print.
 515 &lt;/Class&gt;
 516 </PRE>
 517
 518 <H3>Description</H3>
 519
 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>
 523
 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 Ready to print.
 532 StateMessage Waiting for job to complete
 533 </PRE>
 534
 535 <P>This directive must appear inside a <A
 536 HREF="#Class"><CODE>Class</CODE></A> or <A
 537 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 538 section.</P>
 539
 540
 541 <H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="StateTime">StateTime</A></H2>
 542
 543 <H3>Examples</H3>
 544
 545 <PRE CLASS="command">
 546 &lt;Class name&gt;
 547   ...
 548   StateTime 1133542425
 549 &lt;/Class&gt;
 550 </PRE>
 551
 552 <H3>Description</H3>
 553
 554 <P>The <CODE>StateTime</CODE> directive defines the UNIX time
 555 (seconds since Jan 1, 1970) for the last state change of the
 556 queue. It is mapped to the <VAR>printer-state-change-time</VAR>
 557 attribute.</P>
 558
 559 <P>This directive must appear inside a <A
 560 HREF="#Class"><CODE>Class</CODE></A> or <A
 561 HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
 562 section.</P>
 563
 564
 565 </BODY>
 566 </HTML>