Mercurial > pidgin.yaz
changeset 16176:83ec0b408926
Beat some older documentation into submission.
| author | Richard Laager <rlaager@wiktel.com> |
|---|---|
| date | Sun, 15 Apr 2007 23:26:37 +0000 |
| parents | 4493d6de6384 |
| children | d88f0f320c9b |
| files | Makefile.am PLUGIN_HOWTO PROGRAMMING_NOTES README README.MTN README.SVN |
| diffstat | 6 files changed, 42 insertions(+), 161 deletions(-) [+] |
line wrap: on
line diff
--- a/Makefile.am Sun Apr 15 23:16:27 2007 +0000 +++ b/Makefile.am Sun Apr 15 23:26:37 2007 +0000 @@ -7,8 +7,7 @@ Makefile.mingw \ PLUGIN_HOWTO \ PROGRAMMING_NOTES \ - README.SVN \ - README.dbus \ + README.MTN \ README.mingw \ config.h.mingw \ gaim.pc.in \
--- a/PLUGIN_HOWTO Sun Apr 15 23:16:27 2007 +0000 +++ b/PLUGIN_HOWTO Sun Apr 15 23:26:37 2007 +0000 @@ -1,6 +1,6 @@ For information on writing a plugin for Purple, Pidgin or Finch, go -http://pidgin.im/api/ and see the HOWTOs in the "Related Pages" -section. +http://developer.pidgin.im and click on API. From there, see the HOWTOs in the +"Related Pages" section. You can also generate this documentation locally by installing doxygen and graphviz dot, then running "make docs" in the
--- a/PROGRAMMING_NOTES Sun Apr 15 23:16:27 2007 +0000 +++ b/PROGRAMMING_NOTES Sun Apr 15 23:26:37 2007 +0000 @@ -16,7 +16,7 @@ e.g: fopen("somefile", "wb"); - Not doing so will open files in windows using defaut translation mode. + Not doing so will open files in windows using default translation mode. i.e. newline -> <CR><LF> Paths
--- a/README Sun Apr 15 23:16:27 2007 +0000 +++ b/README Sun Apr 15 23:26:37 2007 +0000 @@ -41,12 +41,9 @@ 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. +To get started, simply add a new account. -Read below for protocol-specific information. - +If you come across a bug, please report it at: http://pidgin.im PLUGINS ======= @@ -57,121 +54,12 @@ '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.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.MTN Sun Apr 15 23:26:37 2007 +0000 @@ -0,0 +1,33 @@ +If you plan to use Pidgin, Finch and libpurple from our Monotone repository, +PLEASE read this message in its entirety! + +Pidgin, Finch, and libpurple are a fast-moving project with a somewhat regular +release schedule. Due to the rate of development, the code in our Monotone +repository undergoes frequent bursts of massive changes, often leaving behind +brokenness and partial functionality while the responsible developers rewrite +some portion of code or seek to add new features. + +What this all boils down to is that the code in our Monotone repository _WILL_ +sometimes be broken. Because of this, we ask that users who are not interested +in personally tracking down bugs and fixing them (without a lot of +assistance from the developers!) use only released versions. Since releases +will be made often, this should not prevent anyone from using the newest, +shiniest features -- but it will prevent users from having to deal with ugly +development bugs that we already know about but haven't gotten around to fixing. + +If you are interested in hacking on Pidgin, Finch, and/or libpurple, please +check out the information available at: http://developer.pidgin.im + +By far the best documentation, however, is the documented code. If you have +doxygen, you can run "make docs" in the toplevel directory to generate pretty +documentation. Otherwise (or even if you do!), the header files for each +subsystem contain documentation for the functions they contain. For instance, +conversation.h contains documentation for the entire purple_conversation_* +API, and account.h contains documentation for the purple_account_* API. + +If you have questions, please feel free to contact the Pidgin, Finch, and +libpurple developers by e-mail at devel@pidgin.im or on IRC at irc.freenode.net +in #pidgin. Please do as much homework as you can before contacting us; the +more you know about your question, the faster and more effectively we can help! + +Patches should be posted as Trac tickets at: http://developer.pidgin.im
--- a/README.SVN Sun Apr 15 23:16:27 2007 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,39 +0,0 @@ -If you plan to use Pidgin, Finch & libpurple mtn, PLEASE read this message in its entirety! - -Pidgin, Finch & libpurple is a fast-moving project with a somewhat regular -release schedule. Due to the rate of Pidgin, Finch & libpurple development, -mtn undergoes frequent bursts of massive changes, often leaving behind -brokenness and partial functionality while the responsible developers rewrite -some portion of code or seek to add new features. - -What this all boils down to is that mtn _WILL_ sometimes be broken. -Because of this, we ask that users who are not interested in -personally tracking down bugs and fixing them (without a lot of -assistance from the developers!) avoid mtn and use releases. Since -releases will be made often, this should not prevent anyone from using -the newest, shiniest features -- but it will prevent users from having -to deal with ugly development bugs that we already know about but -haven't gotten around to fixing. - -If you are interested in hacking on Pidgin, Finch & libpurple, please read -README and HACKING, and take note of the issues in PROGRAMMING_NOTES. (Note -that they may be somewhat out of date at times.) Win32 developers, please -read README.mingw. - -By far the best documentation, however, is the documented code. Not -all parts of Pidgin, Finch & libpurple have yet been documented, but the major -subsystems are falling fast. If you have doxygen, you can use the Doxyfile in -the toplevel directory to generate pretty documentation. Otherwise -(or even if you do!), the header files for each subsystem contain -documentation for the functions they contain. For instance, -conversation.h contains documentation for the entire purple_conversation_* -API, and account.h contains documentation for the purple_account_* API. - -If you have questions, please feel free to contact the Pidgin, Finch & -libpurple developers by email at devel@pidgin.im or on IRC at irc.freenode.net -in #pidgin. Please do as much homework as you can before contacting us; the -more you know about your question, the faster and more effectively we can help -you! - -Send patches to Pidgin, Finch & libpurple mailing list, devel@pidgin.im, or -post them in the tracker at http://developer.pidgin.im.