[thirdparty/cups.git] / doc / help / ref-classes-conf.html

<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">
&lt;Class name&gt;
  ...
  Accepting yes
&lt;/Class&gt;
</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">
&lt;Class name&gt;
  ...
  AllowUser foo_user
  AllowUser @bar_group
&lt;/Class&gt;
</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">
&lt;Class name&gt;
  ...
&lt;/Class&gt;
</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">
&lt;DefaultClass name&gt;
  ...
&lt;/Class&gt;
</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">
&lt;Class name&gt;
  ...
  DenyUser foo_user
  DenyUser @bar_group
&lt;/Class&gt;
</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">
&lt;Class name&gt;
  ...
  Info My Class
&lt;/Class&gt;
</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">
&lt;Class name&gt;
  ...
  JobSheets none,standard
&lt;/Class&gt;
</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
	&quot;classified&quot; label at the top and bottom.</LI>

	<LI><CODE>confidential</CODE> - A banner page with a
	&quot;confidential&quot; label at the top and bottom.</LI>

	<LI><CODE>secret</CODE> - A banner page with a
	&quot;secret&quot; 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
	&quot;top secret&quot; label at the top and bottom.</LI>

	<LI><CODE>unclassified</CODE> - A banner page with an
	&quot;unclassified&quot; 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">
&lt;Class name&gt;
  ...
  KLimit 1234
&lt;/Class&gt;
</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">
&lt;Class name&gt;
  ...
  Location Building 3321
&lt;/Class&gt;
</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">
&lt;Class name&gt;
  ...
  OpPolicy default
&lt;/Class&gt;
</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">
&lt;Class name&gt;
  ...
  Option name value
  Option scaling 100
  Option page-left 72
&lt;/Class&gt;
</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">
&lt;Class name&gt;
  ...
  PageLimit 1234
&lt;/Class&gt;
</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">
&lt;Class name&gt;
  ...
  Printer foo
  Printer bar
  Printer bleep
&lt;/Class&gt;
</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">
&lt;Class name&gt;
  ...
  QuotaPeriod 604800
&lt;/Class&gt;
</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">
&lt;Class name&gt;
  ...
  Shared yes
&lt;/Class&gt;
</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">
&lt;Class name&gt;
  ...
  State idle
&lt;/Class&gt;
</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">
&lt;Class name&gt;
  ...
  StateMessage Ready to print.
&lt;/Class&gt;
</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 Ready to print.
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">
&lt;Class name&gt;
  ...
  StateTime 1133542425
&lt;/Class&gt;
</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>
Commit	Line	Data
ef416fc2	1	<HTML>
	2	<!-- SECTION: References -->
	3	<HEAD>
	4	<TITLE>classes.conf</TITLE>
178cb736	5	<LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css">
ef416fc2	6	</HEAD>
	7	<BODY>
	8
178cb736 MS	9	<H1 CLASS="title">classes.conf</H1>
178cb736 MS	10
ef416fc2	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
480ef0fe	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
b226ab99 MS	24	manually, you will need to stop the scheduler first, make your
b226ab99 MS	25	changes, and then start the scheduler to make them active.</P>
ef416fc2	26
ef416fc2	27
480ef0fe	28	<H2 CLASS="title"><A NAME="Accepting">Accepting</A></H2>
ef416fc2	29
480ef0fe	30	<H3>Examples</H3>
ef416fc2	31
ef416fc2	32	<PRE CLASS="command">
480ef0fe	33	<Class name>
	34	...
	35	Accepting yes
	36	</Class>
ef416fc2	37	</PRE>
ef416fc2	38
480ef0fe	39	<H3>Description</H3>
ef416fc2	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>
480ef0fe	54	section.</P>
ef416fc2	55
ef416fc2	56
480ef0fe	57	<H2 CLASS="title"><A NAME="AllowUser">AllowUser</A></H2>
ef416fc2	58
480ef0fe	59	<H3>Examples</H3>
ef416fc2	60
ef416fc2	61	<PRE CLASS="command">
480ef0fe	62	<Class name>
	63	...
	64	AllowUser foo_user
	65	AllowUser @bar_group
	66	</Class>
ef416fc2	67	</PRE>
ef416fc2	68
480ef0fe	69	<H3>Description</H3>
ef416fc2	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
480ef0fe	86	<H2 CLASS="title"><A NAME="Class">Class</A></H2>
ef416fc2	87
480ef0fe	88	<H3>Examples</H3>
ef416fc2	89
	90	<PRE CLASS="command">
	91	<Class name>
