ヤミRoot VoidGate

Viewing: Gaim::Log::Finder.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 "Gaim::Log::Finder 3"
.TH Gaim::Log::Finder 3 "2008-08-13" "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::Finder \- Find Gaim's Log Files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Gaim::Log::Finder;
\&
\&    my $finder = Gaim::Log::Finder\->new(
\&        callback => sub { print "Found $_[1]\en"; }
\&    );
\&
\&    $finder\->find();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Gaim::Log::Finder traverses through all known Gaim log file hierarchies
and calls back to the previously defined callback function every time
it finds a Gaim log file.
.SS "Methods"
.IX Subsection "Methods"
.ie n .IP """my $finder = Gaim::Log::Finder\-""new(callback => $coderef)>" 4
.el .IP "\f(CWmy $finder = Gaim::Log::Finder\-\fRnew(callback => \f(CW$coderef\fR)>" 4
.IX Item "my $finder = Gaim::Log::Finder-new(callback => $coderef)>"
The callback function that gets passed in as a code reference
will be called later for every log file found (see below).
.Sp
The finder will start in the \f(CW\*(C`.gaim/logs\*(C'\fR directory under the
current user's home directory. If it finds \f(CW\*(C`.purple/logs\*(C'\fR, which is the
log file location for gaim > 2.0 logs, it will use that instead.
If, for some reason you want to start
at a different location, pass it in as \f(CW\*(C`start_dir\*(C'\fR:
.Sp
.Vb 4
\&    my $finder = Gaim::Log::Finder\->new(
\&        callback  => sub { print "Found $_[0]\en"; },
\&        start_dir => "/tmp",
\&    );
.Ve
.ie n .IP """my $finder = $parser\->find()""" 4
.el .IP "\f(CWmy $finder = $parser\->find()\fR" 4
.IX Item "my $finder = $parser->find()"
Starts the finder, and will call the previously defined callback function
every time it finds a Gaim log file. It will pass the following parameters
to the callback function:
.Sp
.Vb 5
\&    sub gaim_log_callback {
\&        my($self, $logfile, $protocol, $local_user, 
\&           $remote_user, $file) = @_;
\&        # ...
\&    }
.Ve
.Sp
\&\f(CW$self\fR is an object reference to the finder itself. \f(CW$logfile\fR is the 
full path to the logfile. \f(CW$protocol\fR is the \s-1IM\s0 transport mechanism/provider 
used, this could be \f(CW\*(C`yahoo\*(C'\fR, \f(CW\*(C`aim\*(C'\fR, \f(CW\*(C`jabber\*(C'\fR or similar. \f(CW$local_user\fR
is the local user's userid. \f(CW$local_user\fR is the user's id who's at the
other end of the conversation. \f(CW$file\fR is the name of the text file.
.SH "LEGALESE"
.IX Header "LEGALESE"
Copyright 2007 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"
2007, 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