ヤミRoot VoidGate

Viewing: Gaim::Log::Mailer.3pm

.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mailer 3"
.TH Mailer 3 "2008-03-04" "perl v5.16.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Gaim::Log::Mailer \- Have your Gaim/Pidgin logs mailed to you
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use Gaim::Log::Mailer;
\&    my $mailer = Gaim::Log::Mailer\->new();
\&    $mailer\->process();
\&
\&    # ~/.gaimlogmailer.yml
\&     logfile:  /tmp/gaimlogmailer.log
\&     email_to: foo@bar.com
\&     min_age:  3600
\&     throttle_interval:   3600
\&     throttle_max_emails: 10
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Have you ever wanted to look at the content of an \s-1IM\s0 conversation you had
earlier? But you couldn't, because you had the conversation on a different
system than the one you're using now? You need to centralize your 
Gaim/Pidgin logs.
.PP
Gaim::Log::Mailer figures out if you have new \s-1IM\s0 conversations
in your Gaim log directory and mails them to your account, so you have
them available in your email, which you can check, wherever you are.
.PP
This module comes with a script \f(CW\*(C`gaimlogmailer\*(C'\fR which just reads in
a \s-1YAML\s0 configuration file (usually ~/.gaimlogmailer.yml>, then processes
availabe logs up to an adjustable threshold, sends them nicely formatted
to the specified email address and then exits.
.PP
It is recommended that you run this script in a cronjob, to make sure all
new \s-1IM\s0 conversations are picked up and forwarded. For example, here's 
a cronjob that runs \f(CW\*(C`gaimlogmailer\*(C'\fR every hour on the 13th minute:
.PP
.Vb 2
\&    $ crontab \-l
\&    13 * * * * /path/to/gaimlogmailer
.Ve
.SS "Configuration"
.IX Subsection "Configuration"
The configuration file \f(CW\*(C`~/.gaimlogmailer.yml\*(C'\fR specifies a number
of parameters that \f(CW\*(C`gaimlogmailer\*(C'\fR needs to operate. They are given
in \s-1YAML\s0 format, which basically just means
.PP
.Vb 2
\&    # comment
\&    key: value
.Ve
.PP
and comment lines are ignored. Strings need to be enclosed in quotes.
For details on this format, check http://yaml.org.
.PP
Here are the parameters in detail:
.IP "email_to" 4
.IX Item "email_to"
(Mandatory) The email address the script sends the log to.
.IP "logfile" 4
.IX Item "logfile"
(Optional) The log file where the script logs all activity, using Log4perl.
.Sp
.Vb 1
\&    logfile: "/tmp/gaimlogmailer.log"
.Ve
.Sp
(Note the quotes, \s-1YAML\s0 insists on them here).
.IP "min_age" 4
.IX Item "min_age"
(Optional, defaults to 3600). The minimum number of seconds a log file
needs to stay untouched by the Gaim application before the mailer
processes it. Reason for this is that there is no way to figure out 
if Gaim is done writing a log
file or if it will still append to it at some point.
.Sp
The mailer knows this and won't mail a file that has
a modification date younger than \f(CW\*(C`min_age\*(C'\fR seconds in the past to make
sure no half-written log files are processed. However, this method isn't
bullet-proof, and the mailer deals with this situation: if the mailer 
notices that an already processed file has new data, it will process
it again. This way, you'll get two emails, so make sure this happens
rarely and choose min_age accordingly and wisely.
.IP "throttle_interval" 4
.IX Item "throttle_interval"
(Optional, defaults to 3600/10).
A new installation of gaimlogmailer might find thousands of logfiles which
need to be mailed out one by one. To avoid overwhelming the mail system
or triggering spam filters, the number of emails can be limited to 
\&\f(CW\*(C`throttle_max_emails\*(C'\fR per \f(CW\*(C`throttle_interval\*(C'\fR.
.Sp
For example, if you want gaimlogmailer to only send a maximum of 10
emails per hour, set
.Sp
.Vb 2
\&    throttle_interval:   3600
\&    throttle_max_emails: 10
.Ve
.Sp
in your configuration file. Even if the script is rate-limited in this
way, it'll pick up slowly and handle all logs eventually.
.IP "throttle_max_emails" 4
.IX Item "throttle_max_emails"
See \f(CW\*(C`throttle_interval\*(C'\fR.
.IP "exclude_words" 4
.IX Item "exclude_words"
A list of blank-separated words
.Sp
.Vb 2
\&    # configuration file
\&    exclude_words: maybe thanks thx doesn hey put already
.Ve
.IP "languages" 4
.IX Item "languages"
A blank-separated list of languages the term extractor should try.
.Sp
.Vb 2
\&    # Try English and German
\&    languages: en de
.Ve
.SS "Mail Preferences"
.IX Subsection "Mail Preferences"
Gaim::Log::Mailer uses Mail::DWIM to send out mail. By default, it uses
a sendmail daemon on the local machine, if you want something else, you
can change the local .maildwim file and specify a different transport
(e.g. \s-1SMTP\s0). See the Mail::DWIM documentation for details.
.SS "References"
.IX Subsection "References"
This module is based on an article I wrote for the German Linux Magazine,
where \s-1IM\s0 logs were sent to an \s-1IMAP\s0 server:
http://www.linux\-magazin.de/heft_abo/ausgaben/2007/06/gespraechsprotokolle
.SH "LEGALESE"
.IX Header "LEGALESE"
Copyright 2008 by Mike Schilli, all rights reserved.
This program is free software, you can redistribute it and/or
modify it under the same terms as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
2008, Mike Schilli <cpan@perlmeister.com>
User / IP	: 216.73.216.2
Host / Server	: 146.88.233.70 / dev.loger.cm
System	: Linux hybrid1120.fr.ns.planethoster.net 3.10.0-957.21.2.el7.x86_64 #1 SMP Wed Jun 5 14:26:44 UTC 2019 x86_64