[thirdparty/cups.git] / man / subscriptions.conf.man

.\"
.\" "$Id: subscriptions.conf.man 5099 2006-02-13 02:46:10Z mike $"
.\"
.\"   subscriptions.conf man page for the Common UNIX Printing System (CUPS).
.\"
.\"   Copyright 2007 by Apple Inc.
.\"   Copyright 2006 by Easy Software Products.
.\"
.\"   These coded instructions, statements, and computer programs are the
.\"   property of Apple Inc. and are protected by Federal copyright
.\"   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
.\"   which should have been included with this file.  If this file is
.\"   file is missing or damaged, see the license at "http://www.cups.org/".
.\"
.TH subscriptions.conf 5 "Common UNIX Printing System" "30 April 2006" "Apple Inc."
.SH NAME
subscriptions.conf \- subscriptions file for cups
.SH DESCRIPTION
The \fIsubscriptions.conf\fR file defines the local subscriptions
that are active. It is normally located in the \fI/etc/cups\fR
directory and is generated automatically by the \fIcupsd(8)\fR
program when subscriptions are created, renewed, or cancelled.
.LP
Each line in the file can be a configuration directive, a blank line,
or a comment. Comment lines start with the # character.
.SH DIRECTIVES
.TP 5
<Subscription NNN> ... </Subscription>
.br
Defines a subscription.
.TP 5
Events name [ ... name ]
.br
Specifies the events that are subscribed.
.TP 5
ExpirationTime unix-time
.br
Specifies the expiration time of a subscription as a UNIX time
value in seconds since January 1st, 1970.
.TP 5
Interval seconds
.br
Specifies the preferred time interval for event notifications in
seconds.
.TP 5
JobId job-id
.br
Specifies the job ID associated with the subscription.
.TP 5
LeaseDuration seconds
.br
Specifies the number of seconds that the subscription is valid
for. If 0, the subscription does not expire.
.TP 5
NextEventId number
.br
Specifies the next notify-sequence-number to use for the
subscription.
.TP 5
NextSubscriptionId number
.br
Specifies the next subscription-id to use.
.TP 5
Owner username
.br
Specifies the user that owns the subscription.
.TP 5
PrinterName printername
.br
Specifies the printer or class associated with the subscription.
.TP 5
Recipient uri
.br
Specifies the notify-recipient-uri value for push-type notifications.
.TP 5
UserData hex-escaped-data
.br
Specifies user data to be included in event notifications. This
is typically the "from" address in mailto: notifications.
.SH SEE ALSO
\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR,
\fImime.convs(5)\fR, \fImime.types(5)\fR, \fRprinters.conf(5)\fR
.br
http://localhost:631/help
.SH COPYRIGHT
Copyright 2007 by Apple Inc.
.\"
.\" End of "$Id: subscriptions.conf.man 5099 2006-02-13 02:46:10Z mike $".
.\"
Commit	Line	Data
a74454a7	1	.\"
f7faf1f5	2	.\" "$Id: subscriptions.conf.man 5099 2006-02-13 02:46:10Z mike $"
a74454a7	3	.\"
	4	.\" subscriptions.conf man page for the Common UNIX Printing System (CUPS).
	5	.\"
bc44d920	6	.\" Copyright 2007 by Apple Inc.
a74454a7	7	.\" Copyright 2006 by Easy Software Products.
	8	.\"
	9	.\" These coded instructions, statements, and computer programs are the
bc44d920	10	.\" property of Apple Inc. and are protected by Federal copyright
	11	.\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
	12	.\" which should have been included with this file. If this file is
	13	.\" file is missing or damaged, see the license at "http://www.cups.org/".
a74454a7	14	.\"
bc44d920	15	.TH subscriptions.conf 5 "Common UNIX Printing System" "30 April 2006" "Apple Inc."
a74454a7	16	.SH NAME
	17	subscriptions.conf \- subscriptions file for cups
	18	.SH DESCRIPTION
	19	The \fIsubscriptions.conf\fR file defines the local subscriptions
	20	that are active. It is normally located in the \fI/etc/cups\fR
	21	directory and is generated automatically by the \fIcupsd(8)\fR
	22	program when subscriptions are created, renewed, or cancelled.
	23	.LP
	24	Each line in the file can be a configuration directive, a blank line,
	25	or a comment. Comment lines start with the # character.
	26	.SH DIRECTIVES
	27	.TP 5
	28	<Subscription NNN> ... </Subscription>
	29	.br
	30	Defines a subscription.
	31	.TP 5
	32	Events name [ ... name ]
	33	.br
	34	Specifies the events that are subscribed.
	35	.TP 5
	36	ExpirationTime unix-time
	37	.br
	38	Specifies the expiration time of a subscription as a UNIX time
	39	value in seconds since January 1st, 1970.
	40	.TP 5
	41	Interval seconds
	42	.br
	43	Specifies the preferred time interval for event notifications in
	44	seconds.
	45	.TP 5
	46	JobId job-id
	47	.br
	48	Specifies the job ID associated with the subscription.
	49	.TP 5
	50	LeaseDuration seconds
	51	.br
	52	Specifies the number of seconds that the subscription is valid
	53	for. If 0, the subscription does not expire.
	54	.TP 5
	55	NextEventId number
	56	.br
	57	Specifies the next notify-sequence-number to use for the
	58	subscription.
	59	.TP 5
	60	NextSubscriptionId number
	61	.br
	62	Specifies the next subscription-id to use.
	63	.TP 5
	64	Owner username
	65	.br
	66	Specifies the user that owns the subscription.
	67	.TP 5
	68	PrinterName printername
	69	.br
	70	Specifies the printer or class associated with the subscription.
	71	.TP 5
	72	Recipient uri
	73	.br
	74	Specifies the notify-recipient-uri value for push-type notifications.
	75	.TP 5
	76	UserData hex-escaped-data
	77	.br
	78	Specifies user data to be included in event notifications. This
	79	is typically the "from" address in mailto: notifications.
80	.SH SEE ALSO
81	\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR,
82	\fImime.convs(5)\fR, \fImime.types(5)\fR, \fRprinters.conf(5)\fR
83	.br
84	http://localhost:631/help
85	.SH COPYRIGHT
bc44d920	86	Copyright 2007 by Apple Inc.
a74454a7	87	.\"
f7faf1f5	88	.\" End of "$Id: subscriptions.conf.man 5099 2006-02-13 02:46:10Z mike $".
a74454a7	89	.\"