	     RAILSIM short documentation
	     ===========================
	(JB Software Saxony railway simulation)

       Last changes:      15th September 1994

       Current version:   3.20   9/1994

-----------------------------------------------------------------------------
 Contents:
 ~~~~~~~~~
 0  Prefaces
 1  Introduction: What could RAILSIM to be used for?
(2  Technical requirements       see README.TXT)
(3  Installation                 just there)
 4  Let's start now...
 5  Standard mode / editor
 6  Dialogboxes
 7  Menus
 8  Hot-keys
 9  Graphic symbols
10  Error messages
11  Usage (registration) conditions

-----------------------------------------------------------------------------

0 Prefaces
~~~~~~~~~~

-If you have any older version of RAILSIM (there does not exist any English
 version before 3.20, but some German versions), then pay attention to the
 file README.TXT what includes update hints and a list of news.

-This is a short documentation what does not lay claim to be complete. You
 can get more information by the online help system when running the program.
 By pressing the >F1< key you can activate the online help at almost all
 positions of the program. There does not exist a longer documentation today.

-Please refer to the usage conditions in section 11 of this file!

-MS-DOS is a registered trademark of Microsoft corporation.

-----------------------------------------------------------------------------

1 Introduction
~~~~~~~~~~~~~~

RAILSIM is a program for simulation of railway networks (especially tramway
and light railways). The program tries to be an English version of the German
simulation program BAHN (last version 3.20 4/1994).

If you are an enthusiastic model railway fan but just don't have to use any
model railway then RAILSIM can help you. By this program there fit into the
PC over 100 kilometres of railway track and over 100 trains at the same time,
even into a laptop!
If you constantly have been vexed about the timetable of your tramway route
then you can have a look what would happen if you had to say something.
RAILSIM is also usable as screen saver or shop-window demo program (with some
reservations). So you can mark the position of your store and you can show
how to get there by railway, suburban railway and tramway.

By the program you can construct and operate railway networks of respectable
extent (e.g. tramway of Dresden, Leipzig; railway in Saxony), for what a fleet
of various vehicles is available.

You can choose from more than 400 different train sets of tramway and railway
vehicles. As tramcars there are available all usual TATRA-cars, some cars made
by Waggonbau Gotha and Duewag, the Dresden "Groer Hecht" and others, partly
in various colourings. As railway vehicles there is available a set of various
locomotives and cars of German railways (Deutsche Reichsbahn and Deutsche
Bundesbahn, today DB AG). This set includes many trains from the local train
with steam locomotive until modern InterCityExpress trains, including suburban
railways and freight trains.

Because of the interactive usage it is possible to change and influence the
traffic while running simulation. So you can simulate breakdowns for example.
That is a great advantage in comparison with model railways, because on what
model railway you can let go about 100 trains and build new tracks at one and
the same moment? Of course some attention is to pay during this influences,
otherwise trouble can appear.

For the English version especially:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 The original of RAILSIM has been a German program. That results in some
 properties which may be confusing to you:

 -RAILSIM is made for right-hand traffic. Of course you can construct networks
  using left-hand traffic too, but all special elements like signals and most
  signs always will stand right-handed to the driving direction. Some tramway
  car types are designed for usage in one direction only. These have doors on
  their right side only.
 -There will be used kilometres (km) as linear measure in any case. The speed
  of trains is determined in kilometres per hour (kmph).
 -RAILSIM uses 24-hour-clock. 0:00 or 24:00 means 12:00a.m., and 12:00 means
  12:00p.m.
 -The translation is not professional and is including some bugs by my mind.
  There are some technical terms what could not be found an exact translation
  for. So these terms have been translated verbatim and therefore you should
  use the online help system explaining most technical terms using graphic
  examples. If there exist differences between Britain and American English
  then the American version has been used in most cases.
 -The available set of cars and locomotives in the main consists of German
  models or models used in Germany. However, I think you will find vehicles
  usable for your purposes.
 -The example networks are German networks only because I have not got any
  foreign networks yet. I hope that will change in the future.

-----------------------------------------------------------------------------

2 Technical requirements and
3 Installation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

About these themes informs the README.TXT file.
It is quite sure you installed RAILSIM successfully when reading this text.

-----------------------------------------------------------------------------

4  Let's start now...
~~~~~~~~~~~~~~~~~~~~~

Please take care of standing all RAILSIM.* files in the current directory and
that main memory is not stuffed with large TSR-programs (SideKick, network
drivers, screen saver, VShield, viruses or other).
A start from the Norton Commander can go wrong because of lack of memory.
Calling RAILSIM from MS-Windows (version 3.0 or higher) is possible in the
"Full Screen" mode, Calling from OS/2 2.0 is also possible.

Starting RAILSIM takes place by calling RAILSIM.EXE, usually without any
parameters. By parameters "/?" or "/H" there will be shown the allowed usage
versions.

After starting the program a title screen will appear including e.g. the
version number. If you are not interested in the title screen then start
RAILSIM using the "/Q" switch.

If there are any problems for the program (e.g. not enough memory) it breaks
off printing an error message. A list of possible error messages you will find
in section 10 of this text.
If the communication is impossible between RAILSIM and the mouse driver then
a warning will occur but RAILSIM starts, however. If there would occur
problems using your mouse, then start RAILSIM using the "/M0" switch. In this
case the mouse support will be deactivated.

To get on from the title screen you have to press the enter or return key (in
the following called >ET<) or the left mouse button. After that the title
screen will be cleared and the program will begin to run.

From the beginning on the big screen surface runs a small start example with
one train. In addition you see a big cursor what is green labeled and cannot
be overlooked. If the mouse and mouse driver are working correctly then a
mouse cursor will be visible looking like a white mouse.

