pidgin/plugins/perl/common/Pidgin.pm

   1 package Pidgin;
   2
   3 use 5.008;
   4 use strict;
   5 use warnings;
   6 use Carp;
   7
   8 our $VERSION = '0.01';
   9
  10 use Purple;
  11
  12 require XSLoader;
  13 XSLoader::load('Pidgin', $VERSION);
  14
  15 1;
  16 __END__
  17
  18 =head1 NAME
  19
  20 Pidgin - Perl extension for the Pidgin instant messenger.
  21
  22 =head1 SYNOPSIS
  23
  24     use Pidgin;
  25
  26 =head1 ABSTRACT
  27
  28     This module provides the interface for using perl scripts as plugins in
  29     Pidgin, with access to the Pidgin Gtk interface functions.
  30
  31 =head1 DESCRIPTION
  32
  33 This module provides the interface for using perl scripts as plugins in Pidgin,
  34 with access to the Pidgin Gtk interface functions. With this, developers can
  35 write perl scripts that can be loaded in Pidgin as plugins. The script can
  36 interact with IMs, chats, accounts, the buddy list, pidgin signals, and more.
  37
  38 The API for the perl interface is very similar to that of the Pidgin C API,
  39 which can be viewed at http://developer.pidgin.im/doxygen/ or in the header files
  40 in the Pidgin source tree.
  41
  42 =head1 FUNCTIONS
  43
  44 =over
  45
  46 =back
  47
  48 =head1 SEE ALSO
  49 Pidgin C API documentation - http://developer.pidgin.im/doxygen/
  50
  51 The Pidgin perl module.
  52
  53 Pidgin website - http://pidgin.im/
  54
  55 =head1 AUTHOR
  56
  57 Etan Reisner, E<lt>deryni@gmail.comE<gt>
  58
  59 =head1 COPYRIGHT AND LICENSE
  60
  61 Copyright 2006 by Etan Reisner