[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:

<dl class="man">
<dt>ALERT: message
<dd style="margin-left: 5.0em"><br>
Sets the printer-state-message attribute and adds the specified
message to the current <i>ErrorLog</i> using the "alert" log level.

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

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

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

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

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

<dt>INFO: message
<dd style="margin-left: 5.0em"><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.

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

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

</dl>
<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:

<dl class="man">
<dt>CHARSET
<dd style="margin-left: 5.0em"><br>
The default text character set, typically utf-8.

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

<dt>CUPS_DATADIR
<dd style="margin-left: 5.0em"><br>
The directory where data files can be found.

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

<dt>CUPS_SERVERROOT
<dd style="margin-left: 5.0em"><br>
The root directory of the server.

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

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

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

<dt>TZ
<dd style="margin-left: 5.0em"><br>
The timezone of the server.

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

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