]>
Commit | Line | Data |
---|---|---|
94436c5a MS |
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
2 | <html> | |
3 | <!-- SECTION: Man Pages --> | |
4 | <head> | |
5 | <link rel="stylesheet" type="text/css" href="../cups-printable.css"> | |
6 | <title>notifier(7)</title> | |
7 | </head> | |
8 | <body> | |
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> | |
13 | <b>notifier | |
14 | </b><i>recipient | |
15 | </i>[ | |
16 | <i>user-data | |
17 | </i>] | |
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: | |
29 | ||
30 | <dl> | |
31 | <dt>ALERT: message | |
32 | </dt> | |
33 | <dd></dd> | |
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. | |
36 | ||
37 | </dd> | |
38 | <dt>CRIT: message | |
39 | </dt> | |
40 | <dd></dd> | |
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. | |
43 | ||
44 | </dd> | |
45 | <dt>DEBUG: message | |
46 | </dt> | |
47 | <dd></dd> | |
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. | |
50 | ||
51 | </dd> | |
52 | <dt>DEBUG2: message | |
53 | </dt> | |
54 | <dd></dd> | |
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. | |
57 | ||
58 | </dd> | |
59 | <dt>EMERG: message | |
60 | </dt> | |
61 | <dd></dd> | |
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. | |
64 | ||
65 | </dd> | |
66 | <dt>ERROR: message | |
67 | </dt> | |
68 | <dd></dd> | |
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. | |
71 | ||
72 | </dd> | |
73 | <dt>INFO: message | |
74 | </dt> | |
75 | <dd></dd> | |
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. | |
79 | ||
80 | </dd> | |
81 | <dt>NOTICE: message | |
82 | </dt> | |
83 | <dd></dd> | |
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. | |
86 | ||
87 | </dd> | |
88 | <dt>WARNING: message | |
89 | </dt> | |
90 | <dd></dd> | |
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. | |
93 | ||
94 | </dd> | |
95 | </dl> | |
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: | |
99 | ||
100 | <dl> | |
101 | <dt>CHARSET | |
102 | </dt> | |
103 | <dd></dd> | |
104 | <dd>The default text character set, typically utf-8. | |
105 | ||
106 | </dd> | |
107 | <dt>CUPS_CACHEDIR | |
108 | </dt> | |
109 | <dd></dd> | |
110 | <dd>The directory for semi-persistent cache files can be found. | |
111 | ||
112 | </dd> | |
113 | <dt>CUPS_DATADIR | |
114 | </dt> | |
115 | <dd></dd> | |
116 | <dd>The directory where data files can be found. | |
117 | ||
118 | </dd> | |
119 | <dt>CUPS_FILETYPE | |
120 | </dt> | |
121 | <dd></dd> | |
122 | <dd>The type of file being printed: "job-sheet" for a banner page and "document" | |
123 | for a regular print file. | |
124 | ||
125 | </dd> | |
126 | <dt>CUPS_SERVERROOT | |
127 | </dt> | |
128 | <dd></dd> | |
129 | <dd>The root directory of the server. | |
130 | ||
131 | </dd> | |
132 | <dt>LANG | |
133 | </dt> | |
134 | <dd></dd> | |
135 | <dd>The default language locale (typically C or en). | |
136 | ||
137 | </dd> | |
138 | <dt>PATH | |
139 | </dt> | |
140 | <dd></dd> | |
141 | <dd>The standard execution path for external programs that may be run by | |
142 | the filter. | |
143 | ||
144 | </dd> | |
145 | <dt>SOFTWARE | |
146 | </dt> | |
147 | <dd></dd> | |
148 | <dd>The name and version number of the server (typically CUPS/1.2). | |
149 | ||
150 | </dd> | |
151 | <dt>TZ | |
152 | </dt> | |
153 | <dd></dd> | |
154 | <dd>The timezone of the server. | |
155 | ||
156 | </dd> | |
157 | <dt>USER | |
158 | </dt> | |
159 | <dd></dd> | |
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. | |
162 | ||
163 | </dd> | |
164 | </dl> | |
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>, | |
167 | <br> | |
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. | |
171 | ||
172 | </body> | |
173 | </html> |