summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorRichard Laager <rlaager@pidgin.im>2007-04-15 23:26:37 +0000
committerRichard Laager <rlaager@pidgin.im>2007-04-15 23:26:37 +0000
commit5553f20baaf78b9e6f5f021633215ea9ec72ac13 (patch)
tree2271b9119a20629ab8728d0390e00291f8daaef5 /README
parent57585190e86e5cd7718942607e89d03527e50ac0 (diff)
downloadpidgin-5553f20baaf78b9e6f5f021633215ea9ec72ac13.tar.gz
Beat some older documentation into submission.
Diffstat (limited to 'README')
-rw-r--r--README122
1 files changed, 5 insertions, 117 deletions
diff --git a/README b/README
index e393e8929d..a2024cba44 100644
--- a/README
+++ b/README
@@ -41,12 +41,9 @@ You should run 'make install' as root to make sure plugins and other files
get installed into locations they want to be in. Once you've done that,
you only need to run 'pidgin' or 'finch'.
-Protocol plugins (PRPLs) are now automatically loaded. Simply go to the
-account editor, add a new account, and all supported protocols will be
-there. Be sure to use OSCAR (AIM/ICQ) and not the old TOC or ICQ plugins.
-
-Read below for protocol-specific information.
+To get started, simply add a new account.
+If you come across a bug, please report it at: http://pidgin.im
PLUGINS
=======
@@ -57,121 +54,12 @@ source code. This will prevent the ability to load plugins.
'make install' puts the plugins in $PREFIX/lib/purple (PREFIX being what
you specified when you ./configure'd - it defaults to /usr/local). Purple
-looks for the plugins in that directory by default, but they do not have
-to be there to use them. Also, plugins have a .so extension by default,
-though they do not have to.
+looks for the plugins in that directory by default. Plugins can be installed
+per-user in ~/.purple/plugins as well. Pidgin and Finch also look in
+$PREFIX/lib/pidgin and $PREFIX/lib/finch for UI-specific, respectively.
To build a plugin from a .c file, put it in the plugins/ directory in
the source and run 'make filename.so', e.g. if you have the .c file
'kickass.c', put it in the plugins/ directory, and from that directory,
run 'make kickass.so'.
-
-NOTES
-=====
-
-If you manually set a command for your browser or sound player options,
-make sure to put double-quotes around the "%s", otherwise bad things may
-happen.
-
-If you come across a bug, please report it to http://pidgin.im/.
-
-
-PROTOCOL INFORMATION
-====================
-
-Each protocol is hacked by both Rob and Eric, though there is one person
-that kind of "owns" a protocol (mostly indicating that they were the
-person that originally wrote it). Their name will be next to the protocol;
-they're the people to complain to when something doesn't work ;).
-
-
-TOC (Mark)
-===
-
-You shouldn't use TOC, you should use Oscar instead. TOC can sync your
-buddy list with the server (if it's not too long), and can respond to file
-transfer requests (both sending and receiving). Other than that, there's
-nothing it can do that Oscar can't, yet. The TOC protocol doesn't allow
-retrieval of away messages; isn't capable of sending or receiving buddy
-icons; it also can't make file transfer requests.
-
-
-Oscar (Mark)
-=====
-
-Oscar is the default protocol. It is recommended that you use Oscar for
-both AIM and ICQ, as TOC isn't very featureful and the old ICQ protocol no
-longer works.
-
-For AIM, Oscar can get people's away messages. It can request and accept
-Direct Connections, and has limited support for file transfer. IM Image
-does not currently work. It can send and receive buddy icons if you have
-GdkPixbuf.
-
-For ICQ, it supports nearly everything that the old ICQ plugin supported,
-which isn't much. To use Oscar for ICQ, enter your ICQ UIN as the
-screenname. The default host/port will work. You'll need to use a different
-client to register a new ICQ account if you don't have one yet.
-
-
-Yahoo (Sean)
-=====
-
-Yahoo is currently using the new YMSG protocol that newer official Yahoo
-clients are using. This protocol is much better than the old one, and
-tends to be somewhat more reliable. However, the Yahoo service is still
-flaky at best.
-
-
-IRC (Ethan)
-===
-
-There are three ways to join an IRC chat room. The first is the File->Join
-A Chat menu option in the Buddy List window. The second is the "Chat"
-button at the bottom of the buddy list. The third is to type "/join #name"
-in an IM window where the "Send Message As" menu is set to your IRC
-account. There are other / commands that work in IM and Chat windows for
-IRC, /help will give you a list of them.
-
-
-MSN
-===
-
-With MSN you can join a conversation with several people, but you can't
-invite people from the IM window yet.
-
-
-Jabber (Nathan)
-======
-
-Transports aren't currently supported at all, though if you have a
-transport already subscribed Purple will use it (you can't add or remove
-transports though). In order to use a server other than jabber.org, set
-your username to include the server, e.g. warmenhoven@mycompany.com. This
-is the actual format of the Jabber ID anyway; Jabber is email with online
-notification. You can register a new Jabber account by checking the
-appropriate box in the account editor for your Jabber account.
-
-
-Zephyr (Sean)
-======
-
-Let me start off by saying how much I really despise Zephyr. They do a
-lot of things that make me realize why this never caught on. For those
-of you who are unfortunate enough to feel compelling need to use this,
-Purple now has a Zephyr plugin. It can currently sign on/off, handles
-presence/buddy lists (it even imports your .anyone file!), and can
-send/receive personal messages. A lot of stuff is missing, this is just
-a real rough first stab at it.
-
-
-Gadu-Gadu (Sean)
-=========
-
-I really shouldn't be taking credit for Gadu-Gadu, I'm just the person who
-commits the patches that Arkadiusz Miskiewicz gives me. Gadu-Gadu is an IM
-system most similar to ICQ that is quite popular in Poland. It can manage
-your server-side buddy list through the Protocol Actions menu. You'll need
-to use a different client to register a new account if you don't have one
-yet.