Commit 5790234e authored by Per Cederqvist's avatar Per Cederqvist

(LysKOM Data Types): Split into several subnodes. Updated all cross

	references to point to the relevant subnode.
parent d4ae2c37
......@@ -22,7 +22,7 @@
@c FIXME: "Review the last N by FOO to BAR" is empty
@c FIXME: "Remote control" contains no information
@c
@c $Id: Protocol-A.texi,v 1.141 2001/05/05 08:28:13 ceder Exp $
@c $Id: Protocol-A.texi,v 1.142 2001/05/05 20:44:24 ceder Exp $
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
......@@ -720,7 +720,7 @@ setting it on the person (another reason was that I was fed up writing
aux-item code by the time they were working on texts and conferences.)
The exact structure of an aux item is specified elsewhere
(@pxref{LysKOM Data Types}). The important fields here are the
(@pxref{Auxiliary Information}). The important fields here are the
@field{aux-no}, @field{tag} and @field{data} fields.
The @field{aux-no} field is used to identify an item. The
......@@ -1445,6 +1445,24 @@ asynchronous messages, even though these are also data types.
Since the types defined here are all based on the simple types, the
definitions are more concise in this section.
@menu
* Common Types::
* Auxiliary Information::
* Conference Types::
* Conference Search Results::
* Conference Status Types::
* Archaic way to list conferences::
* Mapping Local to Global Text Numbers::
* Server Information::
* Person Status Types::
* Membership Information::
* Article Marks::
* Article Information::
* Who Information::
* Session Information::
@end menu
@node Common Types
@section Common Types
The types defined in this section are fairly simple and used in many of
......@@ -1493,6 +1511,7 @@ All times are expressed in the time zone of the server.
This type denotes a conference number.
@need 1511
@anchor{Text-No}
@anchor{Local-Text-No}
@anchor{Text-List}
......@@ -1530,12 +1549,13 @@ global numbers are required.
in a few data structures relating to information about active LysKOM
sessions.
@node Auxiliary Information
@section Auxiliary Information
@anchor{Aux-No}
@anchor{Aux-Item}
@anchor{Aux-Item-Input}
@anchor{Aux-Item-Flags}
@section Auxiliary Information
@tindex Aux-No
@tindex Aux-Item
@tindex Aux-Item-Input
......@@ -1560,6 +1580,7 @@ sessions.
data : @lt{HOLLERITH};
)
@need 2200
Aux-Item-Flags ::= BITSTRING
( deleted;
inherit;
......@@ -1631,11 +1652,12 @@ The object the item is set on will not be garbage-collected.
@end table
@node Conference Types
@section Conference Types
@anchor{Conf-Type}
@anchor{Extended-Conf-Type}
@anchor{Any-Conf-Type}
@section Conference Types
@tindex Conf-Type
@tindex Extended-Conf-Type
@tindex Any-Conf-Type
......@@ -1698,9 +1720,10 @@ conference is created these should always be set to zero.
@end table
@anchor{Conf-Z-Info}
@node Conference Search Results
@section Conference Search Results
@anchor{Conf-Z-Info}
@tindex Conf-Z-Info
@example
Conf-Z-Info ::=
......@@ -1714,10 +1737,11 @@ These types are used for the result of some calls that search for
conferences based on their names.
@anchor{Garb-Nice}
@anchor{Conference-Old}
@node Conference Status Types
@section Conference Status Types
@anchor{Garb-Nice}
@anchor{Conference-Old}
@tindex Garb-Nice
@tindex Conference-Old
@tindex Conference
......@@ -1843,9 +1867,10 @@ The number of days an article should be kept before being removed from
the conference.
@end table
@anchor{Conf-List-Archaic}
@node Archaic way to list conferences
@section Archaic way to list conferences
@anchor{Conf-List-Archaic}
The result of request number 12, lookup-name, cannot be expressed in the
grammar used in this document. This is as close as it gets:
......@@ -1862,9 +1887,10 @@ size. For some obscure reason the size of the second array is not
actually transmitted. See also the example in @ref{lookup-name}.
@anchor{Text-Mapping}
@node Mapping Local to Global Text Numbers
@section Mapping Local to Global Text Numbers
@anchor{Text-Mapping}
@tindex Text-Mapping
@tindex Local-To-Global-Block
@tindex Text-Number-Pair
......@@ -1928,9 +1954,10 @@ indicate that a certain local text number doesn't exist.
@end table
@anchor{Info}
@node Server Information
@section Server Information
@anchor{Info}
@tindex Info
@tindex Info-Old
@tindex Version-Info
......@@ -2002,9 +2029,10 @@ Human-readable name of the server software version.
@end table
@anchor{Person}
@node Person Status Types
@section Person Status Types
@anchor{Person}
@tindex Person
@tindex Personal-Flags
@tindex Priv-Bits
......@@ -2112,9 +2140,10 @@ The number of conferences the person is a member of.
@end table
@anchor{Membership-Type}
@node Membership Information
@section Membership Information
@anchor{Membership-Type}
@tindex Membership-Type
@example
Membership-Type ::= BITSTRING
......@@ -2247,9 +2276,10 @@ privileges to see the contents membership, but has sufficient privileges
to know about the person.
@anchor{Mark}
@node Article Marks
@section Article Marks
@anchor{Mark}
@tindex Mark
@example
Mark ::=
......@@ -2274,9 +2304,10 @@ unspecified. Work is underway to specify the meaning of certain mark
values.
@anchor{Misc-Info}
@node Article Information
@section Article Information
@anchor{Misc-Info}
@tindex Misc-Info
@tindex Text-Stat-Old
@tindex Text-Stat
......@@ -2383,11 +2414,12 @@ introduced in protocol version 10 or later.
@end table
@node Who Information
@section Who Information
@anchor{Who-Info-Old}
@anchor{Who-Info}
@anchor{Who-Info-Ident}
@section Who Information
@tindex Who-Info-Old
@tindex Who-Info
@tindex Who-Info-Ident
......@@ -2476,9 +2508,11 @@ at the user's machine or ``unknown'' if Ident was not used.
@node Session Information
@section Session Information
@anchor{Session-Info}
@anchor{Session-Info-Ident}
@section Session Information
@tindex Session-Info
@tindex Session-Info-Ident
@tindex Static-Session-Info
......@@ -4598,7 +4632,7 @@ This call always succeeds
@end example
This call returns the @type{Info-Old} structure for the server
(@pxref{LysKOM Data Types}). Clients should call this in order to find
(@pxref{Info-Old}). Clients should call this in order to find
out which conferences are used for presentations and such.
This call has been superceded by @reqlink{get-info}.
......@@ -5256,7 +5290,7 @@ use it.
This call should simply return a list of visible sessions (sessions
where a person is logged in and the invisible flag is unset). The data
structure is described elsewhere (@pxref{LysKOM Data Types}).
structure is described elsewhere (@pxref{Who-Info}).
@subheading Error codes
......@@ -5708,9 +5742,9 @@ There is no text preceding text @rarg{start}.
This call is used to log in. The session is logged in as person number
@rarg{person} if @rarg{passwd} is the correct password for that person.
If @rarg{invisible} is true, the session is invisible. It will not be
returned by @req{who-is-on} and @req{who-is-on-ident} and the
dynamic session info (@pxref{LysKOM Data Types})
If @rarg{invisible} is true, the session is invisible: it will not be
returned by @reqlink{who-is-on} and @reqlink{who-is-on-ident}, and the
dynamic session info (@pxref{Dynamic-Session-Info})
will have the invisible flag set.
Invisible sessions are primarily used by software agents that do not act
......@@ -6934,7 +6968,7 @@ One of the items in @rarg{add} is illegal for some reason.
@end example
This call returns the @type{Info} structure for the server
(@pxref{LysKOM Data Types}). Clients should call this in order to find
(@pxref{Info}). Clients should call this in order to find
out which conferences are used for presentations and such.
It can be issued without logging in.
......
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