doc/help/man-notifier.html

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