3 <!-- SECTION: Man Pages -->
5 <link rel=
"stylesheet" type=
"text/css" href=
"../cups-printable.css">
6 <title>notifier(
7)
</title>
9 <h1 class=
"title">notifier(
7)
</h1>
10 <h2 class=
"title"><a name=
"NAME">Name
</a></h2>
11 notifier - cups notification interface
12 <h2 class=
"title"><a name=
"SYNOPSIS">Synopsis
</a></h2>
18 <h2 class=
"title"><a name=
"DESCRIPTION">Description
</a></h2>
19 The CUPS notifier interface provides a standard method for adding support for
20 new event notification methods to CUPS. Each notifier delivers one or more IPP
21 events from the standard input to the specified recipient.
22 <p>Notifiers
<b>must
</b> read IPP messages from the standard input using the
23 ippNew and ippReadFile functions and exit on error. Notifiers are encouraged to
24 exit after a suitable period of inactivity, however they may exit after reading
25 the first message or stay running until an error is seen.
26 <h2 class=
"title"><a name=
"LOG_MESSAGES">Log Messages
</a></h2>
27 Messages sent to stderr are generally logged to the current
<i>ErrorLog
</i>.
28 Each line begins with a standard prefix:
30 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ALERT: message
33 Sets the printer-state-message attribute and adds the specified
34 message to the current
<i>ErrorLog
</i> using the
"alert" log level.
36 <p style=
"margin-left: 5.0em; text-indent: -5.0em">CRIT: message
39 Sets the printer-state-message attribute and adds the specified
40 message to the current
<i>ErrorLog
</i> using the
"critical" log level.
42 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DEBUG: message
45 Sets the printer-state-message attribute and adds the specified
46 message to the current
<i>ErrorLog
</i> using the
"debug" log level.
48 <p style=
"margin-left: 5.0em; text-indent: -5.0em">DEBUG2: message
51 Sets the printer-state-message attribute and adds the specified
52 message to the current
<i>ErrorLog
</i> using the
"debug2" log level.
54 <p style=
"margin-left: 5.0em; text-indent: -5.0em">EMERG: message
57 Sets the printer-state-message attribute and adds the specified
58 message to the current
<i>ErrorLog
</i> using the
"emergency" log level.
60 <p style=
"margin-left: 5.0em; text-indent: -5.0em">ERROR: message
63 Sets the printer-state-message attribute and adds the specified
64 message to the current
<i>ErrorLog
</i> using the
"error" log level.
66 <p style=
"margin-left: 5.0em; text-indent: -5.0em">INFO: message
69 Sets the printer-state-message attribute. If the current
<i>LogLevel
</i>
70 is set to
"debug2", also adds the specified message to the
71 current
<i>ErrorLog
</i> using the
"info" log level.
73 <p style=
"margin-left: 5.0em; text-indent: -5.0em">NOTICE: message
76 Sets the printer-state-message attribute and adds the specified
77 message to the current
<i>ErrorLog
</i> using the
"notice" log level.
79 <p style=
"margin-left: 5.0em; text-indent: -5.0em">WARNING: message
82 Sets the printer-state-message attribute and adds the specified
83 message to the current
<i>ErrorLog
</i> using the
"warning" log level.
85 <h2 class=
"title"><a name=
"ENVIRONMENT_VARIABLES">Environment Variables
</a></h2>
86 The following environment variables are defined by the CUPS server when
87 executing the notifier:
89 <p style=
"margin-left: 5.0em; text-indent: -5.0em">CHARSET
92 The default text character set, typically utf-
8.
94 <p style=
"margin-left: 5.0em; text-indent: -5.0em">CUPS_CACHEDIR
97 The directory for semi-persistent cache files can be found.
99 <p style=
"margin-left: 5.0em; text-indent: -5.0em">CUPS_DATADIR
102 The directory where data files can be found.
104 <p style=
"margin-left: 5.0em; text-indent: -5.0em">CUPS_FILETYPE
107 The type of file being printed:
"job-sheet" for a banner page and
"document"
108 for a regular print file.
110 <p style=
"margin-left: 5.0em; text-indent: -5.0em">CUPS_SERVERROOT
113 The root directory of the server.
115 <p style=
"margin-left: 5.0em; text-indent: -5.0em">LANG
118 The default language locale (typically C or en).
120 <p style=
"margin-left: 5.0em; text-indent: -5.0em">PATH
123 The standard execution path for external programs that may be run by
126 <p style=
"margin-left: 5.0em; text-indent: -5.0em">SOFTWARE
129 The name and version number of the server (typically CUPS/
1.2).
131 <p style=
"margin-left: 5.0em; text-indent: -5.0em">TZ
134 The timezone of the server.
136 <p style=
"margin-left: 5.0em; text-indent: -5.0em">USER
139 The user executing the filter, typically
"lp"; consult the
<i>cupsd.conf(
5)
</i>
140 file for the current setting.
142 <h2 class=
"title"><a name=
"SEE_ALSO">See Also
</a></h2>
143 <i>backend(
7)
</i>,
<i>cupsd(
8)
</i>,
<i>filter(
7)
</i>,
145 <a href=
"http://localhost:631/help">http://localhost:
631/help
</a>
146 <h2 class=
"title"><a name=
"COPYRIGHT">Copyright
</a></h2>
147 Copyright
2007-
2013 by Apple Inc.