empire/empserver
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor clarifications. Document play's use of C_EXIT for errors.

Browse source
This commit is contained in:
Markus Armbruster 2006-02-23 07:21:22 +00:00
parent 0e8b31500e
commit c6884e9c77
1 changed files with 11 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

20
doc/clients-howto
View file

@ -90,10 +90,10 @@ Login commands are:
* kill * kill
Country must be logged in.
If another connection is open for this country, forcibly close it, If another connection is open for this country, forcibly close it,
else do nothing. Reply is C_EXIT in either case. else do nothing. Country must be authenticated.
Reply is C_EXIT regardless of success.
* options OPTION[=VALUE]... * options OPTION[=VALUE]...
@ -105,7 +105,7 @@ Login commands are:
The server accepts the request by sending C_CMDOK. If the server The server accepts the request by sending C_CMDOK. If the server
encounters an unknown option, it rejects the request by sending encounters an unknown option, it rejects the request by sending
C_BADCMD. It rejects unsupported values by sending C_CMDERR. It C_BADCMD. It rejects unsupported values by sending C_CMDERR. It
may or may not process valid parts of such a rejected request. may or may not process valid parts of rejected requests.
If there are no arguments, the server lists its options. For each If there are no arguments, the server lists its options. For each
option, it sends a C_DATA line with OPTION=VALUE as text. option, it sends a C_DATA line with OPTION=VALUE as text.
@ -114,19 +114,21 @@ Login commands are:
* pass PASSWORD * pass PASSWORD
Log in. Country name must be set already. Authenticate. Country name must be set already.
* play [USER [COUNTRY [PASSWORD]]] * play [USER [COUNTRY [PASSWORD]]]
Start playing.
Optional argument USER sets the user name. Optional argument USER sets the user name.
Optional argument COUNTRY sets the country name. Optional argument COUNTRY sets the country name.
Optional argument PASSWORD logs in. If it isn't present, the Optional argument PASSWORD authenticates. If it isn't present, the
country must be logged in already. country must be authenticated already.
If another connection is open for this country, the server replies Some error conditions result in a C_EXIT reply. Clients should
C_EXIT. treat it just like C_CMDERR.
On success, the server sends C_INIT. The text is the protocol On success, the server sends C_INIT. The text is the protocol
version number in decimal, currently 2. The client should terminate version number in decimal, currently 2. The client should terminate