Gecko [ 122.154.134.11 ]

Name	Size	Permission
accounting.html	2.53 KB	-r--r--r--
api-array.html	32.95 KB	-r--r--r--
api-cgi.html	32.93 KB	-r--r--r--
api-cups.html	88.38 KB	-r--r--r--
api-driver.html	35.72 KB	-r--r--r--
api-filedir.html	32.22 KB	-r--r--r--
api-filter.html	46.11 KB	-r--r--r--
api-httpipp.html	160.97 KB	-r--r--r--
api-mime.html	21.68 KB	-r--r--r--
api-overview.html	11.27 KB	-r--r--r--
api-ppd.html	82.86 KB	-r--r--r--
api-ppdc.html	63.67 KB	-r--r--r--
api-raster.html	50.05 KB	-r--r--r--
cgi.html	2.46 KB	-r--r--r--
glossary.html	2.72 KB	-r--r--r--
kerberos.html	4.17 KB	-r--r--r--
license.html	48.75 KB	-r--r--r--
man-backend.html	5.71 KB	-r--r--r--
man-cancel.html	2.17 KB	-r--r--r--
man-cups-config.html	2.49 KB	-r--r--r--
man-cups-lpd.html	4.41 KB	-r--r--r--
man-cups-polld.html	1.37 KB	-r--r--r--
man-cupsaccept.html	2.51 KB	-r--r--r--
man-cupsaddsmb.html	6.65 KB	-r--r--r--
man-cupsd.html	2.58 KB	-r--r--r--
man-cupsenable.html	2.84 KB	-r--r--r--
man-cupstestdsc.html	1.72 KB	-r--r--r--
man-cupstestppd.html	3.93 KB	-r--r--r--
man-drv.html	1.31 KB	-r--r--r--
man-filter.html	7.47 KB	-r--r--r--
man-lp.html	6.96 KB	-r--r--r--
man-lpadmin.html	6.87 KB	-r--r--r--
man-lpc.html	2.4 KB	-r--r--r--
man-lpinfo.html	2.91 KB	-r--r--r--
man-lpmove.html	1.59 KB	-r--r--r--
man-lpoptions.html	3.61 KB	-r--r--r--
man-lppasswd.html	2.14 KB	-r--r--r--
man-lpq.html	1.96 KB	-r--r--r--
man-lpr.html	3.49 KB	-r--r--r--
man-lprm.html	1.9 KB	-r--r--r--
man-lpstat.html	3.86 KB	-r--r--r--
man-mime.convs.html	1.69 KB	-r--r--r--
man-mime.types.html	4.09 KB	-r--r--r--
man-notifier.html	4.29 KB	-r--r--r--
man-ppdc.html	2.59 KB	-r--r--r--
man-ppdhtml.html	1.27 KB	-r--r--r--
man-ppdi.html	1.34 KB	-r--r--r--
man-ppdmerge.html	1.32 KB	-r--r--r--
man-ppdpo.html	1.48 KB	-r--r--r--
network.html	26.99 KB	-r--r--r--
options.html	23.18 KB	-r--r--r--
overview.html	3.46 KB	-r--r--r--
policies.html	20.83 KB	-r--r--r--
postscript-driver.html	21.14 KB	-r--r--r--
ppd-compiler.html	42.79 KB	-r--r--r--
raster-driver.html	18.22 KB	-r--r--r--
ref-access_log.html	4.38 KB	-r--r--r--
ref-classes-conf.html	13.72 KB	-r--r--r--
ref-client-conf.html	2.08 KB	-r--r--r--
ref-cupsd-conf.html	83.53 KB	-r--r--r--
ref-error_log.html	1.6 KB	-r--r--r--
ref-mailto-conf.html	2.67 KB	-r--r--r--
ref-page_log.html	2.66 KB	-r--r--r--
ref-ppdcfile.html	69.38 KB	-r--r--r--
ref-printers-conf.html	17.88 KB	-r--r--r--
ref-snmp-conf.html	3.77 KB	-r--r--r--
ref-subscriptions-conf.html	8.26 KB	-r--r--r--
security.html	5.96 KB	-r--r--r--
sharing.html	6.64 KB	-r--r--r--
spec-banner.html	4.39 KB	-r--r--r--
spec-browsing.html	4.44 KB	-r--r--r--
spec-cmp.html	37.95 KB	-r--r--r--
spec-command.html	6.42 KB	-r--r--r--
spec-design.html	13.05 KB	-r--r--r--
spec-ipp.html	81.86 KB	-r--r--r--
spec-pdf.html	861 B	-r--r--r--
spec-postscript.html	5.05 KB	-r--r--r--
spec-ppd.html	66.86 KB	-r--r--r--
spec-raster.html	18.77 KB	-r--r--r--
spec-stp.html	3.79 KB	-r--r--r--
standard.html	5.22 KB	-r--r--r--
translation.html	22.96 KB	-r--r--r--
whatsnew.html	11.12 KB	-r--r--r--

