1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
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:
34 <dd>Sets the printer-state-message attribute and adds the specified
35 message to the current
<i>ErrorLog
</i> using the
"alert" log level.
41 <dd>Sets the printer-state-message attribute and adds the specified
42 message to the current
<i>ErrorLog
</i> using the
"critical" log level.
48 <dd>Sets the printer-state-message attribute and adds the specified
49 message to the current
<i>ErrorLog
</i> using the
"debug" log level.
55 <dd>Sets the printer-state-message attribute and adds the specified
56 message to the current
<i>ErrorLog
</i> using the
"debug2" log level.
62 <dd>Sets the printer-state-message attribute and adds the specified
63 message to the current
<i>ErrorLog
</i> using the
"emergency" log level.
69 <dd>Sets the printer-state-message attribute and adds the specified
70 message to the current
<i>ErrorLog
</i> using the
"error" log level.
76 <dd>Sets the printer-state-message attribute. If the current
<i>LogLevel
</i>
77 is set to
"debug2", also adds the specified message to the
78 current
<i>ErrorLog
</i> using the
"info" log level.
84 <dd>Sets the printer-state-message attribute and adds the specified
85 message to the current
<i>ErrorLog
</i> using the
"notice" log level.
91 <dd>Sets the printer-state-message attribute and adds the specified
92 message to the current
<i>ErrorLog
</i> using the
"warning" log level.
96 <h2 class=
"title"><a name=
"ENVIRONMENT_VARIABLES">Environment Variables
</a></h2>
97 The following environment variables are defined by the CUPS server when
98 executing the notifier:
104 <dd>The default text character set, typically utf-
8.
110 <dd>The directory for semi-persistent cache files can be found.
116 <dd>The directory where data files can be found.
122 <dd>The type of file being printed:
"job-sheet" for a banner page and
"document"
123 for a regular print file.
129 <dd>The root directory of the server.
135 <dd>The default language locale (typically C or en).
141 <dd>The standard execution path for external programs that may be run by
148 <dd>The name and version number of the server (typically CUPS/
1.2).
154 <dd>The timezone of the server.
160 <dd>The user executing the filter, typically
"lp"; consult the
<a href='man-cupsd.conf.html?TOPIC=Man+Pages'
>cupsd.conf(
5)
</a>
161 file for the current setting.
165 <h2 class=
"title"><a name=
"SEE_ALSO">See Also
</a></h2>
166 <a href='man-backend.html?TOPIC=Man+Pages'
>backend(
7)
</a>,
<a href='man-cupsd.html?TOPIC=Man+Pages'
>cupsd(
8)
</a>,
<a href='man-filter.html?TOPIC=Man+Pages'
>filter(
7)
</a>,
168 <a href='http://localhost:
631/help'
>http://localhost:
631/help
</a>
169 <h2 class=
"title"><a name=
"COPYRIGHT">Copyright
</a></h2>
170 Copyright
2007-
2013 by Apple Inc.