Commit 5e81ddc6 authored by Per Cederqvist's avatar Per Cederqvist

Create the "am" index for asynchronous messages. Add @amindex and

@aarg markup for all asynchronous messages, and remove the trailing
semicolon in the argument list.  Merge all indices into one.
(add-member): Malformed sentence fixed.
(async-i-am-off, async-i-am-on-obsolete): Mark as obsolete, and
	tell why they are no longer used.
(async-broadcast): Mark as obsolete.
(Type Index, Request Index): Removed.
(Index): Added.
parent 01164b67
......@@ -3,8 +3,9 @@
@c FIXME: Explain how the garb works with nice and keep-commented
@c FIXME: @i{Example:} is only used in front of some examples.
@c FIXME: Make all types clickable in HTML (and info?)
@c FIXME: create @asynklink and @asyncdlink, and substitute them for @async.
@c
@c $Id: Protocol-A.texi,v 1.119 2001/04/30 09:11:12 ceder Exp $
@c $Id: Protocol-A.texi,v 1.120 2001/04/30 21:46:19 ceder Exp $
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
......@@ -16,6 +17,13 @@
@set PROTOVER 10
@set VERSION 1.0.4
@c Index for asynchronous messages.
@defcodeindex am
@c Merge all indices.
@syncodeindex am fn
@syncodeindex tp fn
@c @req{login} is used for protocol requests.
@macro req {n}
......@@ -239,8 +247,7 @@ The most up-to-date version if this document can always be found at
* The User Area::
* Writing Clients::
* Importing and Exporting E-Mail::
* Type Index::
* Request Index::
* Index::
@end menu
@node Overview
......@@ -292,7 +299,7 @@ The LysKOM developers can be reached by email to
@email{lyskom@@lysator.liu.se}.
@menu
* Document Edition History::
* Document Edition History::
* Protocol Version History::
* Notation::
@end menu
......@@ -1418,7 +1425,7 @@ If you want a range of numbers, send e-mail to the LysKOM development
group.
@menu
* komimportmail Aux-Item Types::
* komimportmail Aux-Item Types::
@end menu
@node komimportmail Aux-Item Types
......@@ -7707,9 +7714,8 @@ Person @rarg{pers-no} does not exist
@item access-denied
@c FIXME: the "or to change" part is bogus, right? Aren't those
@c cirumstances covered by permission-denied?
Not enough permissions or privileges to add members to conference or to
change privileges, position or type of a preexisting membership.
@rarg{conf-no}.
Not enough permissions or privileges to add members to @rarg{conf-no}
or to change privileges, position or type of a preexisting membership.
@item permission-denied
Person @rarg{pers-no} is already a member of conference @rarg{conf-no},
......@@ -8077,9 +8083,10 @@ reject them if a client uses it as an argument to
@node async-new-text-old
@section async-new-text-old (1) Obsolete (10)
@amindex async-new-text-old
@example
async-new-text-old [0] (( text-no : Text-No;
text-stat : Text-Stat-Old; ));
text-stat : Text-Stat-Old ));
@end example
This message is sent when a text is created. The text number of the text
......@@ -8093,37 +8100,48 @@ In protocol version 10 this call has been superceded by @ref{async-new-text}.
@node async-i-am-off
@section async-i-am-off (1) Obsolete
@amindex async-i-am-off
@c obsolete
@example
async-i-am-off [1] ( person : Pers-No );
@end example
This message was sent when a person logged off. It has been replaced
by @async{async-logout}.
This message was sent when @aarg{person} logged off. It has been
replaced by @async{async-logout}, since this asynchronous message
could not differentiate between sessions if the same person was logged
in more than once.
@node async-i-am-on-obsolete
@section async-i-am-on-obsolete (1) Obsolete
@amindex async-i-am-on-obsolete
@c obsolete
@example
async-i-am-on-obsolete [2] (( person : Pers-No;
conference : Conf-No;
what-am-i-doing : HOLLERITH; ));
what-am-i-doing : HOLLERITH ));
@end example
This message was sent when a user changed his what-i-am-doing string or
working conference. It has been replaced by call number 6,
@ref{async-i-am-on}.
This message was sent when @aarg{person} changed his
@code{what-i-am-doing} string to @aarg{what-am-i-doing} or his working
conference to @aarg{conference}.
It has been replaced by call number 6, @async{async-i-am-on}, since
this asynchronous message could not differentiate between sessions if
the same person was logged in more than once.
@node async-new-name
@section async-new-name (1) Recommended
@amindex async-new-name
@example
async-new-name [5] (( conf-no : Conf-No;
old-name : HOLLERITH;
new-name : HOLLERITH; ));
new-name : HOLLERITH ));
@end example
This message is sent when a person or conference changes names. The
......@@ -8136,13 +8154,14 @@ old name in @aarg{old-name} and the new name in @aarg{new-name}.
@node async-i-am-on
@section async-i-am-on (1) Recommended
@amindex async-i-am-on
@example
async-i-am-on [6] ( info : Who-Info );
@end example
This message is sent when a session's working conference,
what-i-am-doing string or username changes. The new information is sent
in @aarg{info}.
@code{what-i-am-doing} string (@pxref{change-what-i-am-doing}) or
username changes. The new information is sent in @aarg{info}.
@c FIXME: can the username change?
......@@ -8150,6 +8169,7 @@ in @aarg{info}.
@node async-sync-db
@section async-sync-db (1) Recommended
@amindex async-sync-db
@example
async-sync-db [7] ( );
@end example
......@@ -8163,6 +8183,7 @@ difference between the two cases.
@node async-leave-conf
@section async-leave-conf (1) Recommended
@amindex async-leave-conf
@example
async-leave-conf [8] ( conf-no : Conf-No );
@end example
......@@ -8193,13 +8214,15 @@ to a passive membership.
@node async-login
@section async-login (1) Recommended
@amindex async-login
@example
async-login [9] ( pers-no : Pers-No;
session-no : Session-No; );
async-login [9] (( pers-no : Pers-No;
session-no : Session-No ));
@end example
This message is sent when someone logs in. The identity of the person
logging in is sent in @aarg{pers-no}.
logging in is sent in @aarg{pers-no}, and the session number in
@aarg{session-no}.
......@@ -8207,14 +8230,17 @@ logging in is sent in @aarg{pers-no}.
@node async-broadcast
@section async-broadcast (1) Obsolete
@amindex async-broadcast
@c obsolete
@example
async-broadcast [10] (( sender : Pers-No;
message : HOLLERITH; ));
message : HOLLERITH ));
@end example
This message has been superceded by @req{send-message} which is more
flexible. It used to be sent when the administrator broadcast a string
to all LysKOM users, but is no longer used.
This message has been superceded by @async{async-send-message} which
is more flexible. It used to be sent when the administrator
(@aarg{sender}) broadcasted a string (@aarg{message}) to all LysKOM
users, but is no longer used.
......@@ -8222,6 +8248,7 @@ to all LysKOM users, but is no longer used.
@node async-rejected-connection
@section async-rejected-connection (1) Recommended
@amindex async-rejected-connection
@example
async-rejected-connection [11] ( );
@end example
......@@ -8236,27 +8263,30 @@ to allow more connections.
@node async-send-message
@section async-send-message (1) Recommended
@amindex async-send-message
@example
async-send-message [12] (( recipient : Conf-No;
sender : Pers-No;
message : HOLLERITH; ));
message : HOLLERITH ));
@end example
This message is sent when someone sends a message string. The recipient
of the message is sent in @aarg{recipient}. If it is zero, then the
message was sent to all connections. If it is a conference, then the
message is being sent to all logged-in members of that conference. If it
is a mailbox then the message is personal and is only sent to members
of the mailbox conference.
This message is sent when someone (the @aarg{sender}) sends a message
string (the @aarg{message}). The recipient of the message is sent in
@aarg{recipient}. If it is zero, then the message was sent to all
connections. If it is a conference, then the message is being sent to
all logged-in members of that conference. If it is a mailbox then the
message is personal and is only sent to members of the mailbox
conference.
@node async-logout
@section async-logout (1) Recommended
@amindex async-logout
@example
async-logout [13] (( pers-no : Pers-No;
session-no : Session-No; ));
session-no : Session-No ));
@end example
This message is sent when someone logs out. @aarg{pers-no} is the person
......@@ -8269,9 +8299,10 @@ even if there is nobody logged on in the session.
@node async-deleted-text
@section async-deleted-text (10) Recommended
@amindex async-deleted-text
@example
async-deleted-text [14] (( text-no : Text-No;
text-stat : Text-Stat; ));
text-stat : Text-Stat ));
@end example
This message is sent when a text is deleted and the currently logged-in
......@@ -8283,9 +8314,10 @@ deleted is sent in @aarg{text-no} and the text stat in @aarg{text-stat}.
@node async-new-text
@section async-new-text (10) Recommended
@amindex async-new-text
@example
async-new-text [15] (( text-no : Text-No;
text-stat : Text-Stat; ));
text-stat : Text-Stat ));
@end example
This message indicates that a new text has been created. The text has
......@@ -8296,10 +8328,11 @@ message is sent to all logged-in members of any recipient of the text.
@node async-new-recipient
@section async-new-recipient (10) Recommended
@amindex async-new-recipient
@example
async-new-recipient [16] (( text-no : Text-No;
conf-no : Conf-No;
type : Info-Type; ));
type : Info-Type ));
@end example
This message indicates that a new recipient has been added to text
......@@ -8313,10 +8346,11 @@ recipient.
@node async-sub-recipient
@section async-sub-recipient (10) Recommended
@amindex async-sub-recipient
@example
async-sub-recipient [17] (( text-no : Text-No;
conf-no : Conf-No;
type : Info-Type; ));
type : Info-Type ));
@end example
This message indicates that a recipient has been removed from text
......@@ -8329,9 +8363,10 @@ the recipient.
@node async-new-membership
@section async-new-membership (10) Recommended
@amindex async-new-membership
@example
async-new-membership [18] (( pers-no : Pers-No;
conf-no : Conf-No; ));
conf-no : Conf-No ));
@end example
This message indicates that the membership for @aarg{pers-no} in
......@@ -9126,13 +9161,8 @@ Appendices encoded with Base64 or Quoted-Printable should be decoded.
When creating aux-items like @aux{mx-author}, text coded using the
method in RFC 2047 should be decoded.
@node Type Index
@unnumbered Type Index
@printindex tp
@node Request Index
@unnumbered Request Index
@node Index
@unnumbered Index
@printindex fn
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment