torrus/doc/manpages/torrus_action_printemail.pod.in

   1 #  Copyright (C) 2004  Stanislav Sinyagin
   2 #
   3 #  This program is free software; you can redistribute it and/or modify
   4 #  it under the terms of the GNU General Public License as published by
   5 #  the Free Software Foundation; either version 2 of the License, or
   6 #  (at your option) any later version.
   7 #
   8 #  This program is distributed in the hope that it will be useful,
   9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 #  GNU General Public License for more details.
  12 #
  13 #  You should have received a copy of the GNU General Public License
  14 #  along with this program; if not, write to the Free Software
  15 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  16
  17 # $Id: torrus_action_printemail.pod.in,v 1.1 2010-12-27 00:04:38 ivan Exp $
  18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  19 #
  20 #
  21
  22 =head1 NAME
  23
  24 action_printemail - A script for sending email from monitor action.
  25
  26 =head1 SYNOPSIS
  27
  28  <action name="report-email">
  29    <param name="action-type" value="exec" />
  30    <param name="command">
  31      $TORRUS_BIN/action_printemail | mail alarms@example.com
  32    </param>
  33    <param name="launch-when" value="set, clear" />
  34  </action>
  35
  36 =head1 DESCRIPTION
  37
  38 This program is designed for usage from a monitor action only. It takes
  39 the arguments from environment variables, as described in action-type
  40 C<exec> in B<Torrus XML Configuration Guide>. In addition, some values
  41 may be supplied via command-line arguments (see section OPTIONS below).
  42
  43 Site-specific variables must be specified in the file F<email-siteconfig.pl>.
  44 Default values are installed by the first run of C<make install>. Subsequent
  45 runs of C<make install> do not override this file.
  46
  47 =head1 OPTIONS
  48
  49 =over 4
  50
  51 =item B<--url>=I<GRAPHER-URL>
  52
  53 Sets the URL of the grapher CGI script.
  54
  55 =item B<--template>=I<TEMPLATE-FILE>
  56
  57 Uses given file as a template. The template file must reside in @tmpldir@
  58 directory. It must be a Template-toolkit file, with the following variables
  59 defined:
  60
  61  tree       Tree name
  62  token      Leaf token
  63  path       Leaf path
  64  url        URL for browsing this leaf
  65  ncomment   This leaf comment
  66  npcomment  Leaf's parent comment
  67  event      Event type
  68  monitor    Monitor name
  69  mcomment   Monitor comment
  70  timestamp  Time and date of the event
  71  env(VAR)   Environment variable VAR
  72
  73 =back
  74
  75 =head1 FILES
  76
  77 =over 4
  78
  79 =item F<@siteconfdir@/email-siteconfig.pl>
  80
  81 Torrus site email configuration script.
  82
  83 =item F<@tmpldir@>
  84
  85 =item F<@tmpluserdir@>
  86
  87 Torrus template directories.
  88
  89 =back
  90
  91 =head1 SEE ALSO
  92
  93 L<torrus(@mansec_usercmd@)>
  94
  95 =head1 NOTES
  96
  97 See more documentation at Torrus home page: http://torrus.org
  98
  99 =head1 AUTHOR
 100
 101 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>