[thirdparty/cups.git] / man / notifier.man

.\"
.\" notifier man page for CUPS.
.\"
.\" Copyright 2007-2014 by Apple Inc.
.\" Copyright 1997-2007 by Easy Software Products.
.\"
.\" Licensed under Apache License v2.0.  See the file "LICENSE" for more information.
.\"
.TH notifier 7 "CUPS" "12 June 2014" "Apple Inc."
.SH NAME
notifier \- cups notification interface
.SH SYNOPSIS
.B notifier
.I recipient
[
.I user-data
]
.SH DESCRIPTION
The CUPS notifier interface provides a standard method for adding support for new event notification methods to CUPS.
Each notifier delivers one or more IPP events from the standard input to the specified recipient.
.LP
Notifiers \fBMUST\fR read IPP messages from the standard input using the
.BR ippNew ()
and
.BR ippReadFile ()
functions and exit on error.
Notifiers are encouraged to exit after a suitable period of inactivity, however they may exit after reading the first message or stay running until an error is seen.
Notifiers inherit the environment and can use the logging mechanism documented in
.BR filter (7).
.SH SEE ALSO
.BR cupsd (8),
.BR filter (7),
CUPS Online Help (http://localhost:631/help)
.SH COPYRIGHT
Copyright \[co] 2007-2017 by Apple Inc.
Commit	Line	Data
6c663ae2	1	.\"
27e0d6f8	2	.\" notifier man page for CUPS.
6c663ae2	3	.\"
27e0d6f8 MS	4	.\" Copyright 2007-2014 by Apple Inc.
27e0d6f8 MS	5	.\" Copyright 1997-2007 by Easy Software Products.
6c663ae2	6	.\"
e3101897	7	.\" Licensed under Apache License v2.0. See the file "LICENSE" for more information.
6c663ae2	8	.\"
27e0d6f8	9	.TH notifier 7 "CUPS" "12 June 2014" "Apple Inc."
6c663ae2 MS	10	.SH NAME
	11	notifier \- cups notification interface
	12	.SH SYNOPSIS
	13	.B notifier
	14	.I recipient
	15	[
	16	.I user-data
	17	]
	18	.SH DESCRIPTION
27e0d6f8 MS	19	The CUPS notifier interface provides a standard method for adding support for new event notification methods to CUPS.
27e0d6f8 MS	20	Each notifier delivers one or more IPP events from the standard input to the specified recipient.
6c663ae2	21	.LP
27e0d6f8 MS	22	Notifiers \fBMUST\fR read IPP messages from the standard input using the
	23	.BR ippNew ()
	24	and
	25	.BR ippReadFile ()
	26	functions and exit on error.
	27	Notifiers are encouraged to exit after a suitable period of inactivity, however they may exit after reading the first message or stay running until an error is seen.
	28	Notifiers inherit the environment and can use the logging mechanism documented in
	29	.BR filter (7).
6c663ae2	30	.SH SEE ALSO
27e0d6f8 MS	31	.BR cupsd (8),
	32	.BR filter (7),
	33	CUPS Online Help (http://localhost:631/help)
6c663ae2	34	.SH COPYRIGHT
bd5a2f28	35	Copyright \[co] 2007-2017 by Apple Inc.