changeset 141:f90b022235fe

[gaim-migrate @ 151] Updates to the FAQ (there's been a few changes since 0.9.5), and found a new (and presumably the last, since AOL stopped publishing it) copy of the protocol. committer: Tailor Script <tailor@pidgin.im>
author Eric Warmenhoven <eric@warmenhoven.org>
date Wed, 19 Apr 2000 22:36:38 +0000
parents 436bead8f65d
children fbabd28795d2
files doc/FAQ doc/PROTOCOL
diffstat 2 files changed, 87 insertions(+), 20 deletions(-) [+]
line wrap: on
line diff
--- a/doc/FAQ	Wed Apr 19 22:12:02 2000 +0000
+++ b/doc/FAQ	Wed Apr 19 22:36:38 2000 +0000
@@ -36,7 +36,8 @@
 
 IV. Programming
 	1. I have a patch for gaim!
-	2. Can you teach me how to program GTK?
+	2. I have a plugin for gaim!
+	3. Can you teach me how to program GTK?
 
 V. Miscellaneous
         1. Can I talk to you on IM?
@@ -67,12 +68,13 @@
 documented. 
 
 	2. Where can I find info on it?
-		Go to <http://www.aim.aol.com/tik> and download a copy of TiK.
-In it you will find a document called PROTOCOL which describes the protocol in
-full.
+		In the document called PROTOCOL. It's the version that was
+published with AOL's TiK client version 0.75, which appears to be the last
+one ever published.
 
 	3. What other clients use this protocol?
-		Go to <http://www.aim.aol.com/tik>.  There is a list there.
+		There are a few other Unix programs that use it, I think. I
+really couldn't tell you though. AOL used to keep a list of them, but no more.
 
 	4. TCP or UDP?
 		TCP.
@@ -116,7 +118,6 @@
 
         7. I'm not a native English speaker and I would like a translated   
            version of gaim.
-
 		By all means, IM me at 'Zilding' or email me at
 jimduchek@ou.edu.  I'm working on standard GNU locale support for the next
 version of gaim, and I'm going to need translations.  If you can do a
@@ -136,7 +137,11 @@
 libraries.  If you have them it _WILL_ compile with them, if not it won't. 
 If it compiles with them, you don't need to be running the ESD daemon, it'll
 automatically fallback to using /dev/dsp.  Make sure that gaim has proper
-permissions to talk to /dev/dsp and /dev/audio though!  
+permissions to talk to /dev/dsp and /dev/audio though!
+		The GNOME client now goes through GNOME for its sounds. If
+sounds aren't playing, make sure you've got them turned on in the GNOME
+control center. (The reason this was done was to make it more easily
+configurable.)
 
 	2. My buddy list disappeared!
 		You didn't back up your buddy list, did you?  You never back
@@ -155,19 +160,17 @@
 me at the source to the browser, I might be able to figure it out.). 
 
 	5. I'm using the GNOME client.  I have a bug.
-		Too smeggin' bad.  :)  I personally do NOT write any of the
-GNOME code.  If you find bugs in the GNOME client, I will accept emails
-describing these bugs, so I can pass them on to the correct person.
-I will also accept PATCHES to fix these bugs (but not like any of y'all
-ever do anything but whine about bugs anyway, who am I kidding ;).  
-If you IM me whining about a GNOME bug, you will probably be ignored.
+		GNOME bugs should be reported to Eric Warmenhoven (IM:
+EWarmenhoven (how original)), who is now maintaining that part of the code. If
+you ask the other guys about it, they'll just point you at him.
 	
 	6. I have a bug not described here.
 		Well, it could be a few things.  Firstly, you MUST HAVE GTK+
 VERSION 1.2.3 installed!  Please state in any bug report that you ARE using
 1.2.3, otherwise you have a chance of being ignored.  With that said ;)
 email me at jimduchek@ou.edu, I would like to hear your bug reports (but
-please, not your problems installing GTK).
+please, not your problems installing GTK). Also, sourceforge.net has a bug
+tracking system for us at <http://sourceforge.net/bugs/?group_id=235>.
 
 	7. I have Mandrake 6.0 and GAIM doesnt work!
 
@@ -187,7 +190,7 @@
 	1. I have a patch for gaim!
 		Nice.  Think about your patch though.  First, does it have
 to do with AIM?  I won't apply patches for stock tickers, search engines,
-etc.  We're working on plug-ins if you really want bloat like that. 
+etc.  Rewrite it as a plug-in if you really want bloat like that. 
 Second, is it useful?  A lot of patches I get are horribly unuseful except
 in very specific situations (ie YOUR situation).  Thirdly, your code 
 will not retain your copyright.  All code submitted must be protected by 
@@ -202,10 +205,18 @@
 I don't want to READ code like that.  I want a homogenous coding style
 on this program, and it's gonna be MY coding style. :)
 	Now, if you've managed to get through all that and I haven't
