1notifier(7) Apple Inc. notifier(7)
2
3
4
6 notifier - cups notification interface
7
9 notifier recipient [ user-data ]
10
12 The CUPS notifier interface provides a standard method for adding sup‐
13 port for new event notification methods to CUPS. Each notifier delivers
14 one or more IPP events from the standard input to the specified recipi‐
15 ent.
16
17 Notifiers must read IPP messages from the standard input using the ipp‐
18 New and ippReadFile functions and exit on error. Notifiers are encour‐
19 aged to exit after a suitable period of inactivity, however they may
20 exit after reading the first message or stay running until an error is
21 seen.
22
24 Messages sent to stderr are generally logged to the current ErrorLog.
25 Each line begins with a standard prefix:
26
27
28 ALERT: message
29 Sets the printer-state-message attribute and adds the specified
30 message to the current ErrorLog using the "alert" log level.
31
32
33 CRIT: message
34 Sets the printer-state-message attribute and adds the specified
35 message to the current ErrorLog using the "critical" log level.
36
37
38 DEBUG: message
39 Sets the printer-state-message attribute and adds the specified
40 message to the current ErrorLog using the "debug" log level.
41
42
43 DEBUG2: message
44 Sets the printer-state-message attribute and adds the specified
45 message to the current ErrorLog using the "debug2" log level.
46
47
48 EMERG: message
49 Sets the printer-state-message attribute and adds the specified
50 message to the current ErrorLog using the "emergency" log level.
51
52
53 ERROR: message
54 Sets the printer-state-message attribute and adds the specified
55 message to the current ErrorLog using the "error" log level.
56
57
58 INFO: message
59 Sets the printer-state-message attribute. If the current LogLevel
60 is set to "debug2", also adds the specified message to the current
61 ErrorLog using the "info" log level.
62
63
64 NOTICE: message
65 Sets the printer-state-message attribute and adds the specified
66 message to the current ErrorLog using the "notice" log level.
67
68
69 WARNING: message
70 Sets the printer-state-message attribute and adds the specified
71 message to the current ErrorLog using the "warning" log level.
72
73
75 The following environment variables are defined by the CUPS server when
76 executing the notifier:
77
78
79 CHARSET
80 The default text character set, typically utf-8.
81
82
83 CUPS_CACHEDIR
84 The directory for semi-persistent cache files can be found.
85
86
87 CUPS_DATADIR
88 The directory where data files can be found.
89
90
91 CUPS_FILETYPE
92 The type of file being printed: "job-sheet" for a banner page and
93 "document" for a regular print file.
94
95
96 CUPS_SERVERROOT
97 The root directory of the server.
98
99
100 LANG
101 The default language locale (typically C or en).
102
103
104 PATH
105 The standard execution path for external programs that may be run
106 by the filter.
107
108
109 SOFTWARE
110 The name and version number of the server (typically CUPS/1.2).
111
112
113 TZ
114 The timezone of the server.
115
116
117 USER
118 The user executing the filter, typically "lp"; consult the
119 cupsd.conf(5) file for the current setting.
120
121
123 backend(7), cupsd(8), filter(7),
124 http://localhost:631/help
125
127 Copyright 2007-2009 by Apple Inc.
128
129
130
13112 May 2009 CUPS notifier(7)