4 .\" notifier man page for CUPS.
6 .\" Copyright 2007-2009 by Apple Inc.
7 .\" Copyright 1997-2007 by Easy Software Products.
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/".
15 .TH notifier 7 "CUPS" "12 May 2009" "Apple Inc."
17 notifier \- cups notification interface
25 The CUPS notifier interface provides a standard method for adding support for
26 new event notification methods to CUPS. Each notifier delivers one or more IPP
27 events from the standard input to the specified recipient.
29 Notifiers \fBmust\fR read IPP messages from the standard input using the
30 ippNew and ippReadFile functions and exit on error. Notifiers are encouraged to
31 exit after a suitable period of inactivity, however they may exit after reading
32 the first message or stay running until an error is seen.
34 Messages sent to stderr are generally logged to the current \fIErrorLog\fR.
35 Each line begins with a standard prefix:
40 Sets the printer-state-message attribute and adds the specified
41 message to the current \fIErrorLog\fR using the "alert" log level.
46 Sets the printer-state-message attribute and adds the specified
47 message to the current \fIErrorLog\fR using the "critical" log level.
52 Sets the printer-state-message attribute and adds the specified
53 message to the current \fIErrorLog\fR using the "debug" log level.
58 Sets the printer-state-message attribute and adds the specified
59 message to the current \fIErrorLog\fR using the "debug2" log level.
64 Sets the printer-state-message attribute and adds the specified
65 message to the current \fIErrorLog\fR using the "emergency" log level.
70 Sets the printer-state-message attribute and adds the specified
71 message to the current \fIErrorLog\fR using the "error" log level.
76 Sets the printer-state-message attribute. If the current \fILogLevel\fR
77 is set to "debug2", also adds the specified message to the
78 current \fIErrorLog\fR using the "info" log level.
83 Sets the printer-state-message attribute and adds the specified
84 message to the current \fIErrorLog\fR using the "notice" log level.
89 Sets the printer-state-message attribute and adds the specified
90 message to the current \fIErrorLog\fR using the "warning" log level.
92 .SH ENVIRONMENT VARIABLES
93 The following environment variables are defined by the CUPS server when
94 executing the notifier:
99 The default text character set, typically utf-8.
104 The directory for semi-persistent cache files can be found.
109 The directory where data files can be found.
114 The type of file being printed: "job-sheet" for a banner page and "document"
115 for a regular print file.
120 The root directory of the server.
125 The default language locale (typically C or en).
130 The standard execution path for external programs that may be run by
136 The name and version number of the server (typically CUPS/1.2).
141 The timezone of the server.
146 The user executing the filter, typically "lp"; consult the \fIcupsd.conf(5)\fR
147 file for the current setting.
150 \fIbackend(7)\fR, \fIcupsd(8)\fR, \fIfilter(7)\fR,
152 http://localhost:631/help
154 Copyright 2007-2009 by Apple Inc.