Code Editor : ref-subscriptions-conf.html

<HTML>

<HEAD>
	<TITLE>subscriptions.conf</TITLE>
	<LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css">
</HEAD>
<BODY>

<H1 CLASS="title">subscriptions.conf</H1>

<P>The CUPS scheduler (cupsd) uses the
<VAR>/etc/cups/subscriptions.conf</VAR> file  to store the list
of active subscriptions. 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>While the subscriptions configuration file consists of plain
text and can be modified using your favorite text editor, you
should normally use the command-line programs (<A
HREF="man-lp.html">lp(1)</A> and <A
HREF="man-lpr.html">lpr(1)</A>) or specific applications via IPP
requests to manage your subscriptions.</P>

<H2 CLASS="title"><A NAME="Events">Events</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
&lt;Subscription NNN&gt;
  ...
  Events job-completed
&lt;/Subscription&gt;
</PRE>

<H3>Description</H3>

<P>The <CODE>Events</CODE> directive lists the events, separated
by spaces, that the subscriber is interested in. Table 1 lists
the supported event names.</P>

<P>The <CODE>Events</CODE> directive must appear inside a <A
HREF="#Subscription"><CODE>Subscription</CODE></A> section.</P>

<DIV CLASS="table"><TABLE SUMMARY="Event Names">
<CAPTION>Table 1: <A NAME="TABLE1">Event Names</A></CAPTION>
<THEAD>
<TR>
	<TH>Name</TH>
	<TH>Description</TH>
</TR>
</THEAD>
<TBODY>
<TR>
	<TD>all</TD>
	<TD>All events</TD>
</TR>
<TR>
	<TD>job-completed</TD>
	<TD>Send notification when the job is completed</TD>
</TR>
<TR>
	<TD>job-config-changed</TD>
	<TD>Send notification when the job is changed</TD>
</TR>
<TR>
	<TD>job-created</TD>
	<TD>Send notification when a job is created</TD>
</TR>
<TR>
	<TD>job-progress</TD>
	<TD>Send notification for job progress</TD>
</TR>
<TR>
	<TD>job-state-changed</TD>
	<TD>Send notification when the job-state changes</TD>
</TR>
<TR>
	<TD>job-stopped</TD>
	<TD>Send notification when the job is stopped</TD>
</TR>
<TR>
	<TD>printer-added</TD>
	<TD>Send notification when a printer is added</TD>
</TR>
<TR>
	<TD>printer-changed</TD>
	<TD>Send notification when a printer is changed</TD>
</TR>
<TR>
	<TD>printer-config-changed</TD>
	<TD>Send notification when a printer's configuration is changed</TD>
</TR>
<TR>
	<TD>printer-deleted</TD>
	<TD>Send notification when a printer is deleted</TD>
</TR>
<TR>
	<TD>printer-modified</TD>
	<TD>Send notification when a printer is modified</TD>
</TR>
<TR>
	<TD>printer-state-changed</TD>
	<TD>Send notification when the printer-state changes</TD>
</TR>
<TR>
	<TD>printer-stopped</TD>
	<TD>Send notification when a printer is stopped</TD>
</TR>
<TR>
	<TD>server-audit</TD>
	<TD>Send notification when a bad request, security error, or
	authentication error occurs</TD>
</TR>
<TR>
	<TD>server-restarted</TD>
	<TD>Send notification when the server is restarted</TD>
</TR>
<TR>
	<TD>server-started</TD>
	<TD>Send notification when the server is initially started</TD>
</TR>
<TR>
	<TD>server-stopped</TD>
	<TD>Send notification when the server is shutdown</TD>
</TR>
</TBODY>
</TABLE></DIV>

<H2 CLASS="title"><A NAME="ExpirationTime">ExpirationTime</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
&lt;Subscription NNN&gt;
  ...
  ExpirationTime 1012563145
&lt;/Subscription&gt;
</PRE>

<H3>Description</H3>

<P>The <CODE>ExpirationTime</CODE> directive specifies the
expiration time of the subscription as a UNIX time value. It is 0
for subscriptions with no predefined expiration time.</P>

<P>The <CODE>ExpirationTime</CODE> directive must appear inside a
<A HREF="#Subscription"><CODE>Subscription</CODE></A>
section.</P>

<H2 CLASS="title"><A NAME="Interval">Interval</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
&lt;Subscription NNN&gt;
  ...
  Interval 30
&lt;/Subscription&gt;
</PRE>

<H3>Description</H3>

<P>The <CODE>Interval</CODE> directive specifies the preferred
time interval for event notifications in seconds.</P>

<P>The <CODE>Interval</CODE> directive must appear inside a <A
HREF="#Subscription"><CODE>Subscription</CODE></A> section.</P>

