]> git.ipfire.org Git - thirdparty/cups.git/blame - doc/help/man-subscriptions.conf.html
Add HTML man pages.
[thirdparty/cups.git] / doc / help / man-subscriptions.conf.html
CommitLineData
62b97abe 1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<!-- SECTION: Man Pages -->
4<head>
5 <link rel="stylesheet" type="text/css" href="../cups-printable.css">
6 <title>subscriptions.conf(5)</title>
7</head>
8<body>
9<h1 class="title">subscriptions.conf(5)</h1>
10<h2 class="title"><a name="NAME">Name</a></h2>
11subscriptions.conf - subscriptions file for cups
12<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
13The <i>subscriptions.conf</i> file defines the local subscriptions
14that are active. It is normally located in the <i>/etc/cups</i>
15directory and is generated automatically by the <a href='man-cupsd.html?TOPIC=Man+Pages'>cupsd(8)</a>
16program when subscriptions are created, renewed, or cancelled.
17<p>Each line in the file can be a configuration directive, a blank line,
18or a comment. Comment lines start with the # character.
19<h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
20<dl>
21<dt>&lt;Subscription NNN> ... &lt;/Subscription>
22</dt>
23<dd></dd>
24<dd>Defines a subscription.
25</dd>
26<dt>Events name [ ... name ]
27</dt>
28<dd></dd>
29<dd>Specifies the events that are subscribed.
30</dd>
31<dt>ExpirationTime unix-time
32</dt>
33<dd></dd>
34<dd>Specifies the expiration time of a subscription as a UNIX time
35value in seconds since January 1st, 1970.
36</dd>
37<dt>Interval seconds
38</dt>
39<dd></dd>
40<dd>Specifies the preferred time interval for event notifications in
41seconds.
42</dd>
43<dt>JobId job-id
44</dt>
45<dd></dd>
46<dd>Specifies the job ID associated with the subscription.
47</dd>
48<dt>LeaseDuration seconds
49</dt>
50<dd></dd>
51<dd>Specifies the number of seconds that the subscription is valid
52for. If 0, the subscription does not expire.
53</dd>
54<dt>NextEventId number
55</dt>
56<dd></dd>
57<dd>Specifies the next notify-sequence-number to use for the
58subscription.
59</dd>
60<dt>NextSubscriptionId number
61</dt>
62<dd></dd>
63<dd>Specifies the next subscription-id to use.
64</dd>
65<dt>Owner username
66</dt>
67<dd></dd>
68<dd>Specifies the user that owns the subscription.
69</dd>
70<dt>PrinterName printername
71</dt>
72<dd></dd>
73<dd>Specifies the printer or class associated with the subscription.
74</dd>
75<dt>Recipient uri
76</dt>
77<dd></dd>
78<dd>Specifies the notify-recipient-uri value for push-type notifications.
79</dd>
80<dt>UserData hex-escaped-data
81</dt>
82<dd></dd>
83<dd>Specifies user data to be included in event notifications. This
84is typically the "from" address in mailto: notifications.
85</dd>
86</dl>
87<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
88<a href='man-classes.conf.html?TOPIC=Man+Pages'>classes.conf(5)</a>, <a href='man-cupsd.html?TOPIC=Man+Pages'>cupsd(8)</a>, <a href='man-cupsd.conf.html?TOPIC=Man+Pages'>cupsd.conf(5)</a>,
89<a href='man-mime.convs.html?TOPIC=Man+Pages'>mime.convs(5)</a>, <a href='man-mime.types.html?TOPIC=Man+Pages'>mime.types(5)</a>, printers.conf(5)
90<br>
91<a href='http://localhost:631/help'>http://localhost:631/help</a>
92<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
93Copyright 2007-2013 by Apple Inc.
94
95</body>
96</html>