                ====================================
                PMICS User Guide: version 2.0 BETA 2
                ====================================

------------
Introduction
------------

PMICS is an OS/2 Warp interface for playing chess via the numerous chess
servers found on the internet. PMICS requires OS/2 Warp V3.0 or better and a
TCP/IP connection to the internet (such as the IBM Internet Connection supplied
on the OS/2 Warp BonusPak, or OS/2 Warp Connect). You must also use a mouse.


-----------------------
About this beta version
-----------------------

This is a completely re-worked version of the original PMICS. New users will
find it easy to set up and get going.

Many things have changed from PMICS V1.0, including the author! First, PMICS
supports TCP/IP and OS/2 Warp *only*. There is no longer any support for shell
accounts - sorry.

Configuration is done using a notebook rather than the command line. If you
have an existing program icon for PMICS, you can now remove all the parameters.
A .CMD file is also no longer needed unless you are using Timeseal.


----------
Known Bugs
----------

*  If you use the configuration notebook, PMICS will trap on exit with a
   SYS3170. This doesn't cause any harm, but can be a bit alarming. This is
   caused by a bug in OpenClass and I'm waiting for IBM to fix it.

*  Some configuration options have no effect yet.

*  The default colours are a bit unusual on 16 and 256 colour systems. I
   develop in 16-bit colour - shoot me!

*  Toolbar bitmaps are awful. Dammit Jim, I'm a programmer, not an artist.

*  Command line doesn't always keep focus.

*  Help menu items don't do anything


----------------
Installing PMICS
----------------

Create a directory on your system and copy the pmicstcp.exe and pmics.hlp files
to it. You can set up a program icon for PMICS in the usual way. Future install
scripts will do this for you.


-------------
Running PMICS
-------------

The first thing you should do is connect to the internet using your normal
method.

The first time you run PMICS, choose Configuration from the File menu and
set up the interface the way you want it. Pay special attention to the settings
for your chess server hosts. PMICS defaults to the Free Internet Chess Server
at ics.onenet.net:5000. If this is your normal host, just enter your handle and
password.

When you are done configuring, click the Login button on the toolbar and
select the server you wish to use. The communication window will show the
progress of the connection.

When you are connected - start playing!


-----------------
Configuring PMICS
-----------------

The configuration notebook has 5 pages; Hosts, On-line, Display, Colours and
Sounds. All changes made to the configuration take effect immediately - even
if you are already connected to a server.

The Hosts page allows you to set up multiple chess servers. For each server
you need a description, TCP/IP address and TCP/IP port number (usually 5000).
You should also enter your registered handle and password to enable automatic
login. If you are not a registered user, leave the password blank.
The 'Map CR to LF' checkbox is normally checked. If the server does not seem
to respond to your commands, try changing this.

The On-line page allows you to set your preferences during a session with a
chess server. They are mostly self-explanatory. Check the 'Autoflag' button to
automatically flag when you are playing a game and time runs out.

The Display page allows you to set up the PMICS display to your preferences.

The Colours page allows you to change the colours used by most of the PMICS
display elements.

The Sounds page allows you to attach sounds to some of the events that can
occur when you are playing chess. If you have MMPM/2 installed and a working
sound card, you can use standard .WAV files as well as beeps. When entering
a sound filename, use a full path i.e. 'D:\MMOS2\SOUNDS\BOING.WAV'.


-------------
Playing chess
-------------

Use the command line to enter commands to the chess server.

When playing a game, select a piece with the left mouse button and release
the button over the target square.  A line will show the move you are about to
make.

Clicking the right mouse button on the board displays a pop-up menu
showing the available options for that square. This includes re-issuing the
previous move, flipping the board display, setting the piece that pawns will
promote to, dropping pieces in bughouse and setting up the board in examine.

PMICS recognizes challenge messages and pops up a dialog informing you
of the match parameters.  This also works when PMICS is minimized.

You can change the font used for the terminal window using the Board
menu.  You can grab the border separating the board and terminal
windows and drag it to resize them.  The main use of this is to
temporarily enlarge the terminal window, e.g. for viewing large chunks
of text or intense chat mode.


----------------
Issuing Commands
----------------

At the bottom of the PMICS window is a command line and a command button. You
can type commands to the server here. The button issues the text on the command
line to the server. You can either click the button with the mouse, or press
the Enter key.

By default, the text on the command line is issued without modification to the
server. However, if you are doing lots of shouting or chatting, you can
automatically prefix the command line text with the appropriate command by
selecting an option from the Command menu.

Remember to reset the command button to command mode before attempting to
issue other server commands. It is quite embarrassing to shout 'quit' or
'finger someone' to the public!


------------------
The PMICS Menu Bar
------------------

File
  New                   Resets the board and clocks to their initial positions.
  Configuration         Displays the configuration notebook.

Command
  Command               Issues the command line as a literal command to the
                        server. F2 is the shortcut.
  Tell                  Issues the text on the command line prefixed with
                        'tell'. The first word on the line should be the name
                        of the user you are communicating with. Also F3.
  Say                   Issues the text on the command line prefixed with
                        'say'. Also F4.
  Shout                 Issues the command prefixed with 'shout'. Also F5.
  Kib                   Issues the command prefixed with 'kib'. Also F6.

Help
  About                 Displays information about PMICS and the authors.


-----------------
The PMICS Toolbar
-----------------

login           Establish a connection to a chess server. If you are already
                connected, you will be asked if you want to drop the current
                connection.
refresh         Press this button if the displayed position or status gets
                messed up.

draw            Issue a draw request when playing.
resign          Resigns the game you are playing.
flag            Issues a flag command manually. Use this when your opponent
                runs out of time.
moves           Displays the list of moves for the current game.

open            Toggles your availablility for games.
who             Lists all users logged in to the current server.
avail           Lists all users available for games on the current server.
games           Lists all the games currently being played on the server. To
                observe a game, type in the command 'obs <game number>' or
                'obs <player name>'.
allobs          Lists all the games which are being observed, and who is
                observing them. Good for following the crowd!

messages        Displays any messages left for you on the server.


-----------
Future work
-----------

*  Fix bugs and implement all config options.
*  Multiple active boards.
*  Proper help files.
*  Better toolbar bitmaps.
*  What do *you* want to see?

Beta 3 should be available in late May 1996.


--------------
Update history
--------------
96/04/14   2.00    (beta2)
                   Paul Mitchell is now the code maintainer. All bug reports
                   and enhancement requests to him.

94/12/12   1.00    (beta)
94/11/22   1.00    (alpha)


----------------------
Contacting the Authors
----------------------

Paul Mitchell (aka MysticUK) can be reached as paulm@secondnature.co.uk. If
you don't get a response within a couple of days, try 73064.761@compuserve.com

Kevin Nomura (aka woof) can be reached as chow@netcom.com


----------------
Acknowledgements
----------------

From Paul Mitchell:
Many thanks to Kevin Nomura for the first version. Fond regards to Figbert and
MrsFigbert for initial testing, comments and encouragement. Check out the OS/2
version of Timeseal by Figbert. Respect to IBM, TeamOS/2 and all OS/2 users.

From Kevin Nomura:
PMICS was inspired by the excellent DOS interface, GIICS, written by
Tony Acero.  The bitmaps for the pieces are taken from the GNU program xboard.
Serial port IOCTL magic was adapted from the PD comm program comtalk.
