Commit 560345bd authored by Per Cederqvist's avatar Per Cederqvist

(all call nodes): Replaced "@unnumberedsubsec Error codes" with

	"@subheading Error codes" so that they are not included in the
	table of contents, and so that the PDF menus work better.
parent 962e526a
\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.106 2001/04/16 09:23:59 ceder Exp $
@c $Id: Protocol-A.texi,v 1.107 2001/04/16 09:54:45 ceder Exp $
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
......@@ -3207,7 +3206,7 @@ in the example.
Log in as a person. This call has been replaced by call 62, @ref{login}.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item undefined-person
@code{person} is not an existing person.
......@@ -3241,7 +3240,7 @@ For a client that needs to log in as several different users, issuing
multiple logout and login requests during one session is faster and
places less load on the server than does creating new sessions.
@unnumberedsubsec Error codes
@subheading Error codes
This call never fails.
......@@ -3258,7 +3257,7 @@ This call never fails.
Change current conference of a session. This call used to be called
pepsi (the name was a very obscure and not very funny joke.)
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -3291,7 +3290,7 @@ person who either has special privileges or is the supervisor of the
conference.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -3331,7 +3330,7 @@ This call tells the server what the logged-in user is doing. The string
is usually displayed when a user requests that a client list who is
using LysKOM. Clients are encouraged to use this call creatively.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item string-too-long
......@@ -3372,7 +3371,7 @@ with the password ``secret.'' The server has returned the person number
six for the person.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -3406,7 +3405,7 @@ This call returns information about a person. If the low bit of
@code{mask} is not set, then the name is not returned. This call is
obsolete and has been replaced by call 49 @ref{get-person-stat}.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -3452,7 +3451,7 @@ d@ae{}mon.
@end iftex
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -3493,7 +3492,7 @@ This example sets the password of the LysKOM administrator to ``t9go8hw''
provided that the old password was ``gazonk''.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -3547,7 +3546,7 @@ number) and that all articles up to and including local number 133 plus
articles 135, 136 and 137 have been read.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item undefined-person
......@@ -3619,7 +3618,7 @@ all Padrone's fault.} which accepts all users as members and accepts
anonymous articles. The server returns 7 as the new conference number.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -3674,7 +3673,7 @@ also be deleted.
This example shows the successful deletion of conference number seven.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -3727,7 +3726,7 @@ any conference (or person). Call number 3 and 4 issues the same lookup
using the @ref{lookup-z-name} call. (The return value for call number 3
has been broken into three lines to fit on the page.)
@unnumberedsubsec Error codes
@subheading Error codes
This call always succeeds.
......@@ -3751,7 +3750,7 @@ the lowest bit is 1 the name is returned, otherwise the empty string is
returned instead of the name.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item undefined-conference
......@@ -3804,7 +3803,7 @@ membership list. The first and last calls of the example show the
membership list for person 119 before and after the call.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -3861,7 +3860,7 @@ This example shows how person 5 is removed from conference one. The
calls to get-membership demonstrate the effects on the LysKOM database.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -3927,7 +3926,7 @@ start with, the person had no presentation, as is shown by the
called, the presentation field has changed.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -3993,7 +3992,7 @@ for conference six (which happens to be a mailbox.) The
the conference structure.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4056,7 +4055,7 @@ supervisor of such a conference, the session issuing the call must have
administration privileges.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4119,7 +4118,7 @@ is evident from the @ref{get-conf-stat-old} calls before and after the
set-permitted-submitters call.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4163,7 +4162,7 @@ set to conference 8. The calls to @ref{get-conf-stat-old} demonstrate the
change in the conference structure.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4208,7 +4207,7 @@ This example shows a user removing the allow-anonymous bit from
conference four. The @ref{get-uconf-stat} call shows all eight bits of
the conference type before and after the set-conf-type call.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4260,7 +4259,7 @@ server unless it has marks.
This example shows the expiration time of conference four being lowered
from 77 to just seven days.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4298,7 +4297,7 @@ with mark type 100, one on text 13042 with mark type 95 and one on text
12213 with mark type 95. The maximum number of marks may be arbitrarily
limited in the LysKOM server.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4322,7 +4321,7 @@ should no longer be used. This call can only set mark-type to a value
in the range 1 to 255 (inclusive). If mark-type is set to 0 the mark
will be removed.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4378,7 +4377,7 @@ from position 0 to position 4. The first reply contains the entire text,
the following two contain only the requested portion.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item no-such-text
......@@ -4431,7 +4430,7 @@ and 15, and it was sent to conference 15 by person 13 at 16:37 on the
day it was created. The text has a single comment: text 311.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item no-such-text
......@@ -4488,7 +4487,7 @@ Text-Stat and calling mark-as-read once for each recipient.
There is no need to call mark-as-read on deleted texts. The server will
automatically mark them as read, sooner or later.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4553,7 +4552,7 @@ fields, the local numbers of the text in each of its recipient
conferences.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4605,7 +4604,7 @@ issuing the command may do so.
This simple example shows the deletion of text number 33467.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4662,7 +4661,7 @@ This example show how conference 5 is added first as a recipient of text
these changes.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4734,7 +4733,7 @@ In this example, conference 5 is removed from the recipient list of text
number 5. When the call is repeated, the server simply returns an error
since conference 5 is not a recipient of the text.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4794,7 +4793,7 @@ In this example, text number two is added as a comment to text number
one. The change is reflected in the Misc-Info List of the texts.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4843,7 +4842,7 @@ lists of the two texts. The @code{sub-comment} is called. The misc-info
lists are changed to reflect the change.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4943,7 +4942,7 @@ retrieve a mapping from a conference where the first local text numbers
have been deleted. In the example local text numbers 1, 2 and 3 no longer
exist, and 4 corresponds to 480, and 5 to 485.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -4984,7 +4983,7 @@ This example demonstrates the call. According to the server the time is
197th day of the year, and that daylight savings time is in effect.
@unnumberedsubsec Error codes
@subheading Error codes
This call always succeeds
......@@ -5019,7 +5018,7 @@ presentation of new persons is conference 2, the conference for door
messages is conference 3, the LysKOM news conference is conference 4 and
the login message is text number 1.
@unnumberedsubsec Error codes
@subheading Error codes
This call always succeeds.
......@@ -5060,7 +5059,7 @@ the footnote link.
In this example, text number two is added as a footnote to text number
one. The change is reflected in the Misc-Info List of the texts.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5111,7 +5110,7 @@ In this example text 2 is a footnote to text 1, as shown by the
misc-info lists of the two texts. The @code{sub-footnote} is called.
The misc-info lists are changed to reflect the change.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5144,7 +5143,7 @@ calls, use @ref{who-is-on} instead.
The returned list contains all sessions where a person is logged in and
the invisible flag of the session is unset.
@unnumberedsubsec Error codes
@subheading Error codes
This call always succeeds.
......@@ -5185,7 +5184,7 @@ has not read anything in the conference.) After calling set-unread and
asking to have zero unread texts in conference 6, this is reflected by
the call to query-read-texts.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5224,7 +5223,7 @@ This example shows how the login message of LysKOM is set using the
set-motd-of-lyskom call. The results of the @code{get-info} calls
demonstrate the effect.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5264,7 +5263,7 @@ without the right privilege bits set, it has no effect.
This example shows how @code{enable} makes a privileged call possible,
in this case a call to @ref{set-motd-of-lyskom}.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5300,7 +5299,7 @@ privileges, then the @code{sync-kom} call is used to save the database.
The server responds with two asynchronous messages signaling that the
database is being saved.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5334,7 +5333,7 @@ This example shows the shutdown of a server. The asynchronous message
sent after the call returns is the result of a session being forced to
log out.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5356,7 +5355,7 @@ Administrator bit not set or privileges not enabled.
This call can been replaced by @ref{send-message}. It is a privileged
call.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5417,7 +5416,7 @@ memberships. The next two calls retrieve a single membership each. The
first by asking for only one, and the second by asking for four
memberships, starting with number 1.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5489,7 +5488,7 @@ no longer exists the server instead returns information about eight
texts staring from the twelfth text person 10 created. One of the eight
texts has been deleted.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5536,7 +5535,7 @@ conference 6. The last request is for members 2 and 3 in conference 6.
As can be seen from the examples, the returned list is truncated if
there are fewer members than requested.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item undefined-conference
......@@ -5574,7 +5573,7 @@ This simple example shows how person number 8 is retrieved from the
server. The second call shows the @code{get-conf-stat-old} call on the same
ID number.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item undefined-person
......@@ -5620,7 +5619,7 @@ future.
This simple example retrieves conferences 1 and 8 from the server.
Conference 1 is a regular conference, and conference 8 is a mailbox.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item undefined-conference
......@@ -5646,7 +5645,7 @@ 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}.)
@unnumberedsubsec Error codes
@subheading Error codes
This call always succeeds.
......@@ -5689,7 +5688,7 @@ request is for the unread conferences of person 1000, but that person
didn't exist in the test database.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5729,7 +5728,7 @@ This call sends the message @code{message} to all members of
@t{%1 42 0}
@end example
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5761,7 +5760,7 @@ This call is obsolete. It has been replaced by
@pxref{get-session-info-ident} for more information.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5806,7 +5805,7 @@ disconnected is the logout message for the user that was logged on in
the session. The ``Connection closed by foreign host.'' is not part of
the server output. This message was generated by telnet.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5841,7 +5840,7 @@ call.
In this example the session number of the session issuing the call is
seven.
@unnumberedsubsec Error codes
@subheading Error codes
This call always succeeds.
......@@ -5877,7 +5876,7 @@ In this example the user area of person 7 is set to text number 11. The
original user area was text numbers zero, which means that the person
had no user area.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -5925,7 +5924,7 @@ July 18 was text number 8; and the text created most recently before
22:06 on July 1st was text number 0, which means that there is no text
that old in the database.
@unnumberedsubsec Error codes
@subheading Error codes
This call never fails.
......@@ -5973,7 +5972,7 @@ the client. The misc-info list in this message has two additional
fields, the local numbers of the text in each of its recipient
conferences.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -6031,7 +6030,7 @@ database by calling @code{find-next-text} with @code{start} set to zero.
In the example, the first text is number 2. The second example gets the
text following number 2, which happens to be text number 4.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item no-such-text
......@@ -6064,7 +6063,7 @@ This example shows that the last readable text in the database is number
134217727 have been deleted.) It also shows that the most recent text
before number 4 is text number 2.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item no-such-text
......@@ -6115,7 +6114,7 @@ login message is sent, but not a logout message since the login was
invisible. The third example shows a third login as person 7, but this
time both the logout and login messages are sent.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item undefined-person
......@@ -6146,7 +6145,7 @@ This call is obsolete. It has been replaced by @pxref{who-is-on-dynamic}
and @pxref{get-static-session-info}. It returns a list of all visible
sessions.
@unnumberedsubsec Error codes
@subheading Error codes
This call always succeeds.
......@@ -6163,7 +6162,7 @@ This call always succeeds.
This call is obsolete. Use @pxref{who-is-on-dynamic} and
@code{get-static-session-info} instead.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -6187,7 +6186,7 @@ returns a list of persons matching the regular expression
@code{regexp}. The regexp syntax used is that of the @code{ed}(1) Unix
utility.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item regexp-error
......@@ -6210,7 +6209,7 @@ returns a list of conferences matching the regular expression
@code{regexp}. The regexp syntax used is that of the @code{ed}(1) Unix
utility.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item regexp-error
......@@ -6236,7 +6235,7 @@ This call returns a list of persons with names matching the
contracted name in @code{name}. See @pxref{Name Expansion} for a
description of the matching process.
@unnumberedsubsec Error codes
@subheading Error codes
This call always succeeds.
......@@ -6257,7 +6256,7 @@ This call returns a list of conferences with names matching the
contracted name in @code{name}. See @pxref{Name Expansion} for a
description of the matching process.
@unnumberedsubsec Error codes
@subheading Error codes
This call always succeeds.
......@@ -6312,7 +6311,7 @@ server. Finally @pxref{get-client-version} is used to retrieve the
client version of session number 7, which is, as expected, the string
``0.45''.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item string-too-long
......@@ -6341,7 +6340,7 @@ is returned.
See @pxref{set-client-version} for an example of this call.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -6368,7 +6367,7 @@ the client using @pxref{set-client-version}. If
See @pxref{set-client-version} for an example of this call.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -6409,7 +6408,7 @@ servers should not delete texts that have marks, except by user request.
This example shows how a person with no marks set sets mark 230 on text
number 110. The calls to @pxref{get-marks} show the effect of the call.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -6451,7 +6450,7 @@ This call removes any marks the logged-in person has set on the text
This example shows how a user with a mark set on text number 110 removes
it using the @code{unmark-text} call.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -6505,7 +6504,7 @@ result is only to contain conferences, so the two persons are not
returned. The third example simply returns all names matching the
pattern ``T.*[cC]''.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item regexp-error
......@@ -6537,7 +6536,7 @@ capabilities are.
This example lets us know that the server is lyskomd, version 1.9.0,
which at the time of writing this is the only really usable server.
@unnumberedsubsec Error codes
@subheading Error codes
This call always succeeds.
......@@ -6582,7 +6581,7 @@ looks up the same name as the first, but this time the result is
restricted to conferences. The final request requests all conferences
and persons matching the pattern ``T C''.
@unnumberedsubsec Error codes
@subheading Error codes
This call always succeeds.
......@@ -6616,7 +6615,7 @@ including local text number 6 in conference 6. After the call to
@code{set-last-read}, the @pxref{query-read-texts} call reports that
person 7 has read everything up to and including local text number 3.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -6666,7 +6665,7 @@ This example shows the difference between @pxref{get-conf-stat-old} and
retrieved, and in the second two, conference 7, which happens to be a
person, is retrieved. Note the difference in length of the flag field.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item undefined-conference
......@@ -6703,7 +6702,7 @@ the news conference to four. It also sets the login message to text
1080. It also attempts to set the version number to 1.9.1, but that
number is silently ignored by the server.
@unnumberedsubsec Error codes
@subheading Error codes
@table @code
@item login-first
......@@ -6758,7 +6757,7 @@ This example tells the server that the client wants to receive
asynchronous messages when the database is being synched (message 7) and
when someone logs in (message 9).
@unnumberedsubsec Error codes
@subheading Error codes
If the client requests a message that the server does not send, the
server will reply with an error message saying which message number it
......@@ -6815,7 +6814,7 @@ particular set was the default for new connections to lyskomd 1.9
servers. @xref{Asynchronous Messages}, for the currently recommended
list of asynchronous messages that servers should preselect.
@unnumberedsubsec Error codes
@subheading Error codes
This call always succeeds.
......@@ -6839,7 +6838,7 @@ comment, gives a command, de-iconifies the LysKOM window, et c.
However, the call should not be issued more than twice per minute, to
avoid excessive network and server load.
@unnumberedsubsec Error codes
@subheading Error codes