Author: dylan
Date: 2006-03-20 02:42:47 -0500 (Mon, 20 Mar 2006)
New Revision: 977
Modified:
trunk/
trunk/docs/manual/Recipe
trunk/docs/manual/messages.texi
Log:
added documentation for IN/TO/FROM. Will add JOIN/PART/QUIT/OPEN/CLOSE tomorrow.
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
ca0be05d-e60e-0410-9596-96133d777aec:/haver/local:1348
e9404bb1-7af0-0310-a7ff-e22194cd388b:/haver/local:2455
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
ca0be05d-e60e-0410-9596-96133d777aec:/haver/local:1352
e9404bb1-7af0-0310-a7ff-e22194cd388b:/haver/local:2455
edfcd8bd-4ce7-0310-a97e-bb1efd40edf3:/local:238
Modified: trunk/docs/manual/Recipe
===================================================================
--- trunk/docs/manual/Recipe 2006-03-20 06:42:53 UTC (rev 976)
+++ trunk/docs/manual/Recipe 2006-03-20 07:42:47 UTC (rev 977)
@@ -1,4 +1,4 @@
-
+# vim: set ft=bake:
action main {
print("Usage: make [pdf|html|info|txt|dvi|xml]");
}
Modified: trunk/docs/manual/messages.texi
===================================================================
--- trunk/docs/manual/messages.texi 2006-03-20 06:42:53 UTC (rev 976)
+++ trunk/docs/manual/messages.texi 2006-03-20 07:42:47 UTC (rev 977)
@@ -142,10 +142,39 @@
@end example
@end deffn
+
[EMAIL PROTECTED] Talking
[EMAIL PROTECTED] Talking
+
+The purpose of haver is [EMAIL PROTECTED] world domination.}, so after you
have connected, you probably want to talk to people.
+
+The most basic message for this is @cmd{TO}.
+
+
[EMAIL PROTECTED] {Client Message} TO @var{user} @var{type} [EMAIL PROTECTED]
[EMAIL PROTECTED] {Server Message} FROM @var{sender} @var{type} [EMAIL
PROTECTED]
[EMAIL PROTECTED] {Client Message} IN @var{channel} @var{type} [EMAIL PROTECTED]
[EMAIL PROTECTED] {Server Message} IN @var{channel} @var{sender} @var{type}
[EMAIL PROTECTED]
+
+These messages are fairly obvious.
+
+When a client sends the @cmd{TO} message, the server sends the @cmd{FROM}
message to the user specified by @param{user}.
[EMAIL PROTECTED] is the sender of the message.
+It can fail with @error{unknown.user}.
+
+When a client Sends the @cmd{IN} message, the server sends @cmd{IN} to all
users in @var{channel}, including the sender.
+It can fail with @error{unknown.channel}.
+
+Clients and servers @strong{may} reject any @cmd{TO} or @cmd{FROM} message
whose @param{type} does not match /^[\w.]+$/.
+Clients @strong{should not} generate @cmd{IN} or @cmd{TO} messages that have a
type not matching the regexp.
+
+The standard @param{type} is ``do'' (for actions, ``/me does something'') or
``say'' (for normal message, e.g. ``Hi Bob!'').
+
@node Channels
@section Channels
-This section details with channel maintenance commands.
+
+
@deffn {Client Message} JOIN @var{channel}
@deffnx {Server Message} JOIN @var{channel} @var{user}
_______________________________________________
Haver-commits mailing list
[email protected]
https://mail.gna.org/listinfo/haver-commits