<H2 CLASS="title"><A NAME="JobId">JobId</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
&lt;Subscription NNN&gt;
  ...
  JobId 123
&lt;/Subscription&gt;
</PRE>

<H3>Description</H3>

<P>The <CODE>JobId</CODE> directive specifies the
<CODE>job-id</CODE> for job subscriptions.</P>

<P>The <CODE>JobId</CODE> directive must appear inside a <A
HREF="#Subscription"><CODE>Subscription</CODE></A> section.</P>

<H2 CLASS="title"><A NAME="LeaseDuration">LeaseDuration</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
&lt;Subscription NNN&gt;
  ...
  LeaseDuration 
&lt;/Subscription&gt;
</PRE>

<H3>Description</H3>

<P>The <CODE>LeaseDuration</CODE> directive specifies the number
of seconds that the subscription is valid. A value of 0 means
that the subscription will last forever or the life of the print
job the subscription is attached to.</P>

<P>The <CODE>LeaseDuration</CODE> directive must appear inside a <A
HREF="#Subscription"><CODE>Subscription</CODE></A> section.</P>

<H2 CLASS="title"><A NAME="NextEventId">NextEventId</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
&lt;Subscription NNN&gt;
  ...
  NextEventId 999
&lt;/Subscription&gt;
</PRE>

<H3>Description</H3>

<P>The <CODE>NextEventId</CODE> directive specifies the
<CODE>notify-sequence-number</CODE> value for the next
notification event. It starts at 1 and increases for every event
that is delivered for the subscription.</P>

<P>The <CODE>NextEventId</CODE> directive must appear inside a <A
HREF="#Subscription"><CODE>Subscription</CODE></A> section.</P>

<H2 CLASS="title"><A NAME="NextSubscriptionId">NextSubscriptionId</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
NextSubscriptionId 999
</PRE>

<H3>Description</H3>

<P>The <CODE>NextSubscriptionId</CODE> directive specifies the
next subscription ID to use. It defaults to 1 more than the
highest subscription number seen.</P>

<H2 CLASS="title"><A NAME="Owner">Owner</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
&lt;Subscription NNN&gt;
  ...
  Owner username
&lt;/Subscription&gt;
</PRE>

<H3>Description</H3>

<P>The <CODE>Owner</CODE> directive specifies the user that owns
this subscription.</P>

<P>The <CODE>Owner</CODE> directive must appear inside a <A
HREF="#Subscription"><CODE>Subscription</CODE></A> section.</P>

<H2 CLASS="title"><A NAME="PrinterName">PrinterName</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
&lt;Subscription NNN&gt;
  ...
  PrinterName name
&lt;/Subscription&gt;
</PRE>

<H3>Description</H3>

<P>The <CODE>PrinterName</CODE> directive specifies the name of
the printer or class that is associated with this
subscription.</P>

<P>The <CODE>PrinterName</CODE> directive must appear inside a <A
HREF="#Subscription"><CODE>Subscription</CODE></A> section.</P>

<H2 CLASS="title"><A NAME="Recipient">Recipient</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
&lt;Subscription NNN&gt;
  ...
  Recipient mailto:foo@domain.com
&lt;/Subscription&gt;
</PRE>

<H3>Description</H3>

<P>The <CODE>Recipient</CODE> directive specifies the
<CODE>notify-recipient-uri</CODE> value for push-type
notifications. The URI scheme name determines which notifier
program is used to send the event(s).</P>

<P>The <CODE>Recipient</CODE> directive must appear inside a <A
HREF="#Subscription"><CODE>Subscription</CODE></A> section.</P>

<H2 CLASS="title"><A NAME="Subscription">Subscription</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
&lt;Subscription NNN&gt;
  ...
&lt;/Subscription&gt;
</PRE>

<H3>Description</H3>

<P>The <CODE>Subscription</CODE> section defines a single
subscription in the system. Each subscription is assigned a
unique (to the server) number starting at 1.</P>

<H2 CLASS="title"><A NAME="UserData">UserData</A></H2>

<H3>Examples</H3>

<PRE CLASS="command">
&lt;Subscription NNN&gt;
  ...
  UserData mailto:bar<40>domain.com
&lt;/Subscription&gt;
</PRE>

<H3>Description</H3>

<P>The <CODE>UserData</CODE> directive specifies the
<CODE>notify-user-data</CODE> value, which is normally the "from"
address used in <CODE>mailto</CODE> notifications. Binary values
are introduced by encoding the bytes as hexadecimal values inside
angle brackets, e.g. "<1234>".</P>

<P>The <CODE>UserData</CODE> directive must appear inside a <A
HREF="#Subscription"><CODE>Subscription</CODE></A> section.</P>

</BODY>
</HTML>

${this.title}

Code Editor : ref-subscriptions-conf.html