Author: dylan
Date: 2004-10-04 16:51:27 -0400 (Mon, 04 Oct 2004)
New Revision: 363
Added:
trunk/docs/manual/chap/events/channel.texi
Modified:
trunk/docs/manual/Makefile
trunk/docs/manual/chap/events.texi
trunk/docs/manual/chap/events/connection.texi
Log:
woo.
Modified: trunk/docs/manual/Makefile
===================================================================
--- trunk/docs/manual/Makefile 2004-09-23 01:18:08 UTC (rev 362)
+++ trunk/docs/manual/Makefile 2004-10-04 20:51:27 UTC (rev 363)
@@ -26,4 +26,7 @@
haver.log
clean:
-
+ rm -f haver.info
+ rm -f haver.txt
+ rm -f haver.pdf
+ rm -fr haver/
Added: trunk/docs/manual/chap/events/channel.texi
===================================================================
--- trunk/docs/manual/chap/events/channel.texi 2004-09-23 01:18:08 UTC (rev
362)
+++ trunk/docs/manual/chap/events/channel.texi 2004-10-04 20:51:27 UTC (rev
363)
@@ -0,0 +1,54 @@
[EMAIL PROTECTED] Channel Events
[EMAIL PROTECTED] Channel Events
+
[EMAIL PROTECTED] {Client Event} JOIN channel [password]
[EMAIL PROTECTED]
+
[EMAIL PROTECTED] deffn
+
[EMAIL PROTECTED]
+
+
+
+ \begin{cmddef}{JOIN}{\param{where}}
+ \citem{\Desc}
+ This command may only be used by user clients.
+
+ Attempt to join \param{where}.
+
+ \citem{\Res}
+ Upon successful entry, the server will send
+ \scmd{JOIN} to each user in the channel, including the
joiner.
+
+ \comment{There should be some support for passworded
channels,
+ and channels that maintain a wait-list.}
+
+ \citem{\Err}
+ \begin{errors}
+ \eitem{syntax.cid}{where}
+ \eitem{unknown.cid}{where}
+ \eitem{joined}{where}
+ \end{errors}
+ \comment{Further errors will be added for when people
are banned, etc.}
+ \end{cmddef}
+
+ \begin{cmddef}{PART}{\param{where}}
+ \citem{\Desc}
+ This command may only be used by user clients.
+
+ Attempt to leave \param{where}.
+
+ \citem{\Res}
+ The server will send \scmd{PART}
+ to every user in the channel \emph{before} the user
+ actually leaves the channel. Thus the parter will get
his
+ own part message.
+
+ \citem{\Err}
+ \begin{errors}
+ \eitem{syntax.cid}{where}
+ \eitem{unknown.cid}{where}
+ \eitem{timetravel}{where}
+ \end{errors}
+ \end{cmddef}
[EMAIL PROTECTED] ignore
Modified: trunk/docs/manual/chap/events/connection.texi
===================================================================
--- trunk/docs/manual/chap/events/connection.texi 2004-09-23 01:18:08 UTC
(rev 362)
+++ trunk/docs/manual/chap/events/connection.texi 2004-10-04 20:51:27 UTC
(rev 363)
@@ -6,11 +6,15 @@
describes how to disconnect, and ways for both the server
and client of making sure the connection is alive.
[EMAIL PROTECTED] *************************************
+
@deffn {Client Event} HAVER client
[EMAIL PROTECTED]
This event @strong{must} be the first event sent by the client. If a different
-event is received, servers @strong{may} immediately terminate the connection.
+event is received, servers @strong{must} immediately terminate the connection.
+
The parameter @var{client} is the name and version
number of the client software, comparable to the ``User-Agent:''
in HTTP. The format should be ``Program Name/#.#.#'', where ``#''
@@ -22,17 +26,20 @@
@end deffn
[EMAIL PROTECTED] #################################
+
[EMAIL PROTECTED] *************************************
+
@deffn {Server Event} HAVER server
This event is sent after the client sends @command{HAVER}.
The parameter @var{server} is name and version number of the server,
-for example ``Haver::Server::POE/0.07''.
+for example ``Haver::Server::POE/0.07''. This is the same form as
+for client names and versions.
The client can just ignore this.
@end deffn
[EMAIL PROTECTED] #################################
[EMAIL PROTECTED] *************************************
@deffn {Server Event} WANT cmd [EMAIL PROTECTED]
@@ -59,17 +66,16 @@
or a function related to the SHA family of hash functions,
such as SHA-256. However other hash functions are possible.
-The canonical hash function is``sha1''.
+The canonical hash function is ``sha1''.
@end table
@end deffn
[EMAIL PROTECTED] *************************************
[EMAIL PROTECTED] #################################
-
@deffn {Client Event} IDENT id [mode]
-This event @strong{must} only be sent when the server requests it with
@command{WANT}.
[EMAIL PROTECTED]
@var{id} is the id the client wishes to go by.
It must be in the format specified in @xref{Identifier Format}.
@@ -94,9 +100,10 @@
@end deffn
[EMAIL PROTECTED] *************************************
+
@deffn {Client Event} AUTH method
-This event must only be sent when the server requests
-it with @command{WANT}.
[EMAIL PROTECTED]
Request to use the authorization method @var{method},
where @var{method} is one from the @command{WANT AUTH} mentioned
@@ -114,9 +121,10 @@
@end itemize
@end deffn
[EMAIL PROTECTED] *************************************
+
@deffn {Client Event} AUTH:PASS passhash
-This event must only be sent when the server
-requests it with @command{WANT}.
[EMAIL PROTECTED]
passhash is the client's password + server's canonical hostname + client's id,
hashed with hash function specified in the server's @command{WANT} request,
@@ -137,8 +145,11 @@
@end deffn
[EMAIL PROTECTED] *************************************
+
@deffn {Client Event} BYE [why]
Disconnect from the server.
+
The parameter @var{why} is the reason for the disconnect,
such as ``lost terminal'', ``reboot'', etc.
This is not meant to be set by a human being, but instead
@@ -146,16 +157,12 @@
@end deffn
[EMAIL PROTECTED] *************************************
+
@deffn {Server Event} BYE type [EMAIL PROTECTED]
[EMAIL PROTECTED] {Server Event} QUIT uid type [EMAIL PROTECTED]
[EMAIL PROTECTED] is sent to the client right before the server disconnects it.
+This is sent to the client right before the server disconnects it.
[EMAIL PROTECTED] is similar, however it is sent to all users that share a
channel
-with the exciting user. It is only sent when a user exits, other types
-of clients donot cause this. This is equivelent of @var{uid}
-parting every channel.
-
Depending on the value of @var{tyoe}, @var{args} will be different things.
The following table lists the different types of client disconnections.
@@ -182,6 +189,8 @@
@end deffn
[EMAIL PROTECTED] *************************************
+
@deffn {Server Event} PING data
@deffnx {Client Event} PONG data
When the server issues the @command{PING} event, the client @strong{must} reply
@@ -190,6 +199,8 @@
@end deffn
[EMAIL PROTECTED] *************************************
+
@deffn {Client Event} POKE [EMAIL PROTECTED]
@deffnx {Server Event} OUCH [EMAIL PROTECTED]
Modified: trunk/docs/manual/chap/events.texi
===================================================================
--- trunk/docs/manual/chap/events.texi 2004-09-23 01:18:08 UTC (rev 362)
+++ trunk/docs/manual/chap/events.texi 2004-10-04 20:51:27 UTC (rev 363)
@@ -1,11 +1,47 @@
@node Events
@chapter Events
[EMAIL PROTECTED] mustBeUser
+This event is only valid for user clients, not services, etc.
[EMAIL PROTECTED] macro
+
[EMAIL PROTECTED] mustSendOnce
+This command @strong{must} only be sent once during the lifetime of the
connection.
[EMAIL PROTECTED] macro
+
[EMAIL PROTECTED] mustBeWanted
+This event @strong{must} only be sent when the server requests it with
@command{WANT}.
[EMAIL PROTECTED] macro
+
[EMAIL PROTECTED] onlyUser
+This event is only sent to users.
[EMAIL PROTECTED] macro
+
+
[EMAIL PROTECTED]
+The following sections describe the events that clients and servers
+send to each other.
[EMAIL PROTECTED] iftex
+
[EMAIL PROTECTED]
+The following nodes describe the events that clients and servers
+send to each other.
[EMAIL PROTECTED] ifnottex
+
+
+
@menu
-* Connection Events::
+* Connection Events:: How to connect, disconnect, and stay connected.
+* Channel Events:: How to join and part channels.
@end menu
[EMAIL PROTECTED]
+* Message Events:: How to talk to people, channels, and non-people.
[EMAIL PROTECTED] menu
[EMAIL PROTECTED] ignore
@include chap/events/connection.texi
[EMAIL PROTECTED] chap/events/channel.texi
[EMAIL PROTECTED] @include chap/events/message.texi
@ignore
\begin{cmddef}{MSG}{\param{where} \param{type} \params{msg}}
