version update
[siplcs.git] / README
blob5ded7e76bbfed3cc0578cc41e0541775a12876c8
1 Introduction
2 ============
4 pidgin-sipe is a third-party plugin for the Pidgin multi-protocol instant
5 messenger. It implements the extended version of SIP/SIMPLE used by various
6 products:
8     * Microsoft Office Communications Server (OCS 2007/2007 R2 and newer)
9     * Microsoft Live Communications Server (LCS 2003/2005)
10     * Reuters Messaging
12 With this plugin you should be able to replace your Microsoft Office
13 Communicator client with Pidgin.
16 Features
17 ========
19 The plugin has support for
21     * Instant Messaging (IM)
22     * Multiparty chat
23     * Enhanced presence
24     * Calendar integration with Exchange 2007/2010
25     * Contact details information - company, phones, web site, etc.
26     * Contact search
27     * Encrypted file transfer
28     * Call initiation through PBX
29     * Kerberos and NTLMv2 authentication, TLS support
30     * Translated to many languages
33 Advantages over Office Communicator products
34 ============================================
36     * Available on broader range of platforms: Linux, *BSD, Maemo, OSX,
37       commercial UNIX, Windows.
38     * Ability to simultaneously connect to several Office Communicator 
39       accounts in addition to public IM network accounts like MSN, AOL,
40       Yahoo. For example one account is in vendor company and another is 
41       in client company.
42     * Keeps history of communications in environments without Outlook. For
43       example in companies where Lotus Notes is deployed as a default
44       groupware client instead of Outlook.
45     * Open development model, open source product. License is GPLv2+
48 Support
49 =======
51 The Pidgin project does not support third-party plugins! If you have problems
52 with this plugin then please check out the support forums:
54     http://sf.net/projects/sipe/forums/
56 Bugs should be reported here:
58     https://sourceforge.net/tracker/?atid=949931&group_id=194563
61 Localization
62 ============
64 SIPE has already been localized for several languages. You can help to
65 translate SIPE to your native language at Transifex:
67     http://transifex.net/projects/p/pidgin-sipe/c/mob-branch/
69 The service offers a convenient web editor and automatic submission to the
70 repository.
73 Installing from a distribution repository
74 =========================================
76 Many Open Source OS distributions have a ready-made package "pidgin-sipe".
77 Before trying to compile it from the source code yourself, you should try
78 to install this package with the standard installation method provided by
79 your OS.
82 Do It Yourself I: compiling against "pidgin" package
83 ====================================================
85 If you already have installed the "pidgin" package from your distribution
86 repository and want compile pidgin-sipe from source code yourself, then you
87 need to install the necessary headers first. Depending on your distribution
88 you'll need to install one of the following packages
90         libpurple-dev
91         libpurple-devel
93 For the compilation you'll need to install a C compiler and some of the
94 following packages
96         libtool
97         intltool
98         libglib2.0-dev
99         gettext-devel
101 Now you should be able to compile the source code with
103         ./configure --prefix=/usr
104         make
106 If you get errors then you are missing some required package. After
107 successful compilation you can install pidgin-sipe with:
109         su -c "make install"
112 Do It Yourself II: compiling against self-compiled pidgin
113 =========================================================
115 If you have compiled pidgin from source code yourself then you'll have to
116 specify the correct installation path in configure. Usually pidgin is
117 installed in /usr/local so the following command should work
119         ./configure --prefix=/usr/local
121 The rest of the steps are the same as in the previous section.