[thirdparty/cups.git] / doc / help / man-notifier.html

<!DOCTYPE HTML>
<html>
<!-- SECTION: Man Pages -->
<head>
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	<title>notifier(7)</title>
</head>
<body>
<h1 class="title">notifier(7)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
notifier - cups notification interface
<h2 class="title"><a name="SYNOPSIS">Synopsis</a></h2>
<b>notifier</b>
<i>recipient</i>
[
<i>user-data</i>
]
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
The CUPS notifier interface provides a standard method for adding support for
new event notification methods to CUPS. Each notifier delivers one or more IPP
events from the standard input to the specified recipient.
<p>Notifiers <b>must</b> read IPP messages from the standard input using the
ippNew and ippReadFile functions and exit on error. Notifiers are encouraged to
exit after a suitable period of inactivity, however they may exit after reading
the first message or stay running until an error is seen.
<h2 class="title"><a name="LOG_MESSAGES">Log Messages</a></h2>
Messages sent to stderr are generally logged to the current <i>ErrorLog</i>.
Each line begins with a standard prefix:

<p style="margin-left: 5.0em; text-indent: -5.0em">ALERT: message
<br>
<br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "alert" log level.

<p style="margin-left: 5.0em; text-indent: -5.0em">CRIT: message
<br>
<br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "critical" log level.

<p style="margin-left: 5.0em; text-indent: -5.0em">DEBUG: message
<br>
<br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "debug" log level.

<p style="margin-left: 5.0em; text-indent: -5.0em">DEBUG2: message
<br>
<br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "debug2" log level.

<p style="margin-left: 5.0em; text-indent: -5.0em">EMERG: message
<br>
<br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "emergency" log level.

<p style="margin-left: 5.0em; text-indent: -5.0em">ERROR: message
<br>
<br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "error" log level.

<p style="margin-left: 5.0em; text-indent: -5.0em">INFO: message
<br>
<br>
Sets the printer-state-message attribute. If the current <i>LogLevel</i>
is set to "debug2", also adds the specified message to the
current <i>ErrorLog</i> using the "info" log level.

<p style="margin-left: 5.0em; text-indent: -5.0em">NOTICE: message
<br>
<br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "notice" log level.

<p style="margin-left: 5.0em; text-indent: -5.0em">WARNING: message
<br>
<br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "warning" log level.

<h2 class="title"><a name="ENVIRONMENT_VARIABLES">Environment Variables</a></h2>
The following environment variables are defined by the CUPS server when
executing the notifier:

<p style="margin-left: 5.0em; text-indent: -5.0em">CHARSET
<br>
<br>
The default text character set, typically utf-8.

<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_CACHEDIR
<br>
<br>
The directory for semi-persistent cache files can be found.

<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_DATADIR
<br>
<br>
The directory where data files can be found.

<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_FILETYPE
<br>
<br>
The type of file being printed: "job-sheet" for a banner page and "document"
for a regular print file.

<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_SERVERROOT
<br>
<br>
The root directory of the server.

<p style="margin-left: 5.0em; text-indent: -5.0em">LANG
<br>
<br>
The default language locale (typically C or en).

<p style="margin-left: 5.0em; text-indent: -5.0em">PATH
<br>
<br>
The standard execution path for external programs that may be run by
the filter.

<p style="margin-left: 5.0em; text-indent: -5.0em">SOFTWARE
<br>
<br>
The name and version number of the server (typically CUPS/1.2).

<p style="margin-left: 5.0em; text-indent: -5.0em">TZ
<br>
<br>
The timezone of the server.

<p style="margin-left: 5.0em; text-indent: -5.0em">USER
<br>
<br>
The user executing the filter, typically "lp"; consult the <i>cupsd.conf(5)</i>
file for the current setting.

<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<i>backend(7)</i>, <i>cupsd(8)</i>, <i>filter(7)</i>,
<br>
<a href="http://localhost:631/help">http://localhost:631/help</a>
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright 2007-2013 by Apple Inc.

</body>
</html>
Commit	Line	Data
c277f98c	1	<!DOCTYPE HTML>
94436c5a MS	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>
c277f98c MS	13	<b>notifier</b>
	14	<i>recipient</i>
	15	[
	16	<i>user-data</i>
	17	]
94436c5a MS	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
c277f98c MS	30	<p style="margin-left: 5.0em; text-indent: -5.0em">ALERT: message
	31	<br>
	32	<br>
	33	Sets the printer-state-message attribute and adds the specified
94436c5a MS	34	message to the current <i>ErrorLog</i> using the "alert" log level.
94436c5a MS	35
c277f98c MS	36	<p style="margin-left: 5.0em; text-indent: -5.0em">CRIT: message
	37	<br>
	38	<br>
	39	Sets the printer-state-message attribute and adds the specified