480ef0fe	92	...
ef416fc2	93	</Class>
	94	</PRE>
	95
480ef0fe	96	<H3>Description</H3>
ef416fc2	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
480ef0fe	106	<H2 CLASS="title"><A NAME="DefaultClass">DefaultClass</A></H2>
ef416fc2	107
480ef0fe	108	<H3>Examples</H3>
ef416fc2	109
	110	<PRE CLASS="command">
	111	<DefaultClass name>
480ef0fe	112	...
ef416fc2	113	</Class>
	114	</PRE>
	115
480ef0fe	116	<H3>Description</H3>
ef416fc2	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
480ef0fe	132	<H2 CLASS="title"><A NAME="DenyUser">DenyUser</A></H2>
ef416fc2	133
480ef0fe	134	<H3>Examples</H3>
ef416fc2	135
ef416fc2	136	<PRE CLASS="command">
480ef0fe	137	<Class name>
	138	...
	139	DenyUser foo_user
	140	DenyUser @bar_group
	141	</Class>
ef416fc2	142	</PRE>
ef416fc2	143
480ef0fe	144	<H3>Description</H3>
ef416fc2	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
480ef0fe	161	<H2 CLASS="title"><A NAME="Info">Info</A></H2>
ef416fc2	162
480ef0fe	163	<H3>Examples</H3>
ef416fc2	164
ef416fc2	165	<PRE CLASS="command">
480ef0fe	166	<Class name>
	167	...
	168	Info My Class
	169	</Class>
ef416fc2	170	</PRE>
ef416fc2	171
480ef0fe	172	<H3>Description</H3>
ef416fc2	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>
480ef0fe	185	section.</P>
ef416fc2	186
ef416fc2	187
480ef0fe	188	<H2 CLASS="title"><A NAME="JobSheets">JobSheets</A></H2>
ef416fc2	189
480ef0fe	190	<H3>Examples</H3>
ef416fc2	191
ef416fc2	192	<PRE CLASS="command">
480ef0fe	193	<Class name>
	194	...
	195	JobSheets none,standard
	196	</Class>
ef416fc2	197	</PRE>
ef416fc2	198
480ef0fe	199	<H3>Description</H3>
ef416fc2	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	"classified" label at the top and bottom.</LI>
	226
	227	<LI><CODE>confidential</CODE> - A banner page with a
	228	"confidential" label at the top and bottom.</LI>
	229
	230	<LI><CODE>secret</CODE> - A banner page with a
	231	"secret" 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	"top secret" label at the top and bottom.</LI>
	238
	239	<LI><CODE>unclassified</CODE> - A banner page with an
	240	"unclassified" 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>
480ef0fe	247	section.</P>
ef416fc2	248
ef416fc2	249
480ef0fe	250	<H2 CLASS="title"><A NAME="KLimit">KLimit</A></H2>
ef416fc2	251
480ef0fe	252	<H3>Examples</H3>
ef416fc2	253
ef416fc2	254	<PRE CLASS="command">
480ef0fe	255	<Class name>
	256	...
	257	KLimit 1234
	258	</Class>
ef416fc2	259	</PRE>
ef416fc2	260
480ef0fe	261	<H3>Description</H3>
ef416fc2	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>
480ef0fe	274	section.</P>
ef416fc2	275
ef416fc2	276
480ef0fe	277	<H2 CLASS="title"><A NAME="Location">Location</A></H2>
ef416fc2	278
480ef0fe	279	<H3>Examples</H3>
ef416fc2	280
ef416fc2	281	<PRE CLASS="command">
480ef0fe	282	<Class name>
	283	...
	284	Location Building 3321
	285	</Class>
ef416fc2	286	</PRE>
ef416fc2	287
480ef0fe	288	<H3>Description</H3>
ef416fc2	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>
480ef0fe	301	section.</P>
ef416fc2	302
ef416fc2	303
480ef0fe	304	<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="OpPolicy">OpPolicy</A></H2>
ef416fc2	305
480ef0fe	306	<H3>Examples</H3>
ef416fc2	307
ef416fc2	308	<PRE CLASS="command">
480ef0fe	309	<Class name>
	310	...
	311	OpPolicy default
	312	</Class>
