]> git.ipfire.org Git - thirdparty/cups.git/blame - doc/help/man-subscriptions.conf.html
Save work.
[thirdparty/cups.git] / doc / help / man-subscriptions.conf.html
CommitLineData
c277f98c 1<!DOCTYPE HTML>
94436c5a
MS
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>
c277f98c 15directory and is generated automatically by the <i>cupsd(8)</i>
94436c5a
MS
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>
2909c66c
MS
20<dl class="man">
21<dt>&lt;Subscription NNN> ... &lt;/Subscription>
22<dd style="margin-left: 5.0em"><br>
c277f98c 23Defines a subscription.
2909c66c
MS
24<dt>Events name [ ... name ]
25<dd style="margin-left: 5.0em"><br>
c277f98c 26Specifies the events that are subscribed.
2909c66c
MS
27<dt>ExpirationTime unix-time
28<dd style="margin-left: 5.0em"><br>
c277f98c 29Specifies the expiration time of a subscription as a UNIX time
94436c5a 30value in seconds since January 1st, 1970.
2909c66c
MS
31<dt>Interval seconds
32<dd style="margin-left: 5.0em"><br>
c277f98c 33Specifies the preferred time interval for event notifications in
94436c5a 34seconds.
2909c66c
MS
35<dt>JobId job-id
36<dd style="margin-left: 5.0em"><br>
c277f98c 37Specifies the job ID associated with the subscription.
2909c66c
MS
38<dt>LeaseDuration seconds
39<dd style="margin-left: 5.0em"><br>
c277f98c 40Specifies the number of seconds that the subscription is valid
94436c5a 41for. If 0, the subscription does not expire.
2909c66c
MS
42<dt>NextEventId number
43<dd style="margin-left: 5.0em"><br>
c277f98c 44Specifies the next notify-sequence-number to use for the
94436c5a 45subscription.
2909c66c
MS
46<dt>NextSubscriptionId number
47<dd style="margin-left: 5.0em"><br>
c277f98c 48Specifies the next subscription-id to use.
2909c66c
MS
49<dt>Owner username
50<dd style="margin-left: 5.0em"><br>
c277f98c 51Specifies the user that owns the subscription.
2909c66c
MS
52<dt>PrinterName printername
53<dd style="margin-left: 5.0em"><br>
c277f98c 54Specifies the printer or class associated with the subscription.
2909c66c
MS
55<dt>Recipient uri
56<dd style="margin-left: 5.0em"><br>
c277f98c 57Specifies the notify-recipient-uri value for push-type notifications.
2909c66c
MS
58<dt>UserData hex-escaped-data
59<dd style="margin-left: 5.0em"><br>
c277f98c 60Specifies user data to be included in event notifications. This
94436c5a 61is typically the "from" address in mailto: notifications.
2909c66c 62</dl>
94436c5a 63<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
c277f98c
MS
64<i>classes.conf(5)</i>, <i>cupsd(8)</i>, <i>cupsd.conf(5)</i>,
65<i>mime.convs(5)</i>, <i>mime.types(5)</i>, printers.conf(5)
94436c5a 66<br>
c277f98c 67<a href="http://localhost:631/help">http://localhost:631/help</a>
94436c5a
MS
68<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
69Copyright 2007-2013 by Apple Inc.
70
71</body>
72</html>