If any errors occur then there will be put out an error message standardized
on the upper screen third. After pressing >ET< or >ESC< the program continues.

At nearly all positions you can get a help text about the current action by
pressing the >F1< key. If a yellow button with "Help" inscription is visible
you can click this button by mouse (left button) and you will get help too.
If your hard disk is slow or if you have started RAILSIM from a floppy disk
then you have to wait some seconds when using help.

If you don't know RAILSIM yet then make familiar with the possibilities of the
program by looking at the included network files. For loading a network file
press >F3< and enter the name of the wanted file.

-----------------------------------------------------------------------------

5 The standard mode / editor
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

After successful start RAILSIM will run in the so-called standard mode. That
means you see only a small sector of the available area but you can see all
details in the sector and you can make changes (edit).

In the upper screen section you find some state information and a menu bar.
The usage of the menus will be explained in the section 7 "Menus".


5.1 Editor and keyboard
~~~~~~~~~~~~~~~~~~~~~~~

In the following there will be explained all possible actions you can do using
the keyboard, and after that there will be mentioned the differences when
using the mouse. Of course you can use both at the same time and that is
useful and comfortable in most cases.


5.1.1 Cursor movement
~~~~~~~~~~~~~~~~~~~~~

The current position of the cursor will be shown at the upper screen sector as
a pair of coordinates. The coordinates (x horizontal, y vertical) move in a
range of 0 to 2047. The position (0,0) is the upper left corner.
All area available for the network doesn't fit into the screen, therefore
always only a sector will be shown. This sector is positioned so that the
cursor always will be visible.

Using the cursor keys (arrows) you can move the cursor by one position in the
arrow's direction.

Soon you will see that the moving by one position is often too slow and
longwinded to reach a wide remote position in the network. Because of that you
can move the cursor by an entire page (resp. screen) too. To do that use the
following keys:

   US keyboard          German keyboard         function
 
     >DEL<                >ENTF<    		1 page left
 >CTRL+LEFT ARROW<     >STRG+Linkspfeil<	the same
     >END<                >ENDE<		1 page right
 >CTRL+RIGHT ARROW<    >STRG+Rechtspfeil<	the same
   >Page UP<            >Bild nach oben<   	1 page up
   >Page DOWN<          >Bild nach unten<	1 page down

Using these keys you can soon get lost. In this case you can set the cursor
into the center of the network by the >HOME< key. At this position the cursor
is to be found when the program has been started.


5.1.2 Constructing, making changes and deleting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

By pressing one of the numeral keys >0< to >9< a graphic symbol will be
written to the cursor position and the cursor will move by one position into a
direction dependent on the graphic symbol. If the cursor cannot be moved then
the symbol will be written nevertheless, but you cannot see it because it will
be covered by the cursor. Then you have to move the cursor in a suitable
direction yourself.
In the upper screen sector you will see in a symbol bar, what symbol belongs
to what key (from 0 to 9). There you can see the numbers and below them the
respective graphic symbol. Other graphic symbols you can get by pressing >F7<,
>F8< or >F9<. The arrangement of graphic symbols in the blocks of ten may
appear some mysterious. Some symbols multiple exist, and arranged one after
the other mostly doesn't match anything. If you turn on >NUM LOCK< and use the
numerical keys on the right side of keyboard (the so-called "Numpad"), then
the graphic symbols mostly are arranged so that a circle results. The circle
should be seen anticlockwise (used in right-handed traffic).

In some cases it is difficult to identify some graphic symbols (some switches
and crossings are very similar). Because of that the fundamental function will
be shown as text below the symbols. Instead of this text you can look at the
exact track geometry of track symbols by pressing >F10<. So you can prevent
confusions.

Writing of graphic symbols sometimes doesn't work. For example you cannot
overwrite trains (That would be nonsense, too).

A special function doesn't exist for deleting. Instead of that you simply
build the space symbol (area in background color, default is green) to the
adequate position.


5.1.3 Additional functions
~~~~~~~~~~~~~~~~~~~~~~~~~~

- >F1< :  Help

By pressing >F1< the help system will be activated and you get information
about using the help system and about some other topics.

- >F7/F8/F9/SHIFT+F9/F10< :
  >B,C,I,N,R,S,T,W<:     select graphic symbols / look at their function

By using these keys you can change the assignment of keys >0< to >9< to the
graphic symbols and by that reach other graphic symbols. The symbols are
combined in blocks of ten. Between the blocks you can switch by >F7< in one
direction and by >F8< into the other. The ten symbols of a block mostly belong
together, some symbols you will find in several blocks. The function of the
various symbols will be explained in section 9 "Graphic symbols".

If you can see any track constructions as active symbols, then you can change
by >F9< between the design on the road (for tramway lines or grade crossings)
and the design on rail-owned permanent way (not on road). By >F10< you can
change if you want to be shown the basic function as text or instead of that
the exact track geometry.

For constructing lines on road in 45 angle you need both adequate tracks and
road edges. Between both you can switch by >SHIFT+F9<.

By using some letter keys you can switch directly to certain symbol blocks.
These are the following keys:

     C   (Car) roads             I    Industrial objects
     B    Bridges/tunnels        N    Nature symbols
     R    Rails 90              S    Signals
     T    sTops/stations         W    sWitches

If a symbol block is selected for what such a letter key has been defined,
then the letter will be shown above left beside to "F8".

5.1.4 User action
~~~~~~~~~~~~~~~~~

When pressing the >ET< key then various reactions are possible by the program.
That depends on what graphic symbol is at the cursor position.

In case of trains, stops, switches, signalling systems and similar objects you
can change certain parameters or you will be informed about its properties.
In case of graphic symbols without a special function there doesn't take place
anything.

If you want to reach a symbol covered by a train then use >CTRL+ET<.


5.2 Editor and mouse
~~~~~~~~~~~~~~~~~~~~

If you use RAILSIM without a mouse you don't need to read the following
section.

After starting the program you will see a white mouse as standard mouse
cursor. If you click to a position in the graphic window by the left mouse
button, then the cursor will be set to this position and proceeded so as you
had pressed >ET<, possibly an user action will be carried out.
At the right upper section of the screen you see some arrows and hatched areas
on yellow background. If you click these then the cursor will move into the
arrow's direction respectively it will be turned over the leaves for 1 page
into the direction of arrow nearest to the clicked hatched area.

By clicking of "F7", "F8", "F9" or "F10" the same action will be carried out
like when pressing the corresponding keys, but in addition the mouse cursor
transforms into a construction machine looking like a power shovel or crane.
If clicking one of the symbols in the symbol bar right above the mouse cursor
also will transform and the clicked symbol gets a white border. This white
bordered graphic symbol will be called the active graphic symbol. If you click
into the graphics window by the crane cursor, then the cursor will be set to
the mouse position, the active graphic symbol will be constructed there and
the cursor will move forward. So you can edit the network by mouse too. Doing
so you have to pay attention to the same like when pressing keys >0< to >9<.
If you want to transform back the mouse cursor into the standard mouse cursor,
e.g. to prevent any unintentional constructing, then simply press the right
mouse button. When clicking a menu the standard mouse cursor will be restored
too.

The point for clicking (so-called "hot-spot") is to find at the gnaw tooths
of the white mouse (these are visible only using a microscope) respectively
at the crane hook of the construction machine cursor.

-----------------------------------------------------------------------------

6 Dialogboxes
~~~~~~~~~~~~~

The communication between you and RAILSIM uses dialogboxes in general. These
are gray windows of various extent whose meaning or function is shown in a
title line (white on green). In such boxes you can find various elements.
Between these elements you can switch by >TAB< or >SHIFT+TAB< keys or by
clicking using the left mouse button. The at the moment active part of a
dialog box can be identified by its white border.
There are small windows where you can enter or edit text. These will be named
"editboxes" in the following.
Also there are windows in what you can read text only. These are called
"listboxes".
In the same way "buttons" are existing what you can activate by >ET< key or
by mouse. These buttons include a text on yellow background explaining their
function.
In addition there are "radiobuttons". These are small vertically arranged
buttons of what only one can be selected at the same time. The selected button
lights red and can be switched by arrow keys up resp. down.

All dialogboxes can be escaped by >ESC< key or right mouse button, also when
you already have entered some data. Using that you simply can recover input
mistakes.

Pressing >ET< in a dialogbox you have to distinguish between 4 cases:

 1  A button causing the end of dialogbox is active
    (e.g. "OK", "Cancel", "Yes", "No" ).
    Then the dialogbox will be closed and the program will proceed suitable to
    the button. The "Cancel" button always effects like the >ESC< key.
    Usually you will leave a dialogbox by "OK", because then the action will
    be carried out what the dialogbox has been made for.

 2  A button is active what causes an action belonging to the dialogbox
    (e.g. "Show next train").
    Then this action will be carried out but the dialogbox will still be open
    and the button will still be active.

 3  The "Help" button is active.
    In this case the help system starts. After leaving the help system the
    dialogbox will appear again.

 4  No button is active (but e.g. an editbox).
    Then the dialogbox will be closed and proceeded in the same way like when
    clicking "OK". Therefore the action will be carried out what the dialogbox
    is made for.

Buttons also can be activated by pressing >ALT< and the underlined letter.
In dialogboxes only including buttons (like menus), the letter without >ALT<
is sufficient too.

-----------------------------------------------------------------------------

7 Menus
~~~~~~~
7.1 Usage of menus
~~~~~~~~~~~~~~~~~~

The most functions will be activated by menus. The names of these menus are
shown in the upper screen section and each name includes an underlined letter.
By pressing the >ALT< key and the respective letter the corresponding menu
will be activated. You can do that also by the mouse when you set the mouse
cursor on a menu name and click it by left mouse button.
Menus work like dialogboxes but include buttons only. In contrast with the
most dialogboxes you can switch between these buttons by the cursor keys
>arrow up< and >arrow down< too.
Some functions also can be called by so-called "hot-keys", these are special
function keys. What functions and keys are concerned is named when explaining
the functions. Moreover the hot-keys will be shown in the menu buttons. The
hot-keys are usable only from the main program, not when a menu is activated.
There are the following menus what will be explained closer in the following
sections:

  "File"           File functions (Save, Load and other)
  "Edit"           Editor functions
  "Trains"         Create, Edit, Delete and other functions for trains
  "Mode"	   Change of program modes (map and fullscreen modes)
  "Options"	   Adjustment of parameters
  "Help"           Help system, various information


7.2 File menu "File"
~~~~~~~~~~~~~~~~~~~~

This menu offers functions for working with network files. The default file
extension is ".NT3", this extension doesn't need to be typed.
The functions in detail:

  * "New":  Delete all data in memory and start a new network

     By this command you delete all current available data so that you can
     construct an absolutely new network.
     After "New" the filename will be set to "NONAME.NT3".

  * "Open":  Open a file and load it
     (hot-key >F3<)

     By this function a file will be loaded. In an editbox you can enter the
     filename. In the listbox at the left side there will be shown the files
     and directories what can be selected.
     If any error occurs during loading, then a corresponding error message
     will appear and a "New" will be carried out. That means you cannot load a
     damaged files fragmently.
     Before loading of files created by older program versions you have to
     convert these by CONVNT3.EXE.

  * "Save":  Save file
     (hot-key >F2<)

     The current data will be saved without any queries and so an older
     version will be overwritten on the floppy or hard disk. If you want to
     change the filename then use "Save As". If the current name is "NONAME"
     then "Save As" will carried out implicitly.

  * "Save As":  Save file using a new name (or changing the path)

     A dialogbox will appear looking like the dialogbox of "Open". You can
     enter the new name and path and have a look at the existing filenames.

  * "Exit":  Exit the program
     (hot-key >ALT+X<)

     By this menu item you can leave RAILSIM.


