ヤミRoot VoidGate

Viewing: Gaim::Log::Parser.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::Parser 3"
.TH Gaim::Log::Parser 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::Parser \- Parse Gaim's Log Files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Gaim::Log::Parser;
\&
\&    my $parser = Gaim::Log::Parser\->new(file => $filename);
\&
\&    while(my $msg = $parser\->next_message()) {
\&        print $msg\->as_string();
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Gaim::Log::Parser parses Gaim/Pidgin's log files. In the 1.4+ series, they are 
organized in the following way:
.PP
.Vb 1
\&    .gaim/logs/protocol/local_user/comm_partner/2005\-10\-29.230219.txt
.Ve
.PP
Make sure that your Gaim/Pidgin client has logging turned on and that
the logging format is set to 'text' (not html). If you have log files in
html format already, run the utility eg/gaimlog\-html2text to make
text format copies of existing html logs.
.SS "Methods"
.IX Subsection "Methods"
.ie n .IP """my $parser = Gaim::Log::Parser\-""new(file => $filename)>" 4
.el .IP "\f(CWmy $parser = Gaim::Log::Parser\-\fRnew(file => \f(CW$filename\fR)>" 4
.IX Item "my $parser = Gaim::Log::Parser-new(file => $filename)>"
Create a new log parser.
.Sp
The parser will interpret the message time stamps according to a selected
time zone.
.Sp
By default, the time zone is assumed to be 'local' which will try all
kinds of tricks to determine the local time zone. If this is not what you
want, a time zone for DateTime::TimeZone can be provided, e.g.
\&\*(L"America/Los_Angeles\*(R".
.ie n .IP """my $msg = $parser\->next_message()""" 4
.el .IP "\f(CWmy $msg = $parser\->next_message()\fR" 4
.IX Item "my $msg = $parser->next_message()"
Return the next message in the log. Returns an object of type
\&\f(CW\*(C`Gaim::Log::Message\*(C'\fR. Check its documentation for details.
.ie n .IP """my $dt = $parser\->datetime()""" 4
.el .IP "\f(CWmy $dt = $parser\->datetime()\fR" 4
.IX Item "my $dt = $parser->datetime()"
Retrieve the DateTime object used internally by
\&\f(CW\*(C`Gaim::Log::Parser\*(C'\fR. Can be used to obtain the 
the start date of the parsed log file or the time zone used.
.ie n .IP """$parser\->reset()""" 4
.el .IP "\f(CW$parser\->reset()\fR" 4
.IX Item "$parser->reset()"
Position the parser back to the beginning of the conversation. After
this has been completed, the next \fInext_message()\fR will return the 
first message in the log file.
.ie n .IP """my $str = $parser\->as_string()""" 4
.el .IP "\f(CWmy $str = $parser\->as_string()\fR" 4
.IX Item "my $str = $parser->as_string()"
Return the entire conversation as a nicely formatted text string.
By default, Text::Wrap's column with lines will be set to 70, if you
prefer a different width, specify it explicitely
.Sp
.Vb 1
\&    my $str = $parser\->as_string( {columns => 30} );
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gaim::Log::Finder, Gaim::Log::Message in this distribution
.SH "LEGALESE"
.IX Header "LEGALESE"
Copyright 2005\-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"
Mike Schilli <cpan@perlmeister.com>
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 371:" 4
.IX Item "Around line 371:"
You forgot a '=back' before '=head1'
.IP "Around line 375:" 4
.IX Item "Around line 375:"
=back without =over
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