ef416fc2	313	</PRE>
ef416fc2	314
480ef0fe	315	<H3>Description</H3>
ef416fc2	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
4744bd90	327	HREF="ref-cupsd-conf.html#Policy"><CODE>Policy</CODE></A>
480ef0fe	328	section.</P>
ef416fc2	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>
480ef0fe	333	section.</P>
ef416fc2	334
ef416fc2	335
480ef0fe	336	<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="Option">Option</A></H2>
ef416fc2	337
480ef0fe	338	<H3>Examples</H3>
ef416fc2	339
ef416fc2	340	<PRE CLASS="command">
480ef0fe	341	<Class name>
	342	...
	343	Option name value
	344	Option scaling 100
	345	Option page-left 72
	346	</Class>
ef416fc2	347	</PRE>
ef416fc2	348
480ef0fe	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	<Class name>
	368	...
	369	PageLimit 1234
	370	</Class>
	371	</PRE>
	372
	373	<H3>Description</H3>
ef416fc2	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>
480ef0fe	386	section.</P>
ef416fc2	387
ef416fc2	388
480ef0fe	389	<H2 CLASS="title"><A NAME="Printer">Printer</A></H2>
ef416fc2	390
480ef0fe	391	<H3>Examples</H3>
ef416fc2	392
ef416fc2	393	<PRE CLASS="command">
480ef0fe	394	<Class name>
	395	...
	396	Printer foo
	397	Printer bar
	398	Printer bleep
	399	</Class>
ef416fc2	400	</PRE>
ef416fc2	401
480ef0fe	402	<H3>Description</H3>
ef416fc2	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>
480ef0fe	415	section.</P>
ef416fc2	416
ef416fc2	417
480ef0fe	418	<H2 CLASS="title"><A NAME="QuotaPeriod">QuotaPeriod</A></H2>
ef416fc2	419
480ef0fe	420	<H3>Examples</H3>
ef416fc2	421
ef416fc2	422	<PRE CLASS="command">
480ef0fe	423	<Class name>
	424	...
	425	QuotaPeriod 604800
	426	</Class>
ef416fc2	427	</PRE>
ef416fc2	428
480ef0fe	429	<H3>Description</H3>
ef416fc2	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>
480ef0fe	444	section.</P>
ef416fc2	445
ef416fc2	446
480ef0fe	447	<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="Shared">Shared</A></H2>
ef416fc2	448
480ef0fe	449	<H3>Examples</H3>
ef416fc2	450
ef416fc2	451	<PRE CLASS="command">
480ef0fe	452	<Class name>
	453	...
	454	Shared yes
	455	</Class>
ef416fc2	456	</PRE>
ef416fc2	457
480ef0fe	458	<H3>Description</H3>
ef416fc2	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>
480ef0fe	473	section.</P>
ef416fc2	474
ef416fc2	475
480ef0fe	476	<H2 CLASS="title"><A NAME="State">State</A></H2>
ef416fc2	477
480ef0fe	478	<H3>Examples</H3>
ef416fc2	479
ef416fc2	480	<PRE CLASS="command">
480ef0fe	481	<Class name>
	482	...
	483	State idle
	484	</Class>
ef416fc2	485	</PRE>
ef416fc2	486
480ef0fe	487	<H3>Description</H3>
ef416fc2	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>
480ef0fe	504	section.</P>
ef416fc2	505
ef416fc2	506
480ef0fe	507	<H2 CLASS="title"><A NAME="StateMessage">StateMessage</A></H2>
ef416fc2	508
480ef0fe	509	<H3>Examples</H3>
ef416fc2	510
ef416fc2	511	<PRE CLASS="command">
480ef0fe	512	<Class name>
	513	...
	514	StateMessage Ready to print.
	515	</Class>
ef416fc2	516	</PRE>
ef416fc2	517
480ef0fe	518	<H3>Description</H3>
ef416fc2	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>
480ef0fe	538	section.</P>
ef416fc2	539
ef416fc2	540
480ef0fe	541	<H2 CLASS="title"><SPAN CLASS="info">CUPS 1.2</SPAN><A NAME="StateTime">StateTime</A></H2>
ef416fc2	542
480ef0fe	543	<H3>Examples</H3>
ef416fc2	544
ef416fc2	545	<PRE CLASS="command">
480ef0fe	546	<Class name>
	547	...
	548	StateTime 1133542425
	549	</Class>
ef416fc2	550	</PRE>
ef416fc2	551
480ef0fe	552	<H3>Description</H3>
ef416fc2	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>
480ef0fe	562	section.</P>
ef416fc2	563
	564
	565	</BODY>
	566	</HTML>