.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 >0, 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 "Purple 3"
.TH Purple 3 2024-02-23 "perl v5.38.2" "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
Purple \- Perl extension to the libpurple instant messenger library.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Purple;
.Ve
.SH ABSTRACT
.IX Header "ABSTRACT"
.Vb 2
\&  This module provides the interface for using perl scripts as plugins
\&  in libpurple.
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides the interface for using perl scripts as plugins
in Purple. With this, developers can write perl scripts that can be
loaded in Purple as plugins. The scripts can interact with IMs, chats,
accounts, the buddy list, libpurple signals, and more.
.PP
The API for the perl interface is very similar to that of the Purple C
API, which can be viewed at http://developer.pidgin.im/doxygen/ or in
the header files in the Purple source tree.
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.ie n .IP "@accounts = Purple::accounts" 4
.el .IP "\f(CW@accounts\fR = Purple::accounts" 4
.IX Item "@accounts = Purple::accounts"
Returns a list of all accounts, online or offline.
.ie n .IP "@chats = Purple::chats" 4
.el .IP "\f(CW@chats\fR = Purple::chats" 4
.IX Item "@chats = Purple::chats"
Returns a list of all chats currently open.
.ie n .IP "@connections = Purple::connections" 4
.el .IP "\f(CW@connections\fR = Purple::connections" 4
.IX Item "@connections = Purple::connections"
Returns a list of all active connections.
.ie n .IP "@conversations = Purple::conversations" 4
.el .IP "\f(CW@conversations\fR = Purple::conversations" 4
.IX Item "@conversations = Purple::conversations"
Returns a list of all conversations, both IM and chat, currently open.
.ie n .IP "@conv_windows = Purple::conv_windows" 4
.el .IP "\f(CW@conv_windows\fR = Purple::conv_windows" 4
.IX Item "@conv_windows = Purple::conv_windows"
Returns a list of all conversation windows currently open.
.ie n .IP "@ims = Purple::ims" 4
.el .IP "\f(CW@ims\fR = Purple::ims" 4
.IX Item "@ims = Purple::ims"
Returns a list of all instant messages currently open.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Purple C API documentation \- http://developer.pidgin.im/doxygen/
.PP
Purple website \- http://pidgin.im/
.SH AUTHOR
.IX Header "AUTHOR"
Christian Hammond, <chipx86@gnupdate.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2003 by Christian Hammond
.PP
This library is free software; you can redistribute it and/or modify
it under the terms of the General Public License (GPL).  For
more information, see http://www.fsf.org/licenses/gpl.txt