Author: dylan
Date: 2005-11-10 07:54:15 -0500 (Thu, 10 Nov 2005)
New Revision: 916
Modified:
trunk/
trunk/docs/spec/lib/Haver/Spec.pod
Log:
Clarification of the spec.
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 1f59643a-e6e5-0310-bc24-f7d4c744f460:/haver/havercurs-objc:43089
1f59643a-e6e5-0310-bc24-f7d4c744f460:/haver/local/trunk:11166
1f59643a-e6e5-0310-bc24-f7d4c744f460:/haver/local/trunk-merge-10131:11178
1f59643a-e6e5-0310-bc24-f7d4c744f460:/haver/winch/trunk:43192
27e50396-46e3-0310-8b22-ae223a1f35ce:/local:212
e9404bb1-7af0-0310-a7ff-e22194cd388b:/haver/local:1556
edfcd8bd-4ce7-0310-a97e-bb1efd40edf3:/local:238
+ 1f59643a-e6e5-0310-bc24-f7d4c744f460:/haver/havercurs-objc:43089
1f59643a-e6e5-0310-bc24-f7d4c744f460:/haver/local/trunk:11166
1f59643a-e6e5-0310-bc24-f7d4c744f460:/haver/local/trunk-merge-10131:11178
1f59643a-e6e5-0310-bc24-f7d4c744f460:/haver/winch/trunk:43192
27e50396-46e3-0310-8b22-ae223a1f35ce:/local:212
e9404bb1-7af0-0310-a7ff-e22194cd388b:/haver/local:1558
edfcd8bd-4ce7-0310-a97e-bb1efd40edf3:/local:238
Modified: trunk/docs/spec/lib/Haver/Spec.pod
===================================================================
--- trunk/docs/spec/lib/Haver/Spec.pod 2005-11-10 12:23:57 UTC (rev 915)
+++ trunk/docs/spec/lib/Haver/Spec.pod 2005-11-10 12:54:15 UTC (rev 916)
@@ -14,6 +14,14 @@
and lines beginning with S: are from the server. Items enclosed in square
brackets
are optional.
+=head1 I MEAN, HI
+
+Also, the format of the haver protocol is lines seperated by CR-LF ("\r\n" on
unix, "\n" on 'doze),
+each line divided by tabs into tokens. There is also a method for escaping
special characters.
+To send a literal tab, send <ESC>t. For a literal LF, send <ESC>n. For a CR,
<ESC>r.
+And for a literal <ESC>, send <ESC>e.
+<ESC> is the ASCII escape character, "\e" in perl. Its decimal value is 27.
+
=head2 HAVER/IDENT/HELLO
C<$supported> is a comma-seperated last of supported extensions (See
L</EXTENSIONS>)
@@ -72,10 +80,13 @@
C: TO $users $type @args
S: FROM $users $type @args
+Clients and servers B<may> reject incoming TO and FROM messages that have a
type not matching
+C</^[\w.]+$/>.
-Clients may use any string (C</^[^\t]+$/>) for $type,
-but it is typically "do" or "say".
+Clients B<should not> generate IN or TO messages that have a type not matching
the regexp.
+$type is typically "do" (for actions, "/me does something")
+or "say" (for normal message, e.g. "Hi Bob!").
=head2 INFO
@@ -116,7 +127,7 @@
=over
-=item creator
+=item owner
The name of the user that created the channel.
@@ -160,7 +171,7 @@
=head2 BYE/QUIT
-To disconnect, a client should send BYE:
+To disconnect, a client B<should> send BYE:
C: BYE $detail
@@ -204,7 +215,7 @@
=head1 YOU FAIL
-The server may respond to any given message with FAIL, which has the form of:
+The server B<may> respond to any given message with FAIL, which has the form
of:
S: FAIL $cmd $error [EMAIL PROTECTED]
