diff --git a/doc/Protocol-A.texi b/doc/Protocol-A.texi index e62d936f8abb48e795af6e55a956fe588064e7e2..507e865fa39bb8e386a40cf4d53c7ac66590c38d 100644 --- a/doc/Protocol-A.texi +++ b/doc/Protocol-A.texi @@ -8,7 +8,7 @@ @c FIXME: Check for too much text before @menu. @c FIXME: error-reply defined twice (conflicting). @c -@c $Id: Protocol-A.texi,v 1.125 2001/05/01 11:18:47 ceder Exp $ +@c $Id: Protocol-A.texi,v 1.126 2001/05/01 11:47:28 ceder Exp $ @c %**start of header @setfilename protocol-a.info @settitle LysKOM Protocol A @@ -2094,15 +2094,15 @@ the more complex data types. @tindex Time @example Time ::= - ( seconds : INT32; - minutes : INT32; - hours : INT32; - day : INT32; - month : INT32; - year : INT32; - day-of-week : INT32; - day-of-year : INT32; - is-dst : BOOL; + ( seconds : @lt{INT32}; + minutes : @lt{INT32}; + hours : @lt{INT32}; + day : @lt{INT32}; + month : @lt{INT32}; + year : @lt{INT32}; + day-of-week : @lt{INT32}; + day-of-year : @lt{INT32}; + is-dst : @lt{BOOL}; ) @end example @@ -2125,7 +2125,7 @@ All times are expressed in the time zone of the server. @tindex Conf-No @example - Conf-No ::= INT16; + Conf-No ::= @lt{INT16}; @end example This type denotes a conference number. @@ -2140,11 +2140,11 @@ This type denotes a conference number. @tindex Local-Text-No @tindex Text-List @example - Text-No ::= INT32; - Local-Text-No ::= INT32; + Text-No ::= @lt{INT32}; + Local-Text-No ::= @lt{INT32}; Text-List ::= - ( first-local-no : Local-Text-No; - texts : ARRAY Text-No; + ( first-local-no : @lt{Local-Text-No}; + texts : @lt{ARRAY} @lt{Text-No}; ) @end example @@ -2160,8 +2160,8 @@ global numbers are required. @tindex Pers-No @tindex Session-No @example - Pers-No ::= Conf-No; - Session-No ::= INT32; + Pers-No ::= @lt{Conf-No}; + Session-No ::= @lt{INT32}; @end example @type{Pers-No} is used to indicate a person. @type{Session-No} is used @@ -2179,23 +2179,23 @@ sessions. @tindex Aux-Item-Input @tindex Aux-Item-Flags @example - Aux-No ::= INT32; + Aux-No ::= @lt{INT32}; Aux-Item ::= - ( aux-no : Aux-No; - tag : INT32; - creator : Pers-No; - created-at : Time; - flags : Aux-Item-Flags; - inherit-limit : INT32; - data : HOLLERITH; + ( aux-no : @lt{Aux-No}; + tag : @lt{INT32}; + creator : @lt{Pers-No}; + created-at : @lt{Time}; + flags : @lt{Aux-Item-Flags}; + inherit-limit : @lt{INT32}; + data : @lt{HOLLERITH}; ) Aux-Item-Input ::= - ( tag : INT32; - flags : Aux-Item-Flags; - inherit-limit : INT32; - data : HOLLERITH; + ( tag : @lt{INT32}; + flags : @lt{Aux-Item-Flags}; + inherit-limit : @lt{INT32}; + data : @lt{HOLLERITH}; ) Aux-Item-Flags ::= BITSTRING @@ -2296,7 +2296,7 @@ The object the item is set on will not be garbage-collected. reserved3; ) - Any-Conf-Type ::= Conf-Type | Extended-Conf-Type; + Any-Conf-Type ::= @lt{Conf-Type} | @lt{Extended-Conf-Type}; @end example These types are used to specify the type of a conference. @@ -2342,9 +2342,9 @@ conference is created these should always be set to zero. @tindex Conf-Z-Info @example Conf-Z-Info ::= - ( name : HOLLERITH; - type : Conf-Type; - conf-no : Conf-No; + ( name : @lt{HOLLERITH}; + type : @lt{Conf-Type}; + conf-no : @lt{Conf-No}; ) @end example @@ -2361,52 +2361,52 @@ conferences based on their names. @tindex Conference @tindex UConference @example - Garb-Nice ::= INT32; + Garb-Nice ::= @lt{INT32}; Conference-Old ::= - ( name : HOLLERITH; - type : Conf-Type; - creation-time : Time; - last-written : Time; - creator : Pers-No; - presentation : Text-No; - supervisor : Conf-No; - permitted-submitters : Conf-No; - super-conf : Conf-No; - msg-of-day : Text-No; - nice : Garb-Nice; - no-of-members : INT16; - first-local-no : Local-Text-No; - no-of-texts : INT32; + ( name : @lt{HOLLERITH}; + type : @lt{Conf-Type}; + creation-time : @lt{Time}; + last-written : @lt{Time}; + creator : @lt{Pers-No}; + presentation : @lt{Text-No}; + supervisor : @lt{Conf-No}; + permitted-submitters : @lt{Conf-No}; + super-conf : @lt{Conf-No}; + msg-of-day : @lt{Text-No}; + nice : @lt{Garb-Nice}; + no-of-members : @lt{INT16}; + first-local-no : @lt{Local-Text-No}; + no-of-texts : @lt{INT32}; ) @anchor{Conference} Conference ::= - ( name : HOLLERITH; - type : Extended-Conf-Type; - creation-time : Time; - last-written : Time; - creator : Pers-No; - presentation : Text-No; - supervisor : Conf-No; - permitted-submitters : Conf-No; - super-conf : Conf-No; - msg-of-day : Text-No; - nice : Garb-Nice; - keep-commented : Garb-Nice; - no-of-members : INT16; - first-local-no : Local-Text-No; - no-of-texts : INT32; - expire : Garb-Nice; - aux-items : ARRAY Aux-Item; + ( name : @lt{HOLLERITH}; + type : @lt{Extended-Conf-Type}; + creation-time : @lt{Time}; + last-written : @lt{Time}; + creator : @lt{Pers-No}; + presentation : @lt{Text-No}; + supervisor : @lt{Conf-No}; + permitted-submitters : @lt{Conf-No}; + super-conf : @lt{Conf-No}; + msg-of-day : @lt{Text-No}; + nice : @lt{Garb-Nice}; + keep-commented : @lt{Garb-Nice}; + no-of-members : @lt{INT16}; + first-local-no : @lt{Local-Text-No}; + no-of-texts : @lt{INT32}; + expire : @lt{Garb-Nice}; + aux-items : @lt{ARRAY} @lt{Aux-Item}; ) @anchor{UConference} UConference ::= - ( name : HOLLERITH; - type : Extended-Conf-Type; - highest-local-no : Local-Text-No; - nice : Garb-Nice; + ( name : @lt{HOLLERITH}; + type : @lt{Extended-Conf-Type}; + highest-local-no : @lt{Local-Text-No}; + nice : @lt{Garb-Nice}; ) @end example @@ -2489,10 +2489,10 @@ grammar used in this document. This is as close as it gets: @tindex Conf-List-Archaic @example - Conf-List-Archaic ::= - ( conf-nos : ARRAY Conf-No; - conf-types : ARRAY Conf-Type; ! Sans @var{n}; see below - ) + Conf-List-Archaic ::= + ( conf-nos : @lt{ARRAY} @lt{Conf-No}; + conf-types : @lt{ARRAY} @lt{Conf-Type}; ! Sans @var{n}; see below + ) @end example The two arrays @field{conf-nos} and @field{conf-types} are always the same @@ -2508,22 +2508,22 @@ actually transmitted. See also the example in @ref{lookup-name}. @tindex Text-Number-Pair @example Text-Mapping ::= - ( range-begin : Local-Text-No; - range-end : Local-Text-No; - later-texts-exists : BOOL; - block : Local-To-Global-Block; + ( range-begin : @lt{Local-Text-No}; + range-end : @lt{Local-Text-No}; + later-texts-exists : @lt{BOOL}; + block : @lt{Local-To-Global-Block}; ) @anchor{Local-To-Global-Block} Local-To-Global-Block ::= SELECTION - ( 0=sparse sparse-block : ARRAY Text-Number-Pair; - 1=dense dense-block : Text-List; + ( 0=sparse sparse-block : @lt{ARRAY} @lt{Text-Number-Pair}; + 1=dense dense-block : @lt{Text-List}; ) @anchor{Text-Number-Pair} Text-Number-Pair ::= - ( local-number : Local-Text-No; - global-number : Text-No; + ( local-number : @lt{Local-Text-No}; + global-number : @lt{Text-No}; ) @end example @@ -2574,30 +2574,30 @@ indicate that a certain local text number doesn't exist. @tindex Version-Info @example Info ::= - ( version : INT32; - conf-pres-conf : Conf-No; - pers-pres-conf : Conf-No; - motd-conf : Conf-No; - kom-news-conf : Conf-No; - motd-of-lyskom : Text-No; - aux-item-list : ARRAY Aux-Item; + ( version : @lt{INT32}; + conf-pres-conf : @lt{Conf-No}; + pers-pres-conf : @lt{Conf-No}; + motd-conf : @lt{Conf-No}; + kom-news-conf : @lt{Conf-No}; + motd-of-lyskom : @lt{Text-No}; + aux-item-list : @lt{ARRAY} @lt{Aux-Item}; ) @anchor{Info-Old} Info-Old ::= - ( version : INT32; - conf-pres-conf : Conf-No; - pers-pres-conf : Conf-No; - motd-conf : Conf-No; - kom-news-conf : Conf-No; - motd-of-lyskom : Text-No; + ( version : @lt{INT32}; + conf-pres-conf : @lt{Conf-No}; + pers-pres-conf : @lt{Conf-No}; + motd-conf : @lt{Conf-No}; + kom-news-conf : @lt{Conf-No}; + motd-of-lyskom : @lt{Text-No}; ) @anchor{Version-Info} Version-Info ::= - ( protocol-version : INT32; - server-software : HOLLERITH; - software-version : HOLLERITH; + ( protocol-version : @lt{INT32}; + server-software : @lt{HOLLERITH}; + software-version : @lt{HOLLERITH}; ) @end example @@ -2648,23 +2648,23 @@ Human-readable name of the server software version. @tindex Priv-Bits @example Person ::= - ( username : HOLLERITH; - privileges : Priv-Bits; - flags : Personal-Flags; - last-login : Time; - user-area : Text-No; - total-time-present : INT32; - sessions : INT32; - created-lines : INT32; - created-bytes : INT32; - read-texts : INT32; - no-of-text-fetches : INT32; - created-persons : INT16; - created-confs : INT16; - first-created-local-no : INT32; - no-of-created-texts : INT32; - no-of-marks : INT16; - no-of-confs : INT16; + ( username : @lt{HOLLERITH}; + privileges : @lt{Priv-Bits}; + flags : @lt{Personal-Flags}; + last-login : @lt{Time}; + user-area : @lt{Text-No}; + total-time-present : @lt{INT32}; + sessions : @lt{INT32}; + created-lines : @lt{INT32}; + created-bytes : @lt{INT32}; + read-texts : @lt{INT32}; + no-of-text-fetches : @lt{INT32}; + created-persons : @lt{INT16}; + created-confs : @lt{INT16}; + first-created-local-no : @lt{INT32}; + no-of-created-texts : @lt{INT32}; + no-of-marks : @lt{INT16}; + no-of-confs : @lt{INT16}; ) @anchor{Personal-Flags} @@ -2795,10 +2795,10 @@ existing memberships. @tindex Member @example Member ::= - ( member : Pers-No; - added-by : Pers-No; - added-at : Time; - type : Membership-Type; + ( member : @lt{Pers-No}; + added-by : @lt{Pers-No}; + added-at : @lt{Time}; + type : @lt{Membership-Type}; ) @end example @@ -2829,24 +2829,24 @@ to see the contents of the structure. @tindex Membership @example Membership-Old ::= - ( last-time-read : Time; - conference : Conf-No; - priority : INT8; - last-text-read : Local-Text-No; - read-texts : ARRAY Local-Text-No; + ( last-time-read : @lt{Time}; + conference : @lt{Conf-No}; + priority : @lt{INT8}; + last-text-read : @lt{Local-Text-No}; + read-texts : @lt{ARRAY} @lt{Local-Text-No}; ) @anchor{Membership} Membership ::= - ( position : INT32; - last-time-read : Time; - conference : Conf-No; - priority : INT8; - last-text-read : Local-Text-No; - read-texts : ARRAY Local-Text-No; - added-by : Pers-No; - added-at : Time; - type : Membership-Type; + ( position : @lt{INT32}; + last-time-read : @lt{Time}; + conference : @lt{Conf-No}; + priority : @lt{INT8}; + last-text-read : @lt{Local-Text-No}; + read-texts : @lt{ARRAY} @lt{Local-Text-No}; + added-by : @lt{Pers-No}; + added-at : @lt{Time}; + type : @lt{Membership-Type}; ) @end example @@ -2891,8 +2891,8 @@ to know about the person. @tindex Mark @example Mark ::= - ( text-no : Text-No; - type : INT8; + ( text-no : @lt{Text-No}; + type : @lt{INT8}; ) @end example @@ -2921,41 +2921,41 @@ values. @tindex Info-Type @example Misc-Info ::= SELECTION - ( 0=recpt recipient : Conf-No; - 1=cc-recpt cc-recipient : Conf-No; - 2=comm-to comment-to : Text-No; - 3=comm-in commented-in : Text-No; - 4=footn-to footnote-to : Text-No; - 5=footn-in footnoted-in : Text-No; - 6=loc-no local-no : Local-Text-No; - 7=rec-time received-at : Time; - 8=sent-by sender : Pers-No; - 9=sent-at sent-at : Time; - 15=bcc-recpt bcc-recipient : Conf-No; + ( 0=recpt recipient : @lt{Conf-No}; + 1=cc-recpt cc-recipient : @lt{Conf-No}; + 2=comm-to comment-to : @lt{Text-No}; + 3=comm-in commented-in : @lt{Text-No}; + 4=footn-to footnote-to : @lt{Text-No}; + 5=footn-in footnoted-in : @lt{Text-No}; + 6=loc-no local-no : @lt{Local-Text-No}; + 7=rec-time received-at : @lt{Time}; + 8=sent-by sender : @lt{Pers-No}; + 9=sent-at sent-at : @lt{Time}; + 15=bcc-recpt bcc-recipient : @lt{Conf-No}; ) @anchor{Info-Type} - Info-Type ::= ENUMERATION-OF(Misc-Info) + Info-Type ::= ENUMERATION-OF(@lt{Misc-Info}) @anchor{Text-Stat-Old} Text-Stat-Old ::= - ( creation-time : Time; - author : Pers-No; - no-of-lines : INT32; - no-of-chars : INT32; - no-of-marks : INT16; - misc-info : ARRAY Misc-Info; + ( creation-time : @lt{Time}; + author : @lt{Pers-No}; + no-of-lines : @lt{INT32}; + no-of-chars : @lt{INT32}; + no-of-marks : @lt{INT16}; + misc-info : @lt{ARRAY} @lt{Misc-Info}; ) @anchor{Text-Stat} Text-Stat ::= - ( creation-time : Time; - author : Pers-No; - no-of-lines : INT32; - no-of-chars : INT32; - no-of-marks : INT16; - misc-info : ARRAY Misc-Info; - aux-items : ARRAY Aux-Item; + ( creation-time : @lt{Time}; + author : @lt{Pers-No}; + no-of-lines : @lt{INT32}; + no-of-chars : @lt{INT32}; + no-of-marks : @lt{INT16}; + misc-info : @lt{ARRAY} @lt{Misc-Info}; + aux-items : @lt{ARRAY} @lt{Aux-Item}; ) @end example @@ -3032,27 +3032,27 @@ introduced in protocol version 10 or later. @tindex Who-Info-Ident @example Who-Info-Old ::= - ( person : Pers-No; - working-conference : Conf-No; - what-am-i-doing : HOLLERITH; + ( person : @lt{Pers-No}; + working-conference : @lt{Conf-No}; + what-am-i-doing : @lt{HOLLERITH}; ) Who-Info ::= - ( person : Pers-No; - working-conference : Conf-No; - session : Session-No; - what-am-i-doing : HOLLERITH; - username : HOLLERITH; + ( person : @lt{Pers-No}; + working-conference : @lt{Conf-No}; + session : @lt{Session-No}; + what-am-i-doing : @lt{HOLLERITH}; + username : @lt{HOLLERITH}; ) Who-Info-Ident ::= - ( person : Pers-No; - working-conference : Conf-No; - session : Session-No; - what-am-i-doing : HOLLERITH; - username : HOLLERITH; - hostname : HOLLERITH; - ident-user : HOLLERITH; + ( person : @lt{Pers-No}; + working-conference : @lt{Conf-No}; + session : @lt{Session-No}; + what-am-i-doing : @lt{HOLLERITH}; + username : @lt{HOLLERITH}; + hostname : @lt{HOLLERITH}; + ident-user : @lt{HOLLERITH}; ) @end example @@ -3125,34 +3125,34 @@ at the user's machine or ``unknown'' if Ident was not used. @tindex Dynamic-Session-Info @example Session-Info ::= - ( person : Pers-No; - working-conference : Conf-No; - session : Session-No; - what-am-i-doing : HOLLERITH; - username : HOLLERITH; - idle-time : INT32; - connection-time : Time; + ( person : @lt{Pers-No}; + working-conference : @lt{Conf-No}; + session : @lt{Session-No}; + what-am-i-doing : @lt{HOLLERITH}; + username : @lt{HOLLERITH}; + idle-time : @lt{INT32}; + connection-time : @lt{Time}; ) Session-Info-Ident ::= - ( person : Pers-No; - working-conference : Conf-No; - session : Session-No; - what-am-i-doing : HOLLERITH; - username : HOLLERITH; - hostname : HOLLERITH; - ident-user : HOLLERITH; - idle-time : INT32; - connection-time : Time; + ( person : @lt{Pers-No}; + working-conference : @lt{Conf-No}; + session : @lt{Session-No}; + what-am-i-doing : @lt{HOLLERITH}; + username : @lt{HOLLERITH}; + hostname : @lt{HOLLERITH}; + ident-user : @lt{HOLLERITH}; + idle-time : @lt{INT32}; + connection-time : @lt{Time}; ) @anchor{Static-Session-Info} Static-Session-Info ::= ( - username : HOLLERITH; - hostname : HOLLERITH; - ident-user : HOLLERITH; - connection-time : Time; + username : @lt{HOLLERITH}; + hostname : @lt{HOLLERITH}; + ident-user : @lt{HOLLERITH}; + connection-time : @lt{Time}; ) @anchor{Session-Flags} @@ -3169,12 +3169,12 @@ at the user's machine or ``unknown'' if Ident was not used. @anchor{Dynamic-Session-Info} Dynamic-Session-Info ::= - ( session : Session-No; - person : Pers-No; - working-conference : Conf-No; - idle-time : INT32; - flags : Session-Flags; - what-am-i-doing : HOLLERITH; + ( session : @lt{Session-No}; + person : @lt{Pers-No}; + working-conference : @lt{Conf-No}; + idle-time : @lt{INT32}; + flags : @lt{Session-Flags}; + what-am-i-doing : @lt{HOLLERITH}; ) @end example