]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - man/notifier.7
Greatly simplify the man page handling.
[thirdparty/cups.git] / man / notifier.7
diff --git a/man/notifier.7 b/man/notifier.7
new file mode 100644 (file)
index 0000000..1ab226c
--- /dev/null
@@ -0,0 +1,36 @@
+.\"
+.\" notifier man page for CUPS.
+.\"
+.\" Copyright © 2007-2019 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" "26 April 2019" "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-2019 by Apple Inc.