2 <!-- SECTION: References -->
4 <TITLE>subscriptions.conf
</TITLE>
8 <P>The CUPS scheduler (cupsd) uses the
9 <VAR>/etc/cups/subscriptions.conf
</VAR> file to store the list
10 of active subscriptions. Each directive is listed on a line by
11 itself followed by its value. Comments are introduced using the
12 number sign (
"#") character at the beginning of a line.
14 <P>While the subscriptions configuration file consists of plain
15 text and can be modified using your favorite text editor, you
16 should normally use the command-line programs (
<A
17 HREF=
"man-lp.html">lp(
1)
</A> and
<A
18 HREF=
"man-lpr.html">lpr(
1)
</A>) or specific applications via IPP
19 requests to manage your subscriptions.
</P>
21 <H2 CLASS=
"title"><A NAME=
"Events">Events
</A></H2>
26 <Subscription NNN
>
34 <P>The
<CODE>Events
</CODE> directive lists the events, separated
35 by spaces, that the subscriber is interested in. Table
1 lists
36 the supported event names.
</P>
38 <P>The
<CODE>Events
</CODE> directive must appear inside a
<A
39 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
41 <DIV CLASS=
"table"><TABLE SUMMARY=
"Event Names">
42 <CAPTION>Table
1:
<A NAME=
"TABLE1">Event Names
</A></CAPTION>
55 <TD>job-completed
</TD>
56 <TD>Send notification when the job is completed
</TD>
59 <TD>job-config-changed
</TD>
60 <TD>Send notification when the job is changed
</TD>
64 <TD>Send notification when a job is created
</TD>
68 <TD>Send notification for job progress
</TD>
71 <TD>job-state-changed
</TD>
72 <TD>Send notification when the job-state changes
</TD>
76 <TD>Send notification when the job is stopped
</TD>
79 <TD>printer-added
</TD>
80 <TD>Send notification when a printer is added
</TD>
83 <TD>printer-changed
</TD>
84 <TD>Send notification when a printer is changed
</TD>
87 <TD>printer-config-changed
</TD>
88 <TD>Send notification when a printer's configuration is changed
</TD>
91 <TD>printer-deleted
</TD>
92 <TD>Send notification when a printer is deleted
</TD>
95 <TD>printer-modified
</TD>
96 <TD>Send notification when a printer is modified
</TD>
99 <TD>printer-state-changed
</TD>
100 <TD>Send notification when the printer-state changes
</TD>
103 <TD>printer-stopped
</TD>
104 <TD>Send notification when a printer is stopped
</TD>
107 <TD>server-audit
</TD>
108 <TD>Send notification when a bad request, security error, or
109 authentication error occurs
</TD>
112 <TD>server-restarted
</TD>
113 <TD>Send notification when the server is restarted
</TD>
116 <TD>server-started
</TD>
117 <TD>Send notification when the server is initially started
</TD>
120 <TD>server-stopped
</TD>
121 <TD>Send notification when the server is shutdown
</TD>
127 <H2 CLASS=
"title"><A NAME=
"ExpirationTime">ExpirationTime
</A></H2>
131 <PRE CLASS=
"command">
132 <Subscription NNN
>
134 ExpirationTime
1012563145
135 </Subscription
>
140 <P>The
<CODE>ExpirationTime
</CODE> directive specifies the
141 expiration time of the subscription as a UNIX time value. It is
0
142 for subscriptions with no predefined expiration time.
</P>
144 <P>The
<CODE>ExpirationTime
</CODE> directive must appear inside a
145 <A HREF=
"#Subscription"><CODE>Subscription
</CODE></A>
149 <H2 CLASS=
"title"><A NAME=
"Interval">Interval
</A></H2>
153 <PRE CLASS=
"command">
154 <Subscription NNN
>
157 </Subscription
>
162 <P>The
<CODE>Interval
</CODE> directive specifies the preferred
163 time interval for event notifications in seconds.
</P>
165 <P>The
<CODE>Interval
</CODE> directive must appear inside a
<A
166 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
169 <H2 CLASS=
"title"><A NAME=
"JobId">JobId
</A></H2>
173 <PRE CLASS=
"command">
174 <Subscription NNN
>
177 </Subscription
>
182 <P>The
<CODE>JobId
</CODE> directive specifies the
183 <CODE>job-id
</CODE> for job subscriptions.
</P>
185 <P>The
<CODE>JobId
</CODE> directive must appear inside a
<A
186 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
189 <H2 CLASS=
"title"><A NAME=
"LeaseDuration">LeaseDuration
</A></H2>
193 <PRE CLASS=
"command">
194 <Subscription NNN
>
197 </Subscription
>
202 <P>The
<CODE>LeaseDuration
</CODE> directive specifies the number
203 of seconds that the subscription is valid. A value of
0 means
204 that the subscription will last forever or the life of the print
205 job the subscription is attached to.
</P>
207 <P>The
<CODE>LeaseDuration
</CODE> directive must appear inside a
<A
208 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
211 <H2 CLASS=
"title"><A NAME=
"NextEventId">NextEventId
</A></H2>
215 <PRE CLASS=
"command">
216 <Subscription NNN
>
219 </Subscription
>
224 <P>The
<CODE>NextEventId
</CODE> directive specifies the
225 <CODE>notify-sequence-number
</CODE> value for the next
226 notification event. It starts at
1 and increases for every event
227 that is delivered for the subscription.
</P>
229 <P>The
<CODE>NextEventId
</CODE> directive must appear inside a
<A
230 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
233 <H2 CLASS=
"title"><A NAME=
"NextSubscriptionId">NextSubscriptionId
</A></H2>
237 <PRE CLASS=
"command">
238 NextSubscriptionId
999
243 <P>The
<CODE>NextSubscriptionId
</CODE> directive specifies the
244 next subscription ID to use. It defaults to
1 more than the
245 highest subscription number seen.
</P>
248 <H2 CLASS=
"title"><A NAME=
"Owner">Owner
</A></H2>
252 <PRE CLASS=
"command">
253 <Subscription NNN
>
256 </Subscription
>
261 <P>The
<CODE>Owner
</CODE> directive specifies the user that owns
262 this subscription.
</P>
264 <P>The
<CODE>Owner
</CODE> directive must appear inside a
<A
265 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
268 <H2 CLASS=
"title"><A NAME=
"PrinterName">PrinterName
</A></H2>
272 <PRE CLASS=
"command">
273 <Subscription NNN
>
276 </Subscription
>
281 <P>The
<CODE>PrinterName
</CODE> directive specifies the name of
282 the printer or class that is associated with this
285 <P>The
<CODE>PrinterName
</CODE> directive must appear inside a
<A
286 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
289 <H2 CLASS=
"title"><A NAME=
"Recipient">Recipient
</A></H2>
293 <PRE CLASS=
"command">
294 <Subscription NNN
>
296 Recipient mailto:foo@domain.com
297 </Subscription
>
302 <P>The
<CODE>Recipient
</CODE> directive specifies the
303 <CODE>notify-recipient-uri
</CODE> value for push-type
304 notifications. The URI scheme name determines which notifier
305 program is used to send the event(s).
</P>
307 <P>The
<CODE>Recipient
</CODE> directive must appear inside a
<A
308 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
311 <H2 CLASS=
"title"><A NAME=
"Subscription">Subscription
</A></H2>
315 <PRE CLASS=
"command">
316 <Subscription NNN
>
318 </Subscription
>
323 <P>The
<CODE>Subscription
</CODE> section defines a single
324 subscription in the system. Each subscription is assigned a
325 unique (to the server) number starting at
1.
</P>
328 <H2 CLASS=
"title"><A NAME=
"UserData">UserData
</A></H2>
332 <PRE CLASS=
"command">
333 <Subscription NNN
>
335 UserData mailto:bar
<40>domain.com
336 </Subscription
>
341 <P>The
<CODE>UserData
</CODE> directive specifies the
342 <CODE>notify-user-data
</CODE> value, which is normally the
"from"
343 address used in
<CODE>mailto
</CODE> notifications. Binary values
344 are introduced by encoding the bytes as hexadecimal values inside
345 angle brackets, e.g.
"<1234>".
</P>
347 <P>The
<CODE>UserData
</CODE> directive must appear inside a
<A
348 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>