-discouraged you entirely, my email address is jimduchek@ou.edu, you can
-send your patches there.
+discouraged you entirely, send your patches to Rob Flynn (rob@linuxpimps.com).
 
-	2. Can you teach me how to program GTK?
+	2. I have a plugin for gaim!
+		Cool. Before you release it to anyone though, make sure you
+understand that if it does anything useful, it is necessarily licenced under
+the GPL. It's that whole "code that uses GPL'ed code is thus GPL'ed" clause.
+Also, don't send it to us. It's not that we don't want it, but there are
+better places to put it. Head over to sourceforge.net and submit it there
+<http://sourceforge.net/patch/?group_id=235>. It'll be available more quickly
+that way. 
+
+	3. Can you teach me how to program GTK?
 		Yes, I can.  But no, I'm not going to. There's a really
 nice tutorial at http://www.gtk.org.  If you're a fairly experienced 
 programmer, and you get stuck on something odd, IM me, I'm usually happy to
--- a/doc/PROTOCOL	Wed Apr 19 22:12:02 2000 +0000
+++ b/doc/PROTOCOL	Wed Apr 19 22:36:38 2000 +0000
@@ -19,6 +19,11 @@
 # of TiK (http://www.aim.aol.com/tik/) for the latest version of this
 # doc.
 
+# Note from Eric Warmenhoven, random guy -- this appears to be the last
+# published version of the protocol, and AOL has stopped hosting the TiK
+# program. This was taken from the last version of TiK I could find, version
+# 0.75.
+
 Version: TOC1.0
 
 This document describes the protocol between TOC and TOC clients.
@@ -159,7 +164,7 @@
     in permit mode, no arguments does nothing
     and your permit list remains the same.
 
-toc_add_deny [ <User 1> [<User 2> [... ]]]
+toc_add_deny [ <User 1> [<User 2> [...]]]
     ADD the following people to your deny mode. If
     you are in permit mode it will switch you to
     deny mode first.  With no arguments and in permit
@@ -252,6 +257,35 @@
     keep incrementing this number, so do not repeatedly call with new
     idle times.
 
+toc_set_caps [ <Capability 1> [<Capability 2> [...]]]
+    Set my capabilities.  All capabilities that we support need to
+    be sent at the same time.  Capabilities are represented by
+    UUIDs.  
+
+toc_rvous_propose  - Not Implemented Yet
+
+toc_rvous_accept <nick> <cookie> <service> <tlvlist>
+    Accept a rendezvous proposal from the user <nick>.
+    <cookie> is the cookie from the RVOUS_PROPOSE
+    message.  <service> is the UUID the proposal was
+    for. <tlvlist> contains a list of tlv tags followed by
+    base64 encoded values.
+
+toc_rvous_cancel <nick> <cookie> <service> <tlvlist>
+    Cancel a rendezvous proposal from the user <nick>.
+    <cookie> is the cookie from the RVOUS_PROPOSE
+    message.  <service> is the UUID the proposal was
+    for. <tlvlist> contains a list of tlv tags followed by
+    base64 encoded values.
+
+toc_format_nickname <new_format>
+    Reformat a user's nickname.  An ADMIN_NICK_STATUS or ERROR message will 
+    be sent back to the client.
+
+toc_change_passwd <existing_passwd new_passwd>
+    Change a user's password.  An ADMIN_PASSWD_STATUS or ERROR message will 
+    be sent back to the client.
+
 
 TOC -> Client
 ==============
@@ -306,6 +340,13 @@
    902   - Warning of $1 not currently available
    903   - A message has been dropped, you are exceeding
 	   the server speed limit
+
+   * Admin Errors  *
+   911   - Error validating input
+   912   - Invalid account
+   913   - Error encountered while processing request
+   914   - Service unavailable
+
    * Chat Errors  *
    950   - Chat in $1 is unavailable.
 
@@ -361,12 +402,27 @@
    Goto a URL.  Window Name is the suggested internal name of the window
    to use.  (Java supports this.) 
 
-DIR_STATUS:<Return Code>
+DIR_STATUS:<Return Code>:<Optional args>
+   <Return Code> is always 0 for success status.
+
+ADMIN_NICK_STATUS:<Return Code>:<Optional args>
+   <Return Code> is always 0 for success status.
+
+ADMIN_PASSWD_STATUS:<Return Code>:<Optional args>
+   <Return Code> is always 0 for success status.
    
 
 PAUSE
    Tells TIC to pause so we can do migration
 
+RVOUS_PROPOSE:<user>:<uuid>:<cookie>:<seq>:<rip>:<pip>:<vip>:<port>
+              [:tlv tag1:tlv value1[:tlv tag2:tlv value2[:...]]]
+   Another user has proposed that we rendezvous with them to
+   perform the service specified by <uuid>.  They want us
+   to connect to them, we have their rendezvous ip, their 
+   proposer_ip, and their verified_ip. The tlv values are 
+   base64 encoded.
+
 Typical Signon Process
 ======================
 Except for the section marked optional this is an sequential