Commit 962e526a authored by Per Cederqvist's avatar Per Cederqvist

(PROTOEDITION, PROTOVER, VERSION): New constants. Use them throughout

	the document instead of 10.3, 10 and 1.0.4.  Bump PROTOEDITION
	to 10.4.  Added an explicit permission to process the texi
	file with TeX.  Ensure that all permission notices are equal.
	Print all version information on the title page.  Moved the
	contents to the front of the document, and avoid printing them
	in the html document.  Add HTML links to Lysator and LysKOM
	before the first node.
(Top): Enclose this node in @ifnottext instead of @ifinfo.  Refer
	to the web site.
(Overview): Include all version numbers and the canonical URL for
	the protocol specification here as well, but only @iftex.
(Document Edition History): New name for former node "Document
	Revision History".  Use the term "edition" throughout the
	document.  Added a not for edition 10.4.
(Predefined Aux-Item Types, create-anonymous-text-old)
(create-anonymous-text, modify-system-info): Get rid of overfull
	hbox messages from TeX.
(Type Index, Request Index): Use @unnumbered instead of @chapter.
parent 17a15651
\input texinfo @c -*-texinfo-*-
@c
@c FIXME: Explain how the garb works with nice and keep-commented
@c FIXME: s/@unnumberedsubsec Error codes/@subheading Error codes/
@c
@c $Id: Protocol-A.texi,v 1.105 2001/04/13 10:28:29 ceder Exp $
@c $Id: Protocol-A.texi,v 1.106 2001/04/16 09:23:59 ceder Exp $
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
@setchapternewpage odd
@c @afourpaper
@c %**end of header
@iftex
@parindent 0pt
@font@tensltt=cmsltt10
@begin tex
\global\def\rett#1{{\let\t\sltt\tt #1}}
\global\def\sltt#1{{\fam\ttfam\tensltt\let\t\rett #1}}
\global\let\t\sltt
@end tex
@end iftex
@set PROTOEDITION 10.4
@set PROTOVER 10
@set VERSION 1.0.4
@ifinfo
This is revision 10.3 of the LysKOM Protocol A specification. It
specifies version 10 of the protocol.
This is the LysKOM Protocol A specification, edition
@value{PROTOEDITION}. It specifies version @value{PROTOVER} of the
protocol. It corresponds to version @value{VERSION} of lyskomd.
Copyright @copyright{} 1995-2000 Lysator ACS.
Permission is granted to make and distribute verbatim copies of this
specification provided the copyright notice and this permission notice
are preserved on all copies.
@ignore
Permission is granted to process this file through TeX
and print the results, provided the printed document
carries a copying permission notice identical to this
one except for the removal of this paragraph (this
paragraph not being relevant to the printed manual).
@end ignore
Modified versions of this document may be redistributed with the added
condition that all modifications not cleared with the LysKOM development group
are clearly marked and that the entire modified work be redistributed under the
same conditions as the original.
Permission is granted to copy and distribute translations of this manual into
another language under the same conditions as for modified versions.
@end ifinfo
@dircategory LysKOM
@direntry
* Protocol A: (protocol-a). The LysKOM Protocol A specification.
@end direntry
@c FIXME: What does this do?
@iftex
@parindent 0pt
@font@tensltt=cmsltt10
@begin tex
\global\def\rett#1{{\let\t\sltt\tt #1}}
\global\def\sltt#1{{\fam\ttfam\tensltt\let\t\rett #1}}
\global\let\t\sltt
@end tex
@end iftex
@titlepage
@sp 10
@title{LysKOM Protocol A}
@sp 2
@subtitle{Protocol version 10}
@sp 2
@subtitle{Protocol version @value{PROTOVER}}
@subtitle{Edition @value{PROTOEDITION}}
@subtitle{(lyskomd @value{VERSION})}
@author by the LysKOM Developers
@page
......@@ -59,13 +78,38 @@ Permission is granted to copy and distribute translations of this manual into
another language under the same conditions as for modified versions.
@end titlepage
@ifnothtml
@contents
@end ifnothtml
@ifinfo
@dircategory LysKOM
@direntry
* Protocol A: (protocol-a). The LysKOM Protocol A specification.
@end direntry
@ifhtml
@html
<a href="http://www.lysator.liu.se/" ><img
src="http://www.lysator.liu.se/icons/lyslogo.gif" alt="Lysator"
width=40 border=0 height=40 align=left ></a>
<a href="http://www.lysator.liu.se/lyskom/" ><img
src="http://www.lysator.liu.se/icons/lyskom.gif" alt="LysKOM" width=40
border=0 height=40 align=left ></a>
<br clear=all>
@end html
@end ifhtml
@ifnottex
@node Top
@top LysKOM Protocol A
This document specifies version 10 of LysKOM Protocol A.
This is revision 10.3 of the specification.
This document specifies version @value{PROTOVER} of LysKOM Protocol A.
This is edition @value{PROTOEDITION} of the specification. It
corresponds to version @value{VERSION} of lyskomd.
The most up-to-date version if this document can always be found at
@uref{http://www.lysator.liu.se/lyskom/protocol/}.
@end ifnottex
@menu
* Overview::
......@@ -81,11 +125,19 @@ This is revision 10.3 of the specification.
* Type Index::
* Request Index::
@end menu
@end ifinfo
@node Overview
@chapter Overview
@iftex
This document specifies version @value{PROTOVER} of LysKOM Protocol A.
This is edition @value{PROTOEDITION} of the specification. It
corresponds to version @value{VERSION} of lyskomd.
The most up-to-date version if this document can always be found at
@uref{http://www.lysator.liu.se/lyskom/protocol/}.
@end iftex
LysKOM is a conferencing system@footnote{Or in modern terms, enabling
technology for Computer-Supported Cooperative Work (CSCW).}. Similar
systems were QZ-KOM and PortaCOM@footnote{Also known as ``PottaKOM'' and
......@@ -94,9 +146,8 @@ Computing Society and distributed under conditions of the GNU Public
License. LysKOM and its documentation is provided ``as is'' without
warranty of any kind.
This document specifies version 10 of protocol A used between a LysKOM
client and a LysKOM server. Anything described here as ``unspecified''
is liable to change in future protocol versions.
Anything described here as ``unspecified'' is liable to change in
future protocol versions.
This specification is the work of several people. The main contributors have
been
......@@ -124,16 +175,20 @@ The LysKOM developers can be reached by email to
@email{lyskom@@lysator.liu.se}.
@menu
* Document Revision History::
* Document Edition History::
* Protocol Version History::
* Notation::
@end menu
@node Document Revision History
@section Document Revision History
@node Document Edition History
@section Document Edition History
@table @asis
@item 10.4: 2001-04-07
Editorial changes needed to publish an online version at
@uref{http://www.lysator.liu.se/lyskom/protocol/}.
@item 10.3: 2000-09-09
Several aux-items can be set on letterboxes and not only conferences. A
few can now be set on the server. The @code{allowed-content-type} and
......@@ -159,7 +214,7 @@ async-new-recipient and async-sub-recipient.) Distributed with lyskomd
@item 10.0: 1999-06-27
The specification was translated to English and converted to Texinfo by
David Byers. Protocol version 10. Distributed with lyskomd 2.0.0.
Note: this revision incorrectly marked the @code{sub-comment} call as
Note: this edition incorrectly marked the @code{sub-comment} call as
obsolete, and stated that regexp lookup was case insensitive. Both
statements were wrong, and has since been fixed.
......@@ -1065,8 +1120,8 @@ Multiple @code{mx-to} items may be present when multiple recipients are
specified in the header. Clients should display these items along
with the normal LysKOM recipient headers.
Sample contents: @code{john.q.public@@example.com} and
@code{"Joe Q. Public" <john.q.public@@example.com>} are both valid.
Sample contents: Both @code{john.q.public@@example.com} and
@code{"Joe Q. Public" <john.q.public@@example.com>} are valid.
@item mx-cc [20] (text)
......@@ -1208,11 +1263,11 @@ As an example, consider a conference with the following four
3 text/*
@end example
This means that @samp{text/plain} is preferred, that @samp{x-kom/basic}
and @samp{text/enriched} can be used if there is a reason why
@samp{text/plain} is inadequate, and that any text type (such as
@samp{text/html}) is acceptable. Other content types, such as
@samp{x-kom/user-area}, should not be used.
These aux-items taken together means that @samp{text/plain} is
preferred, that @samp{x-kom/basic} and @samp{text/enriched} can be
used if there is a reason why @samp{text/plain} is inadequate, and
that any text type (such as @samp{text/html}) is acceptable. Other
content types, such as @samp{x-kom/user-area}, should not be used.
The server does not currently enforce the above restriction on the
content type of new texts. This mechanism is currently a hint to the
......@@ -5882,9 +5937,9 @@ This call never fails.
@findex create-anonymous-text-old
@example
create-anonymous-text-old [59] (( text : HOLLERITH;
misc-info : ARRAY Misc-Info; ))
-> ( Text-No );
create-anonymous-text-old [59] (( text : HOLLERITH;
misc-info : ARRAY Misc-Info; ))
-> ( Text-No );
@end example
Similar to @pxref{create-text-old}, but the text is created the author
......@@ -6949,10 +7004,10 @@ Too many misc-items or aux-items were specified.
@findex create-anonymous-text
@example
create-anonymous-text [87] (( text : HOLLERITH;
misc-info : ARRAY Misc-Info;
aux-items : ARRAY Aux-Item-Input; ))
-> ( Text-No );
create-anonymous-text [87] (( text : HOLLERITH;
misc-info : ARRAY Misc-Info;
aux-items : ARRAY Aux-Item-Input; ))
-> ( Text-No );
@end example
......@@ -7265,9 +7320,9 @@ This call always succeeds.
@findex modify-system-info
@example
modify-system-info [95] (( items-to-delete : ARRAY Aux-No;
items-to-add : ARRAY Aux-Item-Input; ))
-> ( );
modify-system-info [95] (( items-to-delete : ARRAY Aux-No;
items-to-add : ARRAY Aux-Item-Input; ))
-> ( );
@end example
This call modifies the aux-item list of the server information (which
......@@ -8925,14 +8980,13 @@ When creating aux-items like @code{mx-author}, text coded using the
method in RFC 2047 should be decoded.
@node Type Index
@chapter Type Index
@unnumbered Type Index
@printindex tp
@node Request Index
@chapter Request Index
@unnumbered Request Index
@printindex fn
@contents
@bye
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