The Model Railway
Software
libRailControl
trainctrl
db/dbplan
railctrl
Commands
Syntax
Cleanup

railctrl

General Usage

The binary of the railctrl program can be found at "/home/railway/bin/railctrl". In order to run railctrl properly, you must be logged in to the console of "gershwin", the work station directly connected to the model railway. The program gets at least one parameter, the name of the file containing the schedules to be executed. This filename may be followed by some of the options listed below.

After successful startup, the prompt "?" for help > is displayed so the user can enter some interactive commands.

Synopsis

railctrl -h

railctrl schedule [-trainrc=trainrcfile] [-cleanup] [-proto[=protofile]] [-errors[=errfile]] [-repeat=number] [-fairness=number] [-short[=KH_ST_10 | =KH_ST_20]] [-khp_limit=number]

Operands

schedule

Name of the file containing travel plans that may also contain train characteristics. If no train characteristics are included, the program searches for "~railway/schedules/ss98/trainrc/trainrc" by default. The different ways for specifying the individual travel plans is described in the Syntax section.

Options

Each of the following options may be abbreviated with its first character.

-h

Print out some information about the railctrl program and a summary of options.
Please note: This option is only recognized if it is the only parameter on the commandline.

-trainrc=trainrcfile

Don't search for default train characteristics file, use trainrcfile instead. The Syntax of these files is presented in the appropriate section along with some examples.

-cleanup

The user is prompted to enter the current positions (and headings) of all trains. All trains will be guided back to their initial lines as defined in the schedule-file.
By this option, a minimal form of recovery after an abnormal program termination is provieded. More information about these feature you'll find here.

-proto[=protofile]

A log file will created. If protofile is omitted, a unique name will be generated.

-errors[=errfile]

All error-messages are redirected to errfile or to stderr, if errfile is omitted.

-repeat=number

Each train repeats its travel plan 3 times. This can be changed to number times. If 0 is given, the plans are repeated until the program is interrupted by the user.

-fairness=number

From the moment on a train has to cross the Kicking Horse Pass in one direction, at most three trains are being sent on the Pass from the other direction. This number may be changed using this option.

-short[=KH_ST_10 | =KH_ST_20]

The program won't stop any train on the given block or on both blocks.

-khp_limit=number

The maximum number of number trains with two consecutive stops at the Kicking Horse Pass Station are allowed to enter there. By default, this number is set to 5, the number of station sidings.
Warning: By chosing a number greater than 5, the program can no longer guarantee to avoid all deadlocks caused by trains entering or leaving the Kicking Horse Pass Station.