blob: 20c31e187b046d2442363b18bf066bb01b879a69 (
plain)
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
|
<HTML>
<!-- SECTION: References -->
<HEAD>
<TITLE>subscriptions.conf</TITLE>
</HEAD>
<BODY>
<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">
<Subscription NNN>
...
Events job-completed
</Subscription>
</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">
<Subscription NNN>
...
ExpirationTime 1012563145
</Subscription>
</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">
<Subscription NNN>
...
Interval 30
</Subscription>
</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">
<Subscription NNN>
...
JobId 123
</Subscription>
</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">
<Subscription NNN>
...
LeaseDuration
</Subscription>
</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">
<Subscription NNN>
...
NextEventId 999
</Subscription>
</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">
<Subscription NNN>
...
Owner username
</Subscription>
</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">
<Subscription NNN>
...
PrinterName name
</Subscription>
</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">
<Subscription NNN>
...
Recipient mailto:foo@domain.com
</Subscription>
</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">
<Subscription NNN>
...
</Subscription>
</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">
<Subscription NNN>
...
UserData mailto:bar<40>domain.com
</Subscription>
</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>
|
