always off for muc roster's horizontal scrollbar
[psi.git] / README
blob6d0785dcbee1510d774817889f923b64d23c117a
1 Psi 0.15-dev
2 ------------
3 Date: November 7th, 2009
5 Maintainers:
6   Justin Karneges (2001-2004, 2009-current)
7   justin@affinix.com
8   http://psi-im.org/
10   Kevin Smith (2004-2009)
11   kismith@psi-im.org
12   http://www.kismith.co.uk/
15   For installation or compiling instructions, see the INSTALL file.
17   This program is licensed under the GNU General Public License.  See
18   the COPYING file for more information.
21 Known Issues
22 ------------
23 The following are known issues with this release:
24 Issues with Qt 4.5.0: Hang on exit, hang when using GnuPG.
25 Issues with QCA <2.0.2 + Qt 4.5: Hang on exit.
26 Issues with qca-gnupg <2.0.0-beta3 + Qt 4.5: Hang when using GnuPG.
29 Notes
30 -----
31   - QCA --
32     * QCA 2.x is required to build Psi: a version is bundled with Psi.
33     * The qca-ossl and qca-gnupg plugins are desirable for full 
34       functionality of Psi.
36   - Voice Calling --
37     * The PsiMedia 1.0.x plugin and the qca-ossl plugin are needed to activate
38       the voice calling feature.  Source and builds of PsiMedia can be found
39       at:
40         http://delta.affinix.com/psimedia/
41       On Windows, place gstprovider.dll into the base directory.
42       On Mac, place libgstprovider.dylib into Psi.app/Contents/plugins
43       On Linux, place libgstprovider.so into LIBDIR/psi/plugins
45   - Upgrading to 0.12 --
46     * During the upgrade process, the old config.xml configuration file will
47       be imported into the new option.xml format. Neither file should now be
48       edited by hand, since all options are exposed in the options window. 
49       Config.xml can be safely removed once the upgrade is complete.
51   - GnuPG tips --
52     * Always use the latest version of GnuPG.
53     * On Windows, use a native build instead of one based on cygwin, and make
54       sure it is properly installed in the registry.
55     * Ensure 'gpg' actually works, by testing it from the command-line.
56     * You must have a public and secret keyring.  Psi cannot operate
57       without them, and they must be there when you start it.
60 Changes
61 -------
62   New in 0.14
63   - Added color options to the chat window.
64   - Can now specify a reason for kick/ban in groupchat.
65   - Improved User Info window, to show more fields and photo view/save.
66   - Support for Enchant as an alternative to Aspell.
67   - Commandline interface now supports choosing profile and setting status.
68   - D-BUS interface now supports setting status and indicating sleep/wake.
69   - Fixed voice calling compatibility bugs with Pidgin and Empathy.
70   - Various other minor improvements and bugfixes.
72   New in 0.13
73   - Voice calls (Jingle RTP).
74   - Basic XMPP URI handler.
75   - Ability to permanently trust certificates at connect time.
76   - Mini command system (Ctrl+7 in chat window).
77   - Various bugfixes.
79   New in 0.12.1
80   - Bugfix for DOS vulnerability in the file transfer code.
81     Thanks to Jesus Olmos (jolmos@isecauditors.com)
83   New in 0.12
84   - Multi-user chat windows now join one on one chat windows and can be opened
85     in tabbed form, either sharing a window, or separately.
86   - The roster search has been updated, and now triggers a filter when typing
87     into the roster window.
88   - An XML ringbuffer is now used, allowing access to already received XML in
89     the XML console.
90   - When resolving a name for new contacts, the full name is now used if the 
91     nick name is missing from the vcard.
92   - Auto-connect on wake is now an independent option.
93   - MUCs can now be bookmarked, and auto-joined.
94   - The old config.xml file has been dropped in favour of the new options.xml
95     format - all options in Psi can now be configured from the Advanced 
96     options pane (no more hand-editing of config files is required).
97   - Vcard avatars are now transmitted for the benefit of legacy clients and
98     servers not supporting PEP.
99   - A new diagnostics group is available in the help menu, to allow debugging
100     problems with the QCA security layer.
101   - Launching several instances of the same profile on Windows and Unices with
102     DBUS now behaves more sensibly.
103   - On X11, the taskbar should now flash on new messages for compliant
104     window managers.
106   New in 0.11
107   - Reworked account registration process (including proper support for
108     XEP-0077 (In-band registration))
109   - Finished support for XEP-0004 (Data Forms) by supporting forms in
110     messages. (thanks to Roelof Naude)
111   - Added support for XEP-0070 (Verifying HTTP Requests via XMPP).
112     Thanks to Maciej Niedzielski.
113   - Customizable shortcuts (thanks to Ephraim)
114   - System-wide shortcuts
115   - Added spell checking (thanks to Ephraim).
116     Currently only aspell is supported.
117   - Added option to automatically set the resource (using the hostname)
118   - Added new default Stellar3 iconset
119   - Added support for XEP-138 (Stream Compression)
120   - Added support for using XEP-33 (Extended Stanza Addressing) to multicast
121     messages to multiple users. Use option.enable-multicasting to enable it.
122   - Added 'Show status message' toggle. There is a hidden option to put 
123     status messages under the nickname (at the cost of 2 extra pixels
124     when no status message is shown)
125   - Support for Bookmark Storage (XEP-0048), where bookmarked conferences are
126     auto-joined. No UI is provided for creating bookmarks (yet).
127   - Better error messages, including error condition mappings (XEP-0086)
128   - Support dynamically changing priority
129   - Improved PGP error messages
130   - Hiding the deprecated protocol selector for service discovery by default.
131     Use option.ui.show-deprecated.service-discovery.protocol-selector to
132     re-enable it.
133   - New options system (see options.xml)
134   - Receiving support for vCard-Based Avatars (XEP-0153)
135   - Support for Multi-User-Chat (XEP-0045)
136   - Preliminary support for User Nickname (XEP-0172)
137   - Preliminary support for Roster Item Exchange (XEP-0144)
138   - Psi now uses the Qt4(>=4.3) and QCA2 libraries, replacing the Qt3 and QCA1 
139     requirements.
140   - "Privacy List" support in the account dialog.
141   - Support for XEP-0050 (Ad-hoc commands)
142   - Preliminary support for XEP-0163 (Personal Eventing Protocol)
143   - Preliminary support for XEP-0146 (Remote Controlling Clients)
144   - Large parts of the codebase have been restructured.
145   - Fixed a chat room bug where subject/topic changes were not shown.
146   - Mac OS X builds are now universal binaries, supporting the new Intel 
147     based Macs.
148   - Support for XEP-85 (Chat State Notifications).
149   - Support for XEP-0115 (Entity Capabilities).
150   - There is now a config.xml option to make some windows use the brushed
151     metal theme on Mac OS X.
152   - Window opacity support is now present for all three supported platforms.
153   - Fixed Unicode URL opening bug #510
154   - Auto-reconnect accounts on wakeup
155   - Copy-pasting with emoticons now works
156   - Fixed issue #263 where emoticons would disappear in a reply or quote
157   - History index is rebuilt faster
158   - Configure toolbars merged into main preferences dialog
159   - Moving tooltips
160   - MingW32 compiler support (Coupled with the open source Qt4 Windows library
161     this now allows completely free building of Psi on Windows)
164 Description
165 -----------
167   Psi is a capable Jabber client aimed at experienced users.  Its design
168   goals are simplicity and stability.  Psi is highly portable and runs on
169   Windows, Unix/X11, and Mac OS X.
171   The interface is very ICQ-like.  Alerts appear in the contact list when
172   events are received, and things like subscriptions requests appear as
173   "system messages" (ICQ users know these well).  Even "Chats" are
174   queued in the contact list.  Also, chats are "remembered" by default,
175   so that you don't have to keep a bunch of windows open for each person.
176   Just close the chat window.  If you open it again it will all be there.
178   Psi is minimal but powerful.  There are keybindings for just about
179   everything, Unicode is supported throughout, and contacts are cached
180   offline.  Security is also a major consideration, and Psi provides it for
181   both client-to-server (SSL) and client-to-client (GnuPG).
184 How you can help
185 ----------------
187   Comments
188   --------
189   We like comments, even (especially) if they are a simple thanks.
191   Bug reports
192   -----------
193   If you want to help us out, please file a bug report on our forum at 
194   http://forum.psi-im.org/forum/2 for release versions, or email us  a bug 
195   report to the development mailing list for development builds, details at:
196   http://lists.affinix.com/listinfo.cgi/psi-devel-affinix.com
197   Please be as descriptive as possible and tell us what exactly you were doing 
198   at the time something went wrong.  If possible, send us a stack backtrace.
200   Wishes
201   ------
202   We can't possibly know what everyone wants, so we appreciate all feature
203   requests. These can be submitted to http://forum.psi-im.org/forum/4
205   Porting
206   -------
207   Psi should be very portable.  Please e-mail us first if you want to
208   port Psi to another platform.
210   Graphics
211   --------
212   There are many ways to contribute to the Psi project, if you think you can 
213   do a better job with any of the Psi graphics, then go right ahead!
215   Sound
216   -----
217   Same goes for sound.  Start mixing!
219   Programming
220   -----------
221   Patches are welcome.  External tools would be useful as well, like Licq
222   conversion utilities (iconsets, message history, etc).  Get to work!
224   Packaging
225   ---------
226   Want to make an RPM or something?
228   Financial
229   ---------
230   You can send a paypal gift if you'd like, to donate@psi-im.org
233 Have fun,
234 -The Psi team