This file is intended as a brief summary of the options that may be used
while in the PythonTk empire interface.

Note: The Tk interface is designed to appear differently depending on which
platform it is currently running on.  I can not anticipate exactly how each
command will function everywhere.  This document expects the user to be
somewhat versed in standard GUI policies of their platform.


The Map Window:
--------------

The map window displays text character representations for each sector that
has been parsed by a dump or map command.  In addition to the standard text
characters, a hexagon will be displayed around land sectors.  These hexagons
will be colored green for owned sectors, red for enemy sectors, and black
for deity sectors.

In addition to the sector representations, land/ship/plane units will be
displayed on the map as well.  A small blue square will be displayed in
sectors that contain ships.  A pink square designates planes.  Brown
represents land units.


Along with providing information on sector designations and unit locations,
there are a number of mouse events that the map window will recognize:

The left mouse button will instruct the censor window to display
information for the sector located under the mouse pointer.

The right mouse button will center the window around the sector underneath
the mouse pointer.  This feature is useful when your country grows to a
size that is comparable to the maximum world coordinates.  By recentering
the display, you can get a better "feel" for sectors that under other
circumstances might be at opposite sides of the map window.  It is also
useful for "scrolling" around the map when the scroll bars are too much of
a hassle.

The middle mouse button (or shift-left button if you only have a 2 button
mouse) is used to select empire coordinates for insertion on the command
line.  Clicking mouse button 2 will insert into the current input buffer
the coordinate for the sector under the mouse.  Alternatively, dragging
mouse button 2 will select a range of sectors.

The graphical map window may also be modified in scale.  The mouse sequence
Control-Left-Button will decrease the size of each sector by 10%.  The
sequence Control-Shift-Left-Button will decrease the size by 50%.
Similarly, Control-Right-Button, and Control-Shift-Right-Button may be used
to increase the size of the sectors.  Control-Middle-Button can be used to
force a redraw of the map.  This is quite time consuming on big maps, but
can "sharpen" the map after zooming.  (It is otherwise not necessary to
force a redraw.)

Additionally, the size of the main graphical map window may be resized by
clicking and dragging the small box located in the lower right corner of
the map window.  (To resize additional map windows obtained by running the
command "Map", use the window manager's resize function.)


Command-line Window:
-------------------

The command line is an integral part of this client.  All keystrokes go
directly to the command line.  The graphical portions of the client are
intended merely as an adjunct (never a replacement) for the standard text
interface.  On platforms that support clipboards (such as the X selection
under XWindows) select, copy, and insert text should work normally.

The command-line functions similarly to other clients - commands get typed
in, and output gets sent back.

As an additional feature of the output window, when the right mouse button
is clicked over a sector description (text of the form "x,y"), the censor
and map windows will highlight the specified sector.


Censor Window:
-------------

The censor window is located in the upper left hand corner of the main
window.  The censor window can be changed to view sectors, ships, land
units, or planes.  In a nutshell, the censor window displays the output
from the dump command in a more digestible form.  (Although admittedly,
it is still pretty ugly at this stage.)

For unit censors, a listbox will be positioned underneath the censor
window.  This may be used to select which units you wish to view.
To alter the sector censor window, you can select a desired sector by
clicking the left mouse button over a sector in the map window.

Some of the censor window entries have special left mouse button bindings
associated with them.  For example, you may set commodity thresholds, or
deliver thresholds by left clicking on their respective boxes.  In general,
if the border around the field value changes when the mouse is moved over
it, then that value can be set.  Most of these bindings are fairly straight
forward - they issue server commands that reset the quantity.  One more
advanced case, however, is the use of the sector commodity quantity field.
When clicking on this field, a server command will be issued that moves
commodities to/from the sector's dist center.

Fields that describe sector locations (by an x,y pair) have an additional
binding.  Pressing the right mouse button over these fields will cause the
map and censor window to select the specified sector.


Other Windows:
-------------

In addition to the main root window, there are other windows that may be
popped up.  Output can be redirected to its own window via the 'wind'
command; there is a login window that pops up when first using the client;
and there is a telegram tool window that my be popped up using the 'wread'
command.  Additional map windows may also be opened via the 'Map' command.

These sub-windows are fairly simple and straight forward.  The client
expects the window-manger to be able to close them.  (There are no 'Quit'
buttons for these sub-windows - just 'delete' them with your window
manager.)


Configuring the Client:
----------------------

There is a standard text file in the distribution called "TkOption".  It
contains a number of Tk configuration commands.  Using this mechanism, it
is possible to alter the client's color and font scheme.  It is possible to
specify personal coloring schemes for all of the windows and objects.
Under some platforms, it may be necessary to adjust the default font
selection.

Please see this file, for examples on how to configure the Tk Widgets.


Leaving the Client:
------------------

To exit the client, close the main client window using the window manager.
