man/notifier.man

   1 .\"
   2 .\" "$Id$"
   3 .\"
   4 .\"   notifier man page for CUPS.
   5 .\"
   6 .\"   Copyright 2007-2012 by Apple Inc.
   7 .\"   Copyright 1997-2007 by Easy Software Products.
   8 .\"
   9 .\"   These coded instructions, statements, and computer programs are the
  10 .\"   property of Apple Inc. and are protected by Federal copyright
  11 .\"   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  12 .\"   which should have been included with this file.  If this file is
  13 .\"   file is missing or damaged, see the license at "http://www.cups.org/".
  14 .\"
  15 .TH notifier 7 "CUPS" "12 May 2009" "Apple Inc."
  16 .SH NAME
  17 notifier \- cups notification interface
  18 .SH SYNOPSIS
  19 .B notifier
  20 .I recipient
  21 [
  22 .I user-data
  23 ]
  24 .SH DESCRIPTION
  25 The CUPS notifier interface provides a standard method for adding support for
  26 new event notification methods to CUPS. Each notifier delivers one or more IPP
  27 events from the standard input to the specified recipient.
  28 .LP
  29 Notifiers \fBmust\fR read IPP messages from the standard input using the
  30 ippNew and ippReadFile functions and exit on error. Notifiers are encouraged to
  31 exit after a suitable period of inactivity, however they may exit after reading
  32 the first message or stay running until an error is seen.
  33 .SH LOG MESSAGES
  34 Messages sent to stderr are generally logged to the current \fIErrorLog\fR.
  35 Each line begins with a standard prefix:
  36
  37 .TP 5
  38 ALERT: message
  39 .br
  40 Sets the printer-state-message attribute and adds the specified
  41 message to the current \fIErrorLog\fR using the "alert" log level.
  42
  43 .TP 5
  44 CRIT: message
  45 .br
  46 Sets the printer-state-message attribute and adds the specified
  47 message to the current \fIErrorLog\fR using the "critical" log level.
  48
  49 .TP 5
  50 DEBUG: message
  51 .br
  52 Sets the printer-state-message attribute and adds the specified
  53 message to the current \fIErrorLog\fR using the "debug" log level.
  54
  55 .TP 5
  56 DEBUG2: message
  57 .br
  58 Sets the printer-state-message attribute and adds the specified
  59 message to the current \fIErrorLog\fR using the "debug2" log level.
  60
  61 .TP 5
  62 EMERG: message
  63 .br
  64 Sets the printer-state-message attribute and adds the specified
  65 message to the current \fIErrorLog\fR using the "emergency" log level.
  66
  67 .TP 5
  68 ERROR: message
  69 .br
  70 Sets the printer-state-message attribute and adds the specified
  71 message to the current \fIErrorLog\fR using the "error" log level.
  72
  73 .TP 5
  74 INFO: message
  75 .br
  76 Sets the printer-state-message attribute. If the current \fILogLevel\fR
  77 is set to "debug2", also adds the specified message to the
  78 current \fIErrorLog\fR using the "info" log level.
  79
  80 .TP 5
  81 NOTICE: message
  82 .br
  83 Sets the printer-state-message attribute and adds the specified
  84 message to the current \fIErrorLog\fR using the "notice" log level.
  85
  86 .TP 5
  87 WARNING: message
  88 .br
  89 Sets the printer-state-message attribute and adds the specified
  90 message to the current \fIErrorLog\fR using the "warning" log level.
  91
  92 .SH ENVIRONMENT VARIABLES
  93 The following environment variables are defined by the CUPS server when
  94 executing the notifier:
  95
  96 .TP 5
  97 CHARSET
  98 .br
  99 The default text character set, typically utf-8.
 100
 101 .TP 5
 102 CUPS_CACHEDIR
 103 .br
 104 The directory for semi-persistent cache files can be found.
 105
 106 .TP 5
 107 CUPS_DATADIR
 108 .br
 109 The directory where data files can be found.
 110
 111 .TP 5
 112 CUPS_FILETYPE
 113 .br
 114 The type of file being printed: "job-sheet" for a banner page and "document"
 115 for a regular print file.
 116
 117 .TP 5
 118 CUPS_SERVERROOT
 119 .br
 120 The root directory of the server.
 121
 122 .TP 5
 123 LANG
 124 .br
 125 The default language locale (typically C or en).
 126
 127 .TP 5
 128 PATH
 129 .br
 130 The standard execution path for external programs that may be run by
 131 the filter.
 132
 133 .TP 5
 134 SOFTWARE
 135 .br
 136 The name and version number of the server (typically CUPS/1.2).
 137
 138 .TP 5
 139 TZ
 140 .br
 141 The timezone of the server.
 142
 143 .TP 5
 144 USER
 145 .br
 146 The user executing the filter, typically "lp"; consult the \fIcupsd.conf(5)\fR
 147 file for the current setting.
 148
 149 .SH SEE ALSO
 150 \fIbackend(7)\fR, \fIcupsd(8)\fR, \fIfilter(7)\fR,
 151 .br
 152 http://localhost:631/help
 153 .SH COPYRIGHT
 154 Copyright 2007-2012 by Apple Inc.
 155 .\"
 156 .\" End of "$Id$".
 157 .\"