2 <!-- SECTION: References -->
4 <TITLE>subscriptions.conf
</TITLE>
5 <LINK REL=
"STYLESHEET" TYPE=
"text/css" HREF=
"../cups-printable.css">
9 <H1 CLASS=
"title">subscriptions.conf
</H1>
11 <P>The CUPS scheduler (cupsd) uses the
12 <VAR>/etc/cups/subscriptions.conf
</VAR> file to store the list
13 of active subscriptions. Each directive is listed on a line by
14 itself followed by its value. Comments are introduced using the
15 number sign (
"#") character at the beginning of a line.
17 <P>While the subscriptions configuration file consists of plain
18 text and can be modified using your favorite text editor, you
19 should normally use the command-line programs (
<A
20 HREF=
"man-lp.html">lp(
1)
</A> and
<A
21 HREF=
"man-lpr.html">lpr(
1)
</A>) or specific applications via IPP
22 requests to manage your subscriptions.
</P>
24 <H2 CLASS=
"title"><A NAME=
"Events">Events
</A></H2>
29 <Subscription NNN
>
37 <P>The
<CODE>Events
</CODE> directive lists the events, separated
38 by spaces, that the subscriber is interested in. Table
1 lists
39 the supported event names.
</P>
41 <P>The
<CODE>Events
</CODE> directive must appear inside a
<A
42 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
44 <DIV CLASS=
"table"><TABLE SUMMARY=
"Event Names">
45 <CAPTION>Table
1:
<A NAME=
"TABLE1">Event Names
</A></CAPTION>
58 <TD>job-completed
</TD>
59 <TD>Send notification when the job is completed
</TD>
62 <TD>job-config-changed
</TD>
63 <TD>Send notification when the job is changed
</TD>
67 <TD>Send notification when a job is created
</TD>
71 <TD>Send notification for job progress
</TD>
74 <TD>job-state-changed
</TD>
75 <TD>Send notification when the job-state changes
</TD>
79 <TD>Send notification when the job is stopped
</TD>
82 <TD>printer-added
</TD>
83 <TD>Send notification when a printer is added
</TD>
86 <TD>printer-changed
</TD>
87 <TD>Send notification when a printer is changed
</TD>
90 <TD>printer-config-changed
</TD>
91 <TD>Send notification when a printer's configuration is changed
</TD>
94 <TD>printer-deleted
</TD>
95 <TD>Send notification when a printer is deleted
</TD>
98 <TD>printer-modified
</TD>
99 <TD>Send notification when a printer is modified
</TD>
102 <TD>printer-state-changed
</TD>
103 <TD>Send notification when the printer-state changes
</TD>
106 <TD>printer-stopped
</TD>
107 <TD>Send notification when a printer is stopped
</TD>
110 <TD>server-audit
</TD>
111 <TD>Send notification when a bad request, security error, or
112 authentication error occurs
</TD>
115 <TD>server-restarted
</TD>
116 <TD>Send notification when the server is restarted
</TD>
119 <TD>server-started
</TD>
120 <TD>Send notification when the server is initially started
</TD>
123 <TD>server-stopped
</TD>
124 <TD>Send notification when the server is shutdown
</TD>
130 <H2 CLASS=
"title"><A NAME=
"ExpirationTime">ExpirationTime
</A></H2>
134 <PRE CLASS=
"command">
135 <Subscription NNN
>
137 ExpirationTime
1012563145
138 </Subscription
>
143 <P>The
<CODE>ExpirationTime
</CODE> directive specifies the
144 expiration time of the subscription as a UNIX time value. It is
0
145 for subscriptions with no predefined expiration time.
</P>
147 <P>The
<CODE>ExpirationTime
</CODE> directive must appear inside a
148 <A HREF=
"#Subscription"><CODE>Subscription
</CODE></A>
152 <H2 CLASS=
"title"><A NAME=
"Interval">Interval
</A></H2>
156 <PRE CLASS=
"command">
157 <Subscription NNN
>
160 </Subscription
>
165 <P>The
<CODE>Interval
</CODE> directive specifies the preferred
166 time interval for event notifications in seconds.
</P>
168 <P>The
<CODE>Interval
</CODE> directive must appear inside a
<A
169 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
172 <H2 CLASS=
"title"><A NAME=
"JobId">JobId
</A></H2>
176 <PRE CLASS=
"command">
177 <Subscription NNN
>
180 </Subscription
>
185 <P>The
<CODE>JobId
</CODE> directive specifies the
186 <CODE>job-id
</CODE> for job subscriptions.
</P>
188 <P>The
<CODE>JobId
</CODE> directive must appear inside a
<A
189 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
192 <H2 CLASS=
"title"><A NAME=
"LeaseDuration">LeaseDuration
</A></H2>
196 <PRE CLASS=
"command">
197 <Subscription NNN
>
200 </Subscription
>
205 <P>The
<CODE>LeaseDuration
</CODE> directive specifies the number
206 of seconds that the subscription is valid. A value of
0 means
207 that the subscription will last forever or the life of the print
208 job the subscription is attached to.
</P>
210 <P>The
<CODE>LeaseDuration
</CODE> directive must appear inside a
<A
211 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
214 <H2 CLASS=
"title"><A NAME=
"NextEventId">NextEventId
</A></H2>
218 <PRE CLASS=
"command">
219 <Subscription NNN
>
222 </Subscription
>
227 <P>The
<CODE>NextEventId
</CODE> directive specifies the
228 <CODE>notify-sequence-number
</CODE> value for the next
229 notification event. It starts at
1 and increases for every event
230 that is delivered for the subscription.
</P>
232 <P>The
<CODE>NextEventId
</CODE> directive must appear inside a
<A
233 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
236 <H2 CLASS=
"title"><A NAME=
"NextSubscriptionId">NextSubscriptionId
</A></H2>
240 <PRE CLASS=
"command">
241 NextSubscriptionId
999
246 <P>The
<CODE>NextSubscriptionId
</CODE> directive specifies the
247 next subscription ID to use. It defaults to
1 more than the
248 highest subscription number seen.
</P>
251 <H2 CLASS=
"title"><A NAME=
"Owner">Owner
</A></H2>
255 <PRE CLASS=
"command">
256 <Subscription NNN
>
259 </Subscription
>
264 <P>The
<CODE>Owner
</CODE> directive specifies the user that owns
265 this subscription.
</P>
267 <P>The
<CODE>Owner
</CODE> directive must appear inside a
<A
268 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
271 <H2 CLASS=
"title"><A NAME=
"PrinterName">PrinterName
</A></H2>
275 <PRE CLASS=
"command">
276 <Subscription NNN
>
279 </Subscription
>
284 <P>The
<CODE>PrinterName
</CODE> directive specifies the name of
285 the printer or class that is associated with this
288 <P>The
<CODE>PrinterName
</CODE> directive must appear inside a
<A
289 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
292 <H2 CLASS=
"title"><A NAME=
"Recipient">Recipient
</A></H2>
296 <PRE CLASS=
"command">
297 <Subscription NNN
>
299 Recipient mailto:foo@domain.com
300 </Subscription
>
305 <P>The
<CODE>Recipient
</CODE> directive specifies the
306 <CODE>notify-recipient-uri
</CODE> value for push-type
307 notifications. The URI scheme name determines which notifier
308 program is used to send the event(s).
</P>
310 <P>The
<CODE>Recipient
</CODE> directive must appear inside a
<A
311 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>
314 <H2 CLASS=
"title"><A NAME=
"Subscription">Subscription
</A></H2>
318 <PRE CLASS=
"command">
319 <Subscription NNN
>
321 </Subscription
>
326 <P>The
<CODE>Subscription
</CODE> section defines a single
327 subscription in the system. Each subscription is assigned a
328 unique (to the server) number starting at
1.
</P>
331 <H2 CLASS=
"title"><A NAME=
"UserData">UserData
</A></H2>
335 <PRE CLASS=
"command">
336 <Subscription NNN
>
338 UserData mailto:bar
<40>example.com
339 </Subscription
>
344 <P>The
<CODE>UserData
</CODE> directive specifies the
345 <CODE>notify-user-data
</CODE> value, which is normally the
"to"
346 address used in
<CODE>mailto
</CODE> notifications. Binary values
347 are introduced by encoding the bytes as hexadecimal values inside
348 angle brackets, e.g.
"<1234>".
</P>
350 <P>The
<CODE>UserData
</CODE> directive must appear inside a
<A
351 HREF=
"#Subscription"><CODE>Subscription
</CODE></A> section.
</P>