94436c5a MS	40	message to the current <i>ErrorLog</i> using the "critical" log level.
94436c5a MS	41
c277f98c MS	42	<p style="margin-left: 5.0em; text-indent: -5.0em">DEBUG: message
	43	<br>
	44	<br>
	45	Sets the printer-state-message attribute and adds the specified
94436c5a MS	46	message to the current <i>ErrorLog</i> using the "debug" log level.
94436c5a MS	47
c277f98c MS	48	<p style="margin-left: 5.0em; text-indent: -5.0em">DEBUG2: message
	49	<br>
	50	<br>
	51	Sets the printer-state-message attribute and adds the specified
94436c5a MS	52	message to the current <i>ErrorLog</i> using the "debug2" log level.
94436c5a MS	53
c277f98c MS	54	<p style="margin-left: 5.0em; text-indent: -5.0em">EMERG: message
	55	<br>
	56	<br>
	57	Sets the printer-state-message attribute and adds the specified
94436c5a MS	58	message to the current <i>ErrorLog</i> using the "emergency" log level.
94436c5a MS	59
c277f98c MS	60	<p style="margin-left: 5.0em; text-indent: -5.0em">ERROR: message
	61	<br>
	62	<br>
	63	Sets the printer-state-message attribute and adds the specified
94436c5a MS	64	message to the current <i>ErrorLog</i> using the "error" log level.
94436c5a MS	65
c277f98c MS	66	<p style="margin-left: 5.0em; text-indent: -5.0em">INFO: message
	67	<br>
	68	<br>
	69	Sets the printer-state-message attribute. If the current <i>LogLevel</i>
94436c5a MS	70	is set to "debug2", also adds the specified message to the
	71	current <i>ErrorLog</i> using the "info" log level.
	72
c277f98c MS	73	<p style="margin-left: 5.0em; text-indent: -5.0em">NOTICE: message
	74	<br>
	75	<br>
	76	Sets the printer-state-message attribute and adds the specified
94436c5a MS	77	message to the current <i>ErrorLog</i> using the "notice" log level.
94436c5a MS	78
c277f98c MS	79	<p style="margin-left: 5.0em; text-indent: -5.0em">WARNING: message
	80	<br>
	81	<br>
	82	Sets the printer-state-message attribute and adds the specified
94436c5a MS	83	message to the current <i>ErrorLog</i> using the "warning" log level.
94436c5a MS	84
94436c5a MS	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:
	88
c277f98c MS	89	<p style="margin-left: 5.0em; text-indent: -5.0em">CHARSET
	90	<br>
	91	<br>
	92	The default text character set, typically utf-8.
	93
	94	<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_CACHEDIR
	95	<br>
	96	<br>
	97	The directory for semi-persistent cache files can be found.
	98
	99	<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_DATADIR
	100	<br>
	101	<br>
	102	The directory where data files can be found.
	103
	104	<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_FILETYPE
	105	<br>
	106	<br>
	107	The type of file being printed: "job-sheet" for a banner page and "document"
94436c5a MS	108	for a regular print file.
94436c5a MS	109
c277f98c MS	110	<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_SERVERROOT
	111	<br>
	112	<br>
	113	The root directory of the server.
	114
	115	<p style="margin-left: 5.0em; text-indent: -5.0em">LANG
	116	<br>
	117	<br>
	118	The default language locale (typically C or en).
	119
	120	<p style="margin-left: 5.0em; text-indent: -5.0em">PATH
	121	<br>
	122	<br>
	123	The standard execution path for external programs that may be run by
94436c5a MS	124	the filter.
94436c5a MS	125
c277f98c MS	126	<p style="margin-left: 5.0em; text-indent: -5.0em">SOFTWARE
	127	<br>
	128	<br>
	129	The name and version number of the server (typically CUPS/1.2).
	130
	131	<p style="margin-left: 5.0em; text-indent: -5.0em">TZ
	132	<br>
	133	<br>
	134	The timezone of the server.
	135
	136	<p style="margin-left: 5.0em; text-indent: -5.0em">USER
	137	<br>
	138	<br>
	139	The user executing the filter, typically "lp"; consult the <i>cupsd.conf(5)</i>
94436c5a MS	140	file for the current setting.
94436c5a MS	141
94436c5a	142	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
c277f98c	143	<i>backend(7)</i>, <i>cupsd(8)</i>, <i>filter(7)</i>,
94436c5a	144	<br>
c277f98c	145	<a href="http://localhost:631/help">http://localhost:631/help</a>
94436c5a MS	146	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
	147	Copyright 2007-2013 by Apple Inc.
	148
	149	</body>
	150	</html>