7.3 Edit menu "Edit"
~~~~~~~~~~~~~~~~~~~~

This menu offers functions for editing several data and constructing longer
lines.

  * "Routes":  Submenu for route management

     Here you get to the submenu "Routes menu" (see 7.3.1).

  * "Depots":  Submenu for depot management

     Here you get to the submenu "Depots menu" (see 7.3.2).

  * "Edit info":  Edit information texts

     There belong a headline, an author info and an information text of 4000
     characters length to each network file. Into these texts you can write
     any explanations. These information will be set to "no information
     available" resp. "unknown" by the "New" function.
     The headline will be shown above the map when running in map modes, when
     showing the state information it will appear too.
     These texts you can edit by the menu item "Edit info".

  * "Edit text":  Enter or edit text
     (hot-key >SPACE BAR<)

     Here you can enter a text of up to 40 characters what will be entered
     into the network at the cursor position if there are space symbols at
     this position.

  * "Search text":  Search for text
     (hot-key for repeating >CTRL+L<)

     Here you can search for text in the network.

  * "Set cursor pos.":  Set cursor position

     Here you can set the cursor to any position inside the network.
     The stored cursor position (see next paragraph) will be suggested to you
     but you can choose any other.

  * "Store position":  Store cursor position
     (hot-key >F5<)

     Here you can store the current cursor position. That makes it possible to
     go back there later (using "Set cursor pos.") or to construct a line
     from another position to the stored position. There can be stored only
     one position.

  * "Build connection":  Construct or delete a long line ore area
			 as track, road or river

     This feature has been made for fast constructing wide extended networks.
     Using it you can create a connection from the cursor position to another
     position as road, river, track on road or track not on road. As well you
     can delete such a line.

  * "Move network":  Move entire network

     By this operation the whole network can be moved in determined ranges.
     The moving needs a lot of time of course.


7.3.1 Submenu "Routes menu"
~~~~~~~~~~~~~~~~~~~~~~~~~~~

This menu offers functions for managing routes.
To each train a route is assigned, several trains can drive over the same
route. The route will be used for decisions at switches and terminals and
for the functions of the train menu.
Names of up to 6 characters length are allowed as names for routes. For these
you can use the letters 'A' to 'Z' (no special characters), numerals 0 to 9
and the characters '-','/' and '.'. Some examples for route names:

     1  12  407  E7  12E  A  U5  S75  6/9  500G  2-7

The functions in detail:

  * "New Route":

     By this menu item you can register a new route. That is needed before
     using the route for trains, switches or terminals.

  * "Delete route":

     Here you can delete a route. That means that this route no longer will be
     registered and all references to it will be removed at switches and
     terminals.

  * "Rename route":  Change route name and/or sort in it to a new position

     Here you can give a new name to a registered route and you can change the
     position of the route in the list of routes.
     All information related to the route will be changed automatically. That
     refers both to switches and terminals and trains which will be sorted new
     if required.

  * "Show routes":  Show all routes

     Here you can see all known routes including their name and the numbers
     of the route's trains and of the route's trains on the way.


7.3.2 Submenu "Depot menu"
~~~~~~~~~~~~~~~~~~~~~~~~~~

This menu offers functions for managing depots.
A depot is a place where you can create and put in new trains and where you
can park these.
A depot is shown by a gateway from what a track comes out down, and by a roof
what can be of any length up. Names of up to 4 characters length are allowed
as names for depots. For these you can use letters 'A' to 'Z' (without special
characters) and the numerals 0 to 9.
The functions in detail:

  * "New depot":   Create a new depot

     By this menu item you can register a new depot. Before doing so you have
     to construct its exit gateway and set the cursor to its position.

  * "Delete depot":  Delete a depot

     Here you can delete a depot. That means that it no longer will be
     registered and it can not be related to any train. Moreover all
     references to the depot will be deleted at switches.

  * "Rename depot":  Rename a depot

     Here you can give another name to an existing depot. All references to
     the depot will be changed automatically. That refers to both switches and
     the train's home depots.

  * "Show depots":  Show all depots

     Here all registered depots will be listed including their name,
     coordinates and numbers of trains domiciled and resident there.


7.4 Mode menu "Mode"
~~~~~~~~~~~~~~~~~~~~

This menu serves to change the program's mode.
In addition to standard mode there are the full screen mode and several map
modes too.


7.4.1 Full screen mode
~~~~~~~~~~~~~~~~~~~~~~

Running in this mode all information above the visible network sector on the
screen is invisible. The entire screen will be used for showing the network.
All functions of the standard mode described in section 5 (menus, hot-keys and
other) are still working in the full screen mode, although the menu bar is
invisible.


7.4.2 Screen saver
~~~~~~~~~~~~~~~~~~

In this mode RAILSIM works as a simple screen saver. There will be changed to
the full screen mode and a train will be followed automatically. If you choose
a suitable train (see online help) then the screen permanently will change and
it can not burn into the picture tube. The cursor and mouse cursor will be
turned off.


7.4.3 Map modes
~~~~~~~~~~~~~~~

