/usr/share/cups/doc-root/help/ref-classes-conf.html is in cups-server-common 1.7.2-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 | <HTML>
<!-- SECTION: References -->
<HEAD>
<TITLE>classes.conf</TITLE>
<LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css">
</HEAD>
<BODY>
<H1 CLASS="title">classes.conf</H1>
<P>The CUPS scheduler (cupsd) uses the
<VAR>/etc/cups/classes.conf</VAR> file to store the list of
available classes. This file contains only locally defined
classes, not remote classes that are created automatically via
browsing. Each directive is listed on a line by itself followed
by its value. Comments are introduced using the number sign ("#")
character at the beginning of a line.</P>
<P>While the class configuration file consists of plain text and
can be modified using your favorite text editor, you should
normally use the <A HREF="man-lpadmin.html">lpadmin(8)</A>
command, web interface, or any of the available GUIs to manage
your classes instead. If you do choose to edit this file
manually, you will need to stop the scheduler first, make your
changes, and then start the scheduler to make them active.</P>
<H2 CLASS="title"><A NAME="Accepting">Accepting</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
Accepting yes
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>Accepting</CODE> directive defines the initial state
of the <VAR>printer-is-accepting-jobs</VAR> attribute. This state
is also set by the <CODE>accept(8)</CODE> and
<CODE>reject(8)</CODE> commands:</P>
<PRE CLASS="command">
<KBD>/usr/sbin/accept classname
/usr/sbin/reject classname</KBD>
</PRE>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
section.</P>
<H2 CLASS="title"><A NAME="AllowUser">AllowUser</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
AllowUser foo_user
AllowUser @bar_group
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>AllowUser</CODE> directive adds a username or group
name to the <VAR>requesting-user-name-allowed</VAR> attribute
which can be set by the <CODE>lpadmin(8)</CODE> command:</P>
<PRE CLASS="command">
<KBD>/usr/sbin/lpadmin -p classname -u allow:foo_user,@bar_group</KBD>
</PRE>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A> directive.
This directive cannot be used with <A
HREF="#DenyUser"><CODE>DenyUser</CODE></A>.</P>
<H2 CLASS="title"><A NAME="Class">Class</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>Class</CODE> directive begins a class definition.
Classes are added using the <CODE>lpadmin(8)</CODE> command:
<PRE CLASS="command">
<KBD>/usr/sbin/lpadmin -p printername -c classname</KBD>
</PRE>
<H2 CLASS="title"><A NAME="DefaultClass">DefaultClass</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<DefaultClass name>
...
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>DefaultClass</CODE> directive begins a class
definition as the default server destination. The default server
destination can be set using the <CODE>lpadmin(8)</CODE>
command:</P>
<PRE CLASS="command">
<KBD>/usr/sbin/lpadmin -d classname</KBD>
</PRE>
<P>Note that the server default destination settings can be
overridden by the user's default destination settings which are
normally set using the <CODE>lpoptions(1)</CODE> command.</P>
<H2 CLASS="title"><A NAME="DenyUser">DenyUser</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
DenyUser foo_user
DenyUser @bar_group
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>DenyUser</CODE> directive adds a username or group
name to the <VAR>requesting-user-name-denied</VAR> attribute
which can be set by the <CODE>lpadmin(8)</CODE> command:</P>
<PRE CLASS="command">
<KBD>/usr/sbin/lpadmin -p classname -u deny:foo_user,@bar_group</KBD>
</PRE>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A> directive.
This directive cannot be used with <A
HREF="#AllowUser"><CODE>AllowUser</CODE></A></P>
<H2 CLASS="title"><A NAME="Info">Info</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
Info My Class
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>Info</CODE> directive defines the string for the
<VAR>printer-info</VAR> attribute. It is normally set using the
<CODE>lpadmin(8)</CODE> command:</P>
<PRE CLASS="command">
<KBD>/usr/sbin/lpadmin -p classname -D "My Class"</KBD>
</PRE>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
section.</P>
<H2 CLASS="title"><A NAME="JobSheets">JobSheets</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
JobSheets none,standard
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>JobSheets</CODE> directive specifies the default
banner pages to print before and after a print job. In the above
example, only a <VAR>standard</VAR> banner will print after each
job. The <CODE>lpadmin(8)</CODE> command is normally used to set
the default banners:
<PRE CLASS="command">
<KBD>/usr/sbin/lpadmin -p classname -o job-sheets-default=none,standard</KBD>
</PRE>
<P>If only one banner file is specified, it will be printed
before the files in the job. If a second banner file is
specified, it is printed after the files in the job.</P>
<P>The available banner pages depend on the local system
configuration; CUPS includes the following standard banner
files:</P>
<UL>
<LI><CODE>none</CODE> - Do not produce a banner
page.</LI>
<LI><CODE>classified</CODE> - A banner page with a
"classified" label at the top and bottom.</LI>
<LI><CODE>confidential</CODE> - A banner page with a
"confidential" label at the top and bottom.</LI>
<LI><CODE>secret</CODE> - A banner page with a
"secret" label at the top and bottom.</LI>
<LI><CODE>standard</CODE> - A banner page with no label
at the top and bottom.</LI>
<LI><CODE>topsecret</CODE> - A banner page with a
"top secret" label at the top and bottom.</LI>
<LI><CODE>unclassified</CODE> - A banner page with an
"unclassified" label at the top and bottom.</LI>
</UL>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
section.</P>
<H2 CLASS="title"><A NAME="KLimit">KLimit</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
KLimit 1234
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>KLimit</CODE> directive defines the value of the
<VAR>job-k-limit</VAR> attribute. It is normally set using the
<CODE>lpadmin(8)</CODE> command:</P>
<PRE CLASS="command">
<KBD>/usr/sbin/lpadmin -p classname -o job-k-limit=1234</KBD>
</PRE>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
section.</P>
<H2 CLASS="title"><A NAME="Location">Location</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
Location Building 3321
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>Location</CODE> directive defines the string for the
<VAR>printer-location</VAR> attribute. It is normally set using the
<CODE>lpadmin(8)</CODE> command:</P>
<PRE CLASS="command">
<KBD>/usr/sbin/lpadmin -p classname -L "Building 3321"</KBD>
</PRE>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
section.</P>
<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="OpPolicy">OpPolicy</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
OpPolicy default
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>OpPolicy</CODE> directive sets the operation policy
that is used for the printer. The <CODE>lpadmin(8)</CODE> command
sets the current operation policy:</P>
<PRE CLASS="command">
<KBD>/usr/sbin/lpadmin -p classname -o printer-op-policy=default</KBD>
</PRE>
<P>The default policy is named "default". All policies correspond
to those defined using the <VAR>cupsd.conf</VAR> <A
HREF="ref-cupsd-conf.html#Policy"><CODE>Policy</CODE></A>
section.</P>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
section.</P>
<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="Option">Option</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
Option name value
Option scaling 100
Option page-left 72
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>Option</CODE> directive specifies a default job
template attribute value. It is mapped to
<CODE>name-default</CODE> in the printer attributes and applied
to jobs as <CODE>name</CODE>.</P>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
section.</P>
<H2 CLASS="title"><A NAME="PageLimit">PageLimit</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
PageLimit 1234
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>PageLimit</CODE> directive defines the value of the
<VAR>job-page-limit</VAR> attribute. It can be set using the
<CODE>lpadmin(8)</CODE> command:</P>
<PRE CLASS="command">
<KBD>/usr/sbin/lpadmin -p classname -o job-page-limit=1234</KBD>
</PRE>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
section.</P>
<H2 CLASS="title"><A NAME="Printer">Printer</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
Printer foo
Printer bar
Printer bleep
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>Printer</CODE> directive adds a printer to a class.
Printers are added to a class using the <CODE>lpadmin(8)</CODE>
command:</P>
<PRE CLASS="command">
<KBD>/usr/sbin/lpadmin -p printername -c classname</KBD>
</PRE>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
section.</P>
<H2 CLASS="title"><A NAME="QuotaPeriod">QuotaPeriod</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
QuotaPeriod 604800
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>QuotaPeriod</CODE> directive defines the value of
the <VAR>job-quota-period</VAR> attribute. Typical values are
86400 (1 day), 604800 (1 week), 2592000 (1 month), and 31536000
(1 year). It is set using the <CODE>lpadmin(8)</CODE>
command:</P>
<PRE CLASS="command">
<KBD>/usr/sbin/lpadmin -p classname -o job-quota-period=604800</KBD>
</PRE>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
section.</P>
<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="Shared">Shared</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
Shared yes
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>Shared</CODE> directive defines the initial value of
the <VAR>printer-is-shared</VAR> attribute. The strings
<VAR>yes</VAR> and <VAR>no</VAR> correspond to the true and false
values, respectively. The <CODE>lpadmin(8)</CODE> command sets
the current state:</P>
<PRE CLASS="command">
<KBD>/usr/sbin/lpadmin -p classname -o printer-is-shared=true</KBD>
</PRE>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
section.</P>
<H2 CLASS="title"><A NAME="State">State</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
State idle
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>State</CODE> directive defines the initial value of
the <VAR>printer-state</VAR> attribute. The strings
<VAR>idle</VAR> and <VAR>stopped</VAR> correspond to the IPP
enumeration values 3 and 5, respectively. The
<CODE>cupsenable(8)</CODE> and <CODE>cupsdisable(8)</CODE>
commands set the current state:</P>
<PRE CLASS="command">
<KBD>/usr/sbin/cupsenable classname</KBD>
<KBD>/usr/sbin/cupsdisable classname</KBD>
</PRE>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
section.</P>
<H2 CLASS="title"><A NAME="StateMessage">StateMessage</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
StateMessage Class is lonely.
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>StateMessage</CODE> directive defines the initial
string for the <VAR>printer-state-message</VAR> attribute. The
following are some example messages:</P>
<PRE CLASS="command">
StateMessage Connected to host_name...
StateMessage Connecting to printer_queue on port port_number...
StateMessage Network host host_name is busy; will retry in 30 seconds...
StateMessage Class busy; will retry in 10 seconds...
StateMessage Class is busy; retrying print job...
StateMessage Print file accepted - job ID id_number.
StateMessage Waiting for job to complete
</PRE>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
section.</P>
<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="StateTime">StateTime</A></H2>
<H3>Examples</H3>
<PRE CLASS="command">
<Class name>
...
StateTime 1133542425
</Class>
</PRE>
<H3>Description</H3>
<P>The <CODE>StateTime</CODE> directive defines the UNIX time
(seconds since Jan 1, 1970) for the last state change of the
queue. It is mapped to the <VAR>printer-state-change-time</VAR>
attribute.</P>
<P>This directive must appear inside a <A
HREF="#Class"><CODE>Class</CODE></A> or <A
HREF="#DefaultClass"><CODE>DefaultClass</CODE></A>
section.</P>
</BODY>
</HTML>
|