Author: dylan
Date: 2004-07-04 18:05:32 -0400 (Sun, 04 Jul 2004)
New Revision: 292
Modified:
trunk/docs/protocol/commands.txt
trunk/docs/protocol/login.txt
trunk/docs/protocol/messages.txt
Log:
Some doc upgrades to the current protocol (v3).
Modified: trunk/docs/protocol/commands.txt
===================================================================
--- trunk/docs/protocol/commands.txt 2004-07-04 22:00:46 UTC (rev 291)
+++ trunk/docs/protocol/commands.txt 2004-07-04 22:05:32 UTC (rev 292)
@@ -49,7 +49,7 @@
The client should note the $uid and process $cmd.
MSG $type $msg...
- A message.
+ A message, from $OF, in channel $IN.
WARN $error [$data1] [$data2] [$data#...]
Warns of $error, optionally followed
@@ -97,11 +97,9 @@
JOIN $cid
Asks the server to put us in $cid and notify any users there of our
arrival.
- You may only use this command in multi channel mode.
PART $cid
Asks the server to remove the client from $cid.
- You may only use this command in multi channel mode.
IN $cid MSG $type $msg
Sends $msg of type $type to the current channel.
Modified: trunk/docs/protocol/login.txt
===================================================================
--- trunk/docs/protocol/login.txt 2004-07-04 22:00:46 UTC (rev 291)
+++ trunk/docs/protocol/login.txt 2004-07-04 22:05:32 UTC (rev 292)
@@ -1,7 +1,7 @@
Login procedure:
-S: HAVER 3 line=2048
+S: HAVER 3 2048
S: WANT IDENT
C: IDENT dylan user HaverTk/0.07
Modified: trunk/docs/protocol/messages.txt
===================================================================
--- trunk/docs/protocol/messages.txt 2004-07-04 22:00:46 UTC (rev 291)
+++ trunk/docs/protocol/messages.txt 2004-07-04 22:05:32 UTC (rev 292)
@@ -1,38 +1,16 @@
This document describes the standard client to client
messaging in the haver protocol.
+A public message:
+C: IN $place MSG $type $args...
+S: IN $place OF $user MSG $type $args...
-The message commands -- MSG and PMSG --
-are described in docs/protocol/commands.txt.
+A private message:
+C: TO $user MSG $type $args...
+S: OF $user MSG $type $args...
-Briefly, their syntaxes are:
-C: MSG $type $msg...
-S: MSG $uid $type $msg
-and
-C: PMSG $uid $type $msg...
-S: PMSG $uid $type $msg...
+The $type for normal talk messages is a literal double quote (")
+The $type for emote messages is a literal colon (:)
-$msg may be zero or more items (tab-separated things).
-The type for normal messages (e.g. juan: I'm tired)
-is the double quote (") and the type for emotes (juan is tired)
-is the colon (:). All clients must implement these.
-
-
-Optional, but hopefully command, types are:
-
-* PING?
- Checks latency of the network.
- Usage:
- C: PMSG jose PING? $timeval
- S: PMSG jose PING $timeval
-
-* TIME?
- Request the current time from
- a user or a channel of users.
- Usage:
- C: PMSG juan TIME?
- S: PMSG juan TIME $timeval
-
-For a description of $timeval, see docs/formats.txt
-
+TODO: Define TIME?, PING?, OS?.