These modes give you the possibility to get an overview over the whole network
or at least over a large area by showing the area on a reduced scale.
Above the map the network's headline appears.
Because of strong reduction the network will be shown without many details.
All tracks inclusive of depots appear in red color and all trains as white
pixels or snakes according to their length. Roads without tracks are shown in
gray color, large waters in blue, trees in green, buildings in orange and
industry buildings in dark gray.
When the map has been built up what can take some time, then a white rectangle
cursor will appear. The cursor is at the current position of the edit window
and can be moved using cursor keys resp. mouse like the cursor in standard
mode. If the train following is still running then the map cursor will be
moved like the watched train and it is not moveable manually to a wider
remote position.
While the map is active you cannot carry out menu or editor functions.
Hot-keys except >+< and >-< for speed control don't work too.
The map can be left by >ESC< or the right mouse button. In that case the
current position of the rectangle cursor will be assumed as new position of
the edit window.
In this way you quickly can reach a certain position in the network without
knowing its coordinates.
The mode menu offers the following map modes:

  * "All":   Map including landscape

     Using this menu item the map described above will be shown.

  * "Tracks and trains":   Map including tracks and trains only

     Here only tracks and trains will be shown on the map. By this restriction
     you get more clarity when looking at tracks in densely built areas.

  * "Development mode":   Incomplete map

     Here certain pixels will be shown only. That is useful for quicker output
     when using a slow computer.


7.5 Train menu "Trains"
~~~~~~~~~~~~~~~~~~~~~~~
7.5.1 Trains
~~~~~~~~~~~~

In RAILSIM all trains can be identified unambiguously by their route (see
7.3.1) and train number.
The train number is a number in range from 1 to 99 and it is needed for
distinction of the trains of the same route. The train numbers don't need to
be used in unbroken linear order, you can let gaps too.

In addition there are related to each train a train set (cars and locomotive
if needed), a home depot, maximum speed, minimum and maximum waiting periods,
mostly one or two times for leaving and going into a depot and a train type.
Most of these data are correctable after creating the train.

The train set consists of the cars and therefore it defines train's nature and
length. Not all train sets are available at any time but you have to install
the needed train sets by the corresponding function of the train menu.
RAILSIM program treats all trains in the same way. That means you can let go a
tramway by 350 kmph speed, use steam locomotives on tramway lines and other
nonsense as you like.

The home depot is important when creating and parking the train. It can be
changed if the train has been directed to another than its home depot by
corresponding tracks and switches (by mistake or intentionally). If a train
never should go to a depot (on the way around the clock), the home depot can
be deleted after leaving it for the first time.

Each train has a current state consisting of part states what will be
determined and changed by the program. Some state changes you can force by
the functions of the train menu. The following part states exist:

 -"on the way" ('O'): The train goes corresponding to its route and uses stops
		      and terminals corresponding their departure times if it
		      is required by the train's type.

 -"halted at stop" ('H'): The train stops at a stop or station and waits a
			  certain period. After that it will get the state
			  "on the way" again.

 -"terminal" ('T'): The train stops at a terminal or tact station and waits
		    until the terminal's next departure time. If the clock
		    reaches a moment to go into depot for the train before,
		    then it leaves the terminal at this moment.

 -"going to depot" ('R'): At branchings the trains looks for its home depot
			  and goes corresponding to its route only if not
			  found a reference to the home depot. At terminals
			  it will stop only like at stops, no departure time
			  will be waited for.

 -"at depot" ('D'): The train is in a depot (not necessarily in its home
		    depot). It is invisible for you in this state.

 -"STOP" ('S'): The train stops until the STOP-state will be cancelled by the
		user. It doesn't need CPU time and ignores the automatic
		leaving and going into depots.

Maximum speed (Vmax) is the speed used by train when it really moves.
Acceleration and braking are not supported especially. Therefore you better
should choose an average speed as Vmax or set the waiting periods longer a bit
or use speed limited tracks. Valid speed values are 10 to 400 kilometres per
hour (kmph).

The "Out-depot-time" (leaving time) determines at what moment the train
automatically will get the "on the way"-state and will leave the depot it is
in. If the train is not in a depot at this moment then it doesn't change its
state. That applies to "going into depot" state too, meaning a train going to
its home depot doesn't change its meaning on the way.

The "Into-depot-time" determines at what moment the train will get the "into
depot" state automatically. If and when the train really will reach its home
depot is depending on the line to be covered to the depot. If the train is
stopping at a terminal station then it will leave the terminal immediatly.

Both "into" and "leave" times are not needed to be entered. In that case
RAILSIM doesn't use default values but there is no automatic state changing
like that.
Especially in tramway networks there are trains going as relief trains only
during rush hours. Therefore you can enter two times in each case. So the
train can be parked in a depot during the day and it can leave the depot once
more in the afternoon.

The stop waiting period is defined as interval from StopMin to StopMax.
RAILSIM by random chooses a value inside this interval and so the train waits
another period at each stop. If you want to determine an exact period then
enter the same value as StopMin and StopMax. Values can be choosen from a
range of 1 to 960 seconds. Stop waiting period is not needed by train types
'G' and 'S' and will always be set to (1..1) by RAILSIM in this case.

The train type determines which actions train will carry out at stops/stations
and terminals.
The following types (including recommended usage) are supported:

    'L'  Local train, suburban train, metropolitan railway, subway, tram
    'G'  Goods train/freight train
    'E'  Semi-fast train, high quality semi-fast train (RSB)
    'F'  Fast train, InterRegio (IR)
    'X'  Express train, IC/EC, City express, InterCityExpress (ICE)
    'S'  Special train

