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

.\"
.\" "$Id: notifier.man 11924 2014-06-12 19:10:33Z msweet $"
.\"
.\" 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-2014 by Apple Inc.
.\"
.\" End of "$Id: notifier.man 11924 2014-06-12 19:10:33Z msweet $".
.\"
Commit	Line	Data
6c663ae2	1	.\"
1a18c85c	2	.\" "$Id: notifier.man 11924 2014-06-12 19:10:33Z msweet $"
6c663ae2	3	.\"
1a18c85c	4	.\" notifier man page for CUPS.
6c663ae2	5	.\"
1a18c85c MS	6	.\" Copyright 2007-2014 by Apple Inc.
1a18c85c MS	7	.\" Copyright 1997-2007 by Easy Software Products.
6c663ae2	8	.\"
1a18c85c MS	9	.\" These coded instructions, statements, and computer programs are the
	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/".
6c663ae2	14	.\"
1a18c85c	15	.TH notifier 7 "CUPS" "12 June 2014" "Apple Inc."
6c663ae2 MS	16	.SH NAME
	17	notifier \- cups notification interface
	18	.SH SYNOPSIS
	19	.B notifier
	20	.I recipient
	21	[
	22	.I user-data
	23	]
	24	.SH DESCRIPTION
1a18c85c MS	25	The CUPS notifier interface provides a standard method for adding support for new event notification methods to CUPS.
1a18c85c MS	26	Each notifier delivers one or more IPP events from the standard input to the specified recipient.
6c663ae2	27	.LP
1a18c85c MS	28	Notifiers \fBMUST\fR read IPP messages from the standard input using the
	29	.BR ippNew ()
	30	and
	31	.BR ippReadFile ()
	32	functions and exit on error.
	33	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.
	34	Notifiers inherit the environment and can use the logging mechanism documented in
	35	.BR filter (7).
6c663ae2	36	.SH SEE ALSO
1a18c85c MS	37	.BR cupsd (8),
	38	.BR filter (7),
	39	CUPS Online Help (http://localhost:631/help)
6c663ae2	40	.SH COPYRIGHT
1a18c85c	41	Copyright \[co] 2007-2014 by Apple Inc.
6c663ae2	42	.\"
1a18c85c	43	.\" End of "$Id: notifier.man 11924 2014-06-12 19:10:33Z msweet $".
6c663ae2	44	.\"