core cleanup: the final chapter
[siplcs.git] / README
blob3f7b9c2f5d4a99ea02851a73891774b72a58c36d
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     * Lotus Notes/Domino calendar integration. Unique to SIPE.
46     * Open development model, open source product. License is GPLv2+
49 Support
50 =======
52 The Pidgin project does not support third-party plugins! If you have problems
53 with this plugin then please check out the support forums:
55     http://sf.net/projects/sipe/forums/
57 Bugs should be reported here:
59     https://sourceforge.net/tracker/?atid=949931&group_id=194563
62 Localization
63 ============
65 SIPE has already been localized for several languages. You can help to
66 translate SIPE to your native language at Transifex:
68     https://www.transifex.net/projects/p/pidgin-sipe/r/mob/
70 The service offers a convenient web editor and automatic submission to the
71 repository.
74 Installing from a distribution repository
75 =========================================
77 Many Open Source OS distributions have a ready-made package "pidgin-sipe".
78 Before trying to compile it from the source code yourself, you should try
79 to install this package with the standard installation method provided by
80 your OS.
83 Do It Yourself I: compiling against "pidgin" package
84 ====================================================
86 If you already have installed the "pidgin" package from your distribution
87 repository and want compile pidgin-sipe from source code yourself, then you
88 need to install the necessary headers first. Depending on your distribution
89 you'll need to install one of the following packages
91         libpurple-dev
92         libpurple-devel
94 For the compilation you'll need to install a C compiler and some of the
95 following packages
97         libtool
98         intltool
99         libglib2.0-dev
100         libglib2-devel
101         libxml2-dev
102         libxml2-devel
103         libnss3-dev
104         nss-devel
105         mozilla-nss-devel
106         gettext-devel
108 Now you should be able to compile the source code with
110         ./configure --prefix=/usr
111         make
113 If you get errors then you are missing some required package. After
114 successful compilation you can install pidgin-sipe with:
116         su -c "make install"
118 If you get errors from configure or libtool about version conflicts then
119 you need to regenerate the autoconf files. You'll need these additional
120 packages
122         autoconf
123         automake
125 Now you should be able to regenerate the files with
127         autoreconf --verbose --install --force
129 After that go back to the configure step above.
132 Do It Yourself II: compiling against self-compiled pidgin
133 =========================================================
135 If you have compiled pidgin from source code yourself then you'll have to
136 specify the correct installation path in configure. Usually pidgin is
137 installed in /usr/local so the following command should work
139         ./configure --prefix=/usr/local
141 The rest of the steps are the same as in the previous section.