Local trains stop at all stops and terminals. Semi-fast, fast and express
trains stop at certain stations only but at all terminals too. Freight trains
stop at terminals only, special trains don't stop neither at stops nor at
terminals.


7.5.2 Train functions
~~~~~~~~~~~~~~~~~~~~~

The following train functions are available:

  * "New train":  Create a new train

     A dialogbox appears where you have to enter the train's parameters.
     The train set is to be selected from the installed train set groups. More
     groups you can load using the "Install train group" button. By the button
     "Leave immediatly" you let start the train immediatly, by "OK" the train
     will remain in its home depot in "at depot" state.

  * "Leave depot":  Leave a depot

     Here you can let one or more trains leave a depot if these are there. The
     trains get the "on the way"-state and in any case these will leave the
     depot in down direction, but only if there exist tracks conforming with
     and if these tracks are free.

  * "Into depot":  Let go to a depot

     By this function you can let one or all trains of one route go into their
     home depots.
     The trains defined by you will change their state in "going to depot" and
     therefore their behaviour will change. These trains with priority will
     orientate by references to their home depot when driving over branchings,
     and only then by their route when there doesn't exist any reference to
     the home depot. When they arrive at a depot then they will get "at depot"
     state. That means they disappear from the screen but are still existent.
     The function "Go into depot" is useful only when there exist tracks what
     make it possible for the trains to find their home depot. It is quite not
     simple always to keep this consistence demand in difficult and widely
     branched networks.

  * "Delete train":  Delete trains

     Using that you can delete trains. That means their route and train number
     and the memory used by the trains will be free for new trains.
     Deleting of trains what are on the way is impossible using this function.

  * "Edit train":  Change data of trains

     Here you can change most parameters of trains. If you enter a 0 as train
     number then the dialogbox "Edit train" will appear one after the other
     for all trains of the entered route. In this case you can cancel the
     input as usually by >ESC< key, but the dialogboxes for the following
     trains will appear, however.

  * "Follow":  Follow and watch a train

     By this function you can follow a train. That means it is always visible
     on the screen and the visible network sector will always be set so that
     the train is in it. The train's control can take place manually or
     automatically. "Manually" means you can decide in what direction the
     train should go when passing certain switches.
     During following you can still use all program functions but it is not
     useful to construct something because at any time the screen can be
     changed to another page and so you cannot complete your work.

  * "Table":  List trains in a table

     By this function you can get an overview over all trains or over trains
     of certain routes or depots.

  * "Load train group":  Install of a train set group

     Here you can install a group of train sets. Only after doing so you can
     use the train sets included in the group for new trains.

  * "Delete train group":  Deinstall of a train set group

     Using that you can delete a train set group, but only if there doesn't
     exist any train using a train set from this group.


7.6 Option menu "Options"
~~~~~~~~~~~~~~~~~~~~~~~~~

This menu offers functions for setting various parameters:

  * "STOP"/"CONTINUE":

     By this menu item the simulation can be stopped or continued. If the
     simulation is running then the menu item is named "STOP", else instead of
     that "CONTINUE" appears. If the simulation has been stopped you can carry
     out all actions, however.

  * "Speed":  Change simulation speed
     (hot-keys >+< and >-< for increase/decrease speed)

     Here you can change the program's speed. That means the time expires
     slower or faster but the speed of trains (time per line length) doesn't
     change.
     Valid values are 1 (very slow) to 20 (less slow).

  * "Set time":

     Here you can change the simulation time. All values from 0:00 to 24:00
     are possible (0:00 means 12:00a.m., 12:00 means 12:00 p.m.).
     Trains waiting at terminals correct their departure times corresponding
     to the new entered time. The leaving and going to depots will not be
     influenced. If you set the time from 5:31 for 6:45 and a train should
     leave a depot at 5:45, then the train still remains in the depot until
     the clock will show 5:45 for the next time.

  * "Scale":

     Here you can enter the scale of your network. The scale is a conversion
     factor used by RAILSIM for time and speed control. Scale is to be entered
     in elements per kilometre, values from 2 to 90 el.pkm are allowed.
     Changing the scale in an existing file can create aggravating results for
     the traffic because trains need another period for the same line.
     It is useful to determine the scale immediatly after creating a new
     network file and not to change it furthermore.

     Scale depends on the extents of the area you want to represent. You have
     to choose the scale so that the represented area fits into the fixed area
     of 2048x2048 elements. If you later change the scale then only the time
     behaviour will change, the lines would not be stretched or stossed.
     The scale will be shown in the "State info" dialogbox of help menu too.
     But there in addition the network extent appears in kilometres calculated
     from scale and network extent in elements. These values may be
     interesting for your orientation.

     The following case will be regulated by RAILSIM automatically: Imagine
     you have constructed two lines arranged right-angled and now construct a
     short-cut so that a triangle results. Because of a train moves vertically
     and horizontally by 1 position when driving over only 1 track symbol in
     45 angle you can recount that the short-cut has the same number of
     elements like the longer of the two straight-on lines. In the right-
     angled triangle the theorem of Pythagoras is not correct because of the
     short-cut has too little elements.
     RAILSIM solves the problem so that each train driving on 45 angle
     symbols will be slower by 1.4 (nearly square root of 2). So the bad
     effect will be compensated nearly completely.

     Cars and buildings will be shown by RAILSIM always in the same size and
     therefore they are not true to scale in most cases. If you use a scale
     of 2 elements per km then you can create trains of more than 1 km length
     without problems. If you are interested in a simulation as exact as
     possible, then choose trains as short as possible.

  * "Background color":

     Here you can set another background color instead of the default green
     background. In dependance on background color there will be shown texts
     and possibly the cursor in black or white color.

  * "Old cursor"/"Rectangle cursor"

     By this function you can change the cursor type.


7.7 Help menu "Help"
~~~~~~~~~~~~~~~~~~~~

This menu includes the following functions what show several information about
the program and about the current network:

  * "About this program":  General information

     Here you get information about your program version. In addition you can
     get a list of addresses where you can get from the current program
     version in each case.

  * "State info":  Several parameters, memory allocation

     There will be shown information about the current network file and
     especially about the memory situation.

  * "About help":  Help on help system

     Here a help text will be shown about usage of the help system.

  * "Help index":  List of all help topics

     From the appearing list you can choose a topic and you can get the
     available information of the topic.

  * "List of depots":  Show all depots

     That's the same function like in the "Depots" submenu.

  * "List of routes":  Show all routes

     That's the same function like in the "Routes" submenu.

  * "Inactive signalling system":  Show the inactive signalling system

     At most one signalling system can be inactive at a moment. The function
     "Inactive signalling system" has been created because it is not simple
     to get an overview over the system's components in some cases. The
     elements (signals and OFF-contacts) will be listed unsorted by reporting
     their coordinates.

  * "Clipboard":  Clipboard's state

     You will see if there are any data inside the clipboard. If there are
     any data you can delete these.

-----------------------------------------------------------------------------

8 Hot-keys
~~~~~~~~~~

Some of the functions combined in the menus you can start directly from the
standard or full screen mode without using menus too. These are marked in the
menus by showing a key or key combination (the so called hot-key) behind the
name in the menu item. The direct call takes place by pressing the hot-key.
In the following these functions are listed:

      >ALT+X<  : Leave RAILSIM and exit to DOS
      >F1<     : Help
      >F2<     : Save network without query question and without changing name
      >F3<     : Load a network file
      >F5<     : Store cursor position
      >  <     : Enter/edit text
      >+</>-<  : Increase/decrease simulation speed
      >CTRL+L< : Repeat last text search from the current cursor position

-----------------------------------------------------------------------------

9 Graphic symbols
~~~~~~~~~~~~~~~~~
9.1 General remarks
~~~~~~~~~~~~~~~~~~~

The RAILSIM program uses an own graphic symbol set permanently enlarging and
improving. You can distinguish between independent graphic symbols and car
symbols.

Independent symbols can be subdivided into track symbols and landscape
symbols.
Landscape symbols can be divided into road symbols (without tracks), industry
symbols, nature elements, old and new buildings. This division is not
determined exactly but that is not needed because landscape symbols have
illustrating character only.
Track symbols include simple tracks, crossings, switches, stops/stations,
terminals/tact points, depot symbols, signalling systems, bridges/tunnels,
speed limited tracks and buffers (track ends).
Nearly all tracks appear in two versions, namely as version on the road and
on rail-owned permanent way, separated from road network.
Car symbols don't appear alone but in connection with a track symbol.


9.2 Simple tracks
~~~~~~~~~~~~~~~~~

These tracks will be passed over conforming with their direction, in case of
curves the direction will be changed. If a track ends anywhere or it is not
connected correctly, then an arriving train will stop as long as you will
continue to construct the line. By the way it is not favourable to let drive
on a line section when it is not complete yet.


9.3 Switches
~~~~~~~~~~~~

RAILSIM supports simple left-handed and right-handed switches in 45 angle and
partly in 90 angle. There are several switch types like counterfacing driven,
spring, alternation and branching switches. These types are declared in detail
by the online help system using graphic examples.


9.4 Stops/stations
~~~~~~~~~~~~~~~~~~

These symbols can be identified by a yellow pole with yellow-green label
standing beside of a straight track. On rail-owned permanent way a version
exists with white rectangle label too, like used from railways or suburban
railways.
An arriving train stops at the stop for a certain period, therefore it will be
delayed. You can determine for each stop what train types should stop there.


9.5 Terminals/tact points
~~~~~~~~~~~~~~~~~~~~~~~~~

These symbols look like stops but in addition they are marked by an 'E'.
At these positions you can enter at what times trains should depart from
here. A train arriving at a terminal will leave the terminal not before the
clock has been reached the next departure time. Using that you can carry out
a largely scheduled traffic. It is possible to restrict the effect for only
trains of certain routes and for these routes to a certain time interval.


9.6 Platforms
~~~~~~~~~~~~~

The platform symbols don't have any function and only have been created for
a better optical design of stations and stops on rail-owned permanent ways.


9.7 Depots
~~~~~~~~~~

A depot consists of an exit gateway from what a track comes out down and by a
roof what can be of any length up (recommended two roof symbols as minimum).
Depots are needed for putting in and parking trains. Their mode of operation
is described by the online help system.


9.8 Signalling systems
~~~~~~~~~~~~~~~~~~~~~~

Signalling systems can be used for protecting all track sections what should
be passed over by only one train at the same time, e.g. single-line tracks,
turning triangles or blocking track sections.
A signalling system consists of home signals and OFF-contacts. There have to
exist one element of each at least.
The signals have effect only in the direction they stand right-handed to the
train. The OFF-contacts are shown by the text "OFF" and conforming arrows,
where the arrows determine the direction of effect. In older network files you
may find contacts including two arrows effecting in both directions.

Mode of operation and construction of signalling systems are explained by the
online help system using graphical examples.

Because there often have been made mistakes when constructing single-lines and
signalling systems from experience, it is useful to check a new built line by
a single test train and to check the correct proceeding on the screen. If a
collision has taken place you can correct the situation only by driving back
or initializing a train.


9.9 Track ends/buffers
~~~~~~~~~~~~~~~~~~~~~~

These will be shown on the road as a straight track what has been put a red
sign into, but on rail-owned permanent way as buffers.
When reaching a track end from the correct direction the train continues its
movement in back direction. That is useful for shuttle traffic by railcars or
double-decker shuttle trains, for turning at terminus stations or at tramway
turning triangles. The track section passed over both directions should be
protected by a signalling system.


9.10 Bridges/tunnels
~~~~~~~~~~~~~~~~~~~~

Tunnels are marked by an entry gateway and an exit gateway what both must be
on a straight line. Inside a tunnel a train is invisible. Bridges are very
short tunnels merely. About exact effects and possible problems you will be
informed by the online help sytem.


9.11 Speed limited lines
~~~~~~~~~~~~~~~~~~~~~~~~

You can define speed limits for several track sections or network parts. At
the beginning of such a section a sign stands shown as an orange triangle. The
end is marked by a white rectangle black bordered. Both signs only effect
right-handed to moving direction.

-----------------------------------------------------------------------------

10 Error messages
~~~~~~~~~~~~~~~~~

The following enumeration includes only the error messages what can occur
when starting the program and what can cause a break down of the program.
Information about error and hint messages occuring during running the program
you will get using the online help system (press the >F1< key or click to the
"Help" button by the left mouse button).
However, when occuring some of the following messages the program start may
be possible, but you have to expect problems during further program running.

  1..12   Out of memory for ...
	  Take care that possibly all DOS working memory is usable for
	  RAILSIM. Remove all unnecessary drivers and TSR-programs. If you
	  use DOS 5.0 or any similar operating system then try to load
	  drivers and OS components into upper memory using LOADHIGH or
	  DOS=HIGH.
	  If you have been started RAILSIM from an additional program (like
	  DOSSHELL or NORTON COMMANDER) then exit from this program and start
	  RAILSIM from the command line.

  21      File not found: RAILSIM.GZG
	  When this file does not exist then you cannot use RAILSIM. Check
	  if the file is in the same directory like RAILSIM.EXE and if this
	  directory is the current working directory. RAILSIM only can be
	  started from the current working directory, not using a path.

  22,23   File incorrect: RAILSIM.GZG
	  This file is either really damaged or it belongs to another version
	  of RAILSIM. Get a correct file (e.g. from a security copy) and copy
	  the file into the directory where RAILSIM.EXE is to be found.

  26..27  like 21..22, but RAILSIM.TBD
	  Proceed analog with the hints about errors 21..22.

  31      Out of memory for ...
	  Proceed analog with the hints about errors 1..12.

  32..34  like 21..23, but RAILSIM.AZG
	  Proceed analog with the hints about errors 21..23.

  35..37  like 21..23, but RAILSIM.EZG
	  Proceed analog with the hints about errors 21..23.

  38      Out of memory for ...
	  Proceed analog with the hints about errors 1..12.

  51      File not found: RAILSIM.EXE
	  RAILSIM can only be started when all RAILSIM.*-files are in the
	  current working directory, not using a path from another directory.

  52,53   File incorrect: RAILSIM.EXE
	  The file has been damaged. If a virus is the cause, then it is still
	  active! Reset your computer and make a virus test using usual anti-
	  virus programs. You should delete the RAILSIM.EXE in any case and
	  substitute it by a correct file (e.g. from a security copy).
	  This message also can occur when RAILSIM.EXE has been packed by a
	  so-called "EXE-packer" program. In this case the file also has been
	  changed but RAILSIM doesn't know the reason.

  56      like 21, but RAILSIM.TXT
	  Proceed analog with the hints about error 21.

  61..63  like 21..23, but RAILSIM.HLP
	  Proceed analog with the hints about errors 21..23.

  66      like 21, but RAILSIM.ZGG
	  Proceed analog with the hints about error 21.

-----------------------------------------------------------------------------

11 Usage (registration) conditions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 The program version had come to your hand does not include any restrictions.
 That means I rely in your fairness using the program. RAILSIM of course only
 can be developed further when the creators don't need to be on the breadline.
 There have been invested a lot of time and work, therefore I please to keep
 the following usage rules:

-RAILSIM can be tested for 14 days. If you find out you can't use the program
 for any purpose in this time, then delete it or give it away. Otherwise you
 will become a user.
-Fair private users please send the registration fee (ec- or non-negotiable
 cheque) to the address mentioned below or transfer it to the bank account
 mentioned in the "About this program" dialogbox. For that you will get
 (if wanted) more network files and the next program version as soon as it
 will be published. If required you can get attested the registration in
 writing, but of course the paying in-slip or remittance order is valid too.

 Registration fees (only valid for the English version):

    for new users:

	       DM 60,-  in general
	       DM 30,-  for purples until 16 years old (with proof)

    for updating to version 3.20:
    (that means you are a registered user of version 3.11 or 3.11a)

	       DM 30,-

-Who means RAILSIM is worth more can pay more of course.
-Who wants to use RAILSIM for any commercial purposes please contact the
 program author.
-To passing on the program to interested users is allowed and welcome, but
 only together with this documentation and without making changes to program
 or documentation.
-There will not be accepted liability for any damages resulting in the usage
 of RAILSIM. RAILSIM is (like usually all large programs) not error free at
 100% of course.
-Hints about errors, criticisms and interesting network files are welcome.


  Bank account:      see help menu,   "About this program"

  ! Important when transfering to the account:
     Your address has to stand in the "Purpose" field of the remittance
     order, because usually this field and the amount will be transmitted by
     the banks only. There are already existing some users who haven't heard
     anything from me because I don't know their address.

  Contact address:   Jan Bochmann
		     Lutherstr. 19
		     D-09126  Chemnitz

  This address is only a kind of "mail box address", therefore longer time
  may be pass away before you get an answer.
