Command Line Options: Difference between revisions

Latest revision as of 00:48, 15 April 2016

Command line options are useful for controlling the behaviour of the simulator without having to use the program's GUI. An example of such options is the following:

"C:\Program Files\Signalsoft\Zentralstellwerk Köln Hbf\Zentralstellwerk Köln Hbf.exe" -x -l

The command line switches -x and -l enable Developer Mode, and Logging Mode, respectively. To use these options, you may:

use the options.txt option
start the program directly from the command line
modify the desktop shortcut's "target" property
write a batch file (*.bat)

No Trains

-notrains

Start a simulation without any trains. Useful for testing things without having to actually dispatch trains.

Free Speed

-simspeed

Allows unrestricted simulation speed. Undefined behaviour may occur in simulations simulated at speeds larger than 4X.

Developer Mode

-x

Enables Developer Mode. Allows access to "Dev" menu item which has useful scenario and timetable editing options. In Developer mode, more dialog boxes may appear.

Log Mode

-l

Writes to the program log located in the C:\Documents and Settings\User\My Documents\Signalsoft\APPNAME\logs\ folder. Developer Mode must be active for logging to work.

Presimulation Speed

-psim:N

N is an integer between 1 and 64, inclusive. Defines the simulation speed during presimulation.

Presimulation Logging

-psm

Developer mode (-x) must also be active. Adds additional presimulation traffic information to the program log.

Presimulation Diagnostics

-ps

Shows presimulation activity.

Timetable Logging

-tlog

Write timetable stop data to a log file. Log file will appear at the end of the simulation. Useful for checking if scheduled stops are accurate.

Portal Logging

-plog

Write detailed portal/line operations data to a log file. This log file is accessible via Help > View Line Operations Log.

Disallow Coworker Sounds

-nocoworkers

Prevents coworker sounds from playing.

Disallow Startup Music

-nomusic

Prevents music from playing on start up, if it is defined for the simulation.

Web-based Traffic Display

When enabled, the simulation acts like a web server and outputs traffic information to a web browser.

To enable, start with sim with the following command-line option:

-http

By default, the port on which the server listens for incoming requests is port 80. If you wish to specify a different port (for example, you already run a web server on your computer using port 80) then you can supply your own port number:

-http:8080

@@ Line 1: / Line 1: @@
-Command line options are useful for controlling the behaviour of the simulator in a low-level way. An example of such an option is the following:
+{{DeveloperNav}}
-<pre style="color:blue;font-size:14px">
-C:\Program Files\Signalsoft\Zentralstellwerk Köln Hbf\Zentralstellwerk Köln Hbf.exe -x -l
+Command line options are useful for controlling the behaviour of the simulator without having to use the program's [http://en.wikipedia.org/wiki/Graphical_user_interface GUI]. An example of such options is the following:
+<pre style="color:blue;font-size:16px">
+"C:\Program Files\Signalsoft\Zentralstellwerk Köln Hbf\Zentralstellwerk Köln Hbf.exe" -x -l
 </pre>
 The command line switches '''-x''' and '''-l''' enable Developer Mode, and Logging Mode, respectively. To use these options, you may:
+* use the [[Command Line Options File|options.txt]] option
 * start the program directly from the command line
 * modify the desktop shortcut's "target" property
 * write a [http://en.wikipedia.org/wiki/Batch_file batch file (*.bat)]
 ===No Trains===
-<pre style="color:blue;font-size:14px">
+<pre style="color:blue;font-size:16px">
 -notrains
 </pre>
@@ Line 24: / Line 27: @@
 ===Free Speed===
-<pre style="color:blue;font-size:14px">
+<pre style="color:blue;font-size:16px">
 -simspeed
 </pre>
@@ Line 33: / Line 36: @@
 ===Developer Mode===
-<pre style="color:blue;font-size:14px">
+<pre style="color:blue;font-size:16px">
 -x
 </pre>
@@ Line 42: / Line 45: @@
 ===Log Mode===
-<pre style="color:blue;font-size:14px">
+<pre style="color:blue;font-size:16px">
 -l
 </pre>
 Writes to the program log located in the ''C:\Documents and Settings\User\My Documents\Signalsoft\APPNAME\logs\'' folder. '''Developer Mode must be active for logging to work.'''
+===Presimulation Speed===
+<pre style="color:blue;font-size:16px">
+-psim:N
+</pre>
+N is an integer between 1 and 64, inclusive. Defines the simulation speed during presimulation.
+===Presimulation Logging===
+<pre style="color:blue;font-size:16px">
+-psm
+</pre>
+Developer mode (-x) must also be active. Adds additional presimulation traffic information to the program log.
+===Presimulation Diagnostics===
+<pre style="color:blue;font-size:16px">
+-ps
+</pre>
+Shows presimulation activity.
+===Timetable Logging===
+<pre style="color:blue;font-size:16px">
+-tlog
+</pre>
+Write timetable stop data to a log file. Log file will appear at the end of the simulation. Useful for checking if scheduled stops are accurate.
+===Portal Logging===
+<pre style="color:blue;font-size:16px">
+-plog
+</pre>
+Write detailed portal/line operations data to a log file. This log file is accessible via Help > View Line Operations Log.
+===Disallow Coworker Sounds===
+<pre style="color:blue;font-size:16px">
+-nocoworkers
+</pre>
+Prevents coworker sounds from playing.
+===Disallow Startup Music===
+<pre style="color:blue;font-size:16px">
+-nomusic
+</pre>
+Prevents music from playing on start up, if it is defined for the simulation.
+===Web-based Traffic Display===
+When enabled, the simulation acts like a web server and outputs traffic information to a web browser.
+To enable, start with sim with the following command-line option:
+<pre style="color:blue;font-size:16px">
+-http
+</pre>
+By default, the port on which the server listens for incoming requests is port 80. If you wish to specify a different port (for example, you already run a web server on your computer using port 80) then you can supply your own port number:
+<pre style="color:blue;font-size:16px">
+-http:8080
+</pre>
+{{DeveloperNavBottom}}