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

.\"
.\" notifier man page for CUPS.
.\"
.\" Copyright 2007-2014 by Apple Inc.
.\" Copyright 1997-2007 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 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	.\"
27e0d6f8 MS	7	.\" These coded instructions, statements, and computer programs are the
	8	.\" property of Apple Inc. and are protected by Federal copyright
	9	.\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
	10	.\" which should have been included with this file. If this file is
	11	.\" file is missing or damaged, see the license at "http://www.cups.org/".
6c663ae2	12	.\"
27e0d6f8	13	.TH notifier 7 "CUPS" "12 June 2014" "Apple Inc."
6c663ae2 MS	14	.SH NAME
	15	notifier \- cups notification interface
	16	.SH SYNOPSIS
	17	.B notifier
	18	.I recipient
	19	[
	20	.I user-data
	21	]
	22	.SH DESCRIPTION
27e0d6f8 MS	23	The CUPS notifier interface provides a standard method for adding support for new event notification methods to CUPS.
27e0d6f8 MS	24	Each notifier delivers one or more IPP events from the standard input to the specified recipient.
6c663ae2	25	.LP
27e0d6f8 MS	26	Notifiers \fBMUST\fR read IPP messages from the standard input using the
	27	.BR ippNew ()
	28	and
	29	.BR ippReadFile ()
	30	functions and exit on error.
	31	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.
	32	Notifiers inherit the environment and can use the logging mechanism documented in
	33	.BR filter (7).
6c663ae2	34	.SH SEE ALSO
27e0d6f8 MS	35	.BR cupsd (8),
	36	.BR filter (7),
	37	CUPS Online Help (http://localhost:631/help)
6c663ae2	38	.SH COPYRIGHT
bd5a2f28	39	Copyright \[co] 2007-2017 by Apple Inc.