Innovative Model Railroad Control System

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Rocrail: Befehlszeilen-Optionen ======
[[:german#rocrail|{{  :server.png}}]][[:german|{{  :rocrail-logo-35.png}}]]
[[german | Inhalt]] -> [[german#rocrail|Rocrail Server]] -> **[[rocrail-cmdln-de|Befehlszeilen-Optionen]]**\\

// \\ // \\ 

Rocrail kann von der Befehlszeile gestartet werden, z.B. um es auf einem Server laufen zu lassen, während Rocview-Clients, die auf anderen Rechnern im Heim-Netzwerk laufen, sich damit verbinden. Siehe auch Abschnitt [[#beispiele|Beispiele]] am Ende dieser Seite.\\ 

 \\
==== Aufrufen der Hilfe ====
Wenn Rocrail von der Befehlszeile mit der Option <code>--help</code> gestartet wird, werden alle zur Verfügung stehenden Optionen angezeigt:\\
<code>
Rocrail commandline options:
-------------------------+--------------------------------------------
--help or -?             | Displays this help and quit.
-version                 | Displays version info and quit.
-doc                     | Writes documentation in Rocrail.html.
-------------------------+--------------------------------------------
-debug                   | Switch on debug tracelevel.
-byte                    | Switch on byte tracelevel.
-parse                   | Switch on xml parse tracelevel.
-monitor                 | Switch on controller monitor tracelevel.
-info                    | Switch on info tracelevel.
-------------------------+--------------------------------------------
-console                 | Read console input.
-nocom                   | Switch off communication.
-pwr                     | Power on.
-auto                    | Power and auto mode on.
-run                     | Start all locos.
-resume                  | Start prev. locos.
-w [workdir]             | Change the programs working directory.
-l [libdir]              | Library directory.
-img [imgdir]            | Images directory.
-p [portnr]              | Service port for clients. [8051]
-i [inifile]             | Ini file. [rocrail.ini].
-t [tracefile]           | Trace file. [rocrail].
-x [planfile]            | Plan file. [plan.xml].
-f                       | Init field.
-sod                     | Start Of Day: Query sensors.
-stress                  | Enable the stress runner for testing communication.
-virtual                 | Use for all defined digints the virtual CS.
-lic                     | SupportKey path and filename.
-------------------------+--------------------------------------------
</code>

\\
Optionen der Befehlszeile überschreiben in der ''rocrail.ini'' gefundene entsprechende Optionen.\\ 
  * Nicht für alle Befehlszeile-Optionen gibt es entsprechende Optionen in der ''rocrail.ini''.

 \\

==== Version ====
Mit dieser Option die Version des Servers überprüfen, um sicher zu sein, dass die richtige verwendet wird:\\
<code>
 Rocrail 14415 [7de033fd0c355b405c5b4438abc2129b5860ee7a][LOCAL]
 Build: Oct  1 2018 08:06:37
 librocs 2.0-0 build Sep 30 2018 16:39:48
 processid = 70520
       mac = 00005CF938A62F88
      guid = 00005CF938A620181001081017060000
</code>

 \\
==== Dokumentation ====
Die Option ''-doc'' gibt die gleiche Dokumentation aus, die auch online zur Verfügung steht:\\
http://www.rocrail.net/doc/rocrail-wrappers/wrapper-en.html\\
Dies kann recht nützlich sein, wenn man die Dokumentation gerade braucht und keine Verbindung zum Internet hat ...\\

 \\
==== Debug-Level ====
=== debug ===
Diese Option sollte mit Bedacht verwendet werden und dient Entwicklern zum Finden von Fehlern (hohe Beanspruchung der CPU!)\\
=== byte ===
Nützliche Option, wenn es Kommunikationsprobleme mit der Zentrale gibt.\\
=== parse ===
Diese Option sollte mit Bedacht verwendet werden und dient Entwicklern zum Finden von Fehlern (hohe Beanspruchung der CPU!)\\
=== monitor ===
Mit dieser Option werden Informationen, die von der Zentrale kommen, dargestellt.\\
=== info ===
Dieser Level ist normalerweise aktiviert, aber es macht unter Umständen Sinn, ihn über die rocrail.ini auszuschalten (auf false setzen)\\

 \\

==== console ====
Dieser Modus akzeptiert nur Befehle auf der Console.\\
Rocview wird bei einer Verbindung über diesen Modus informiert und deaktiviert den Menüeintrag "Rocrail und Rocview beenden".\\

 \\
==== nocom ====
Die Option ''-nocom'' kann zu einem 'Trockenlauf' von Rocrail eingesetzt werden, es findet dann keine Kommunikation zwischen Rocrail und der angeschlossenen Zentrale statt.\\

 \\
==== auto / run / resume ====
Der Server muss mit Option ''-auto'' gestartet werden, damit die Optionen ''-run'' u. ''-resume'' aktiv werden.\\
==== run ====
Alle Loks werden gestartet.\\
==== resume ====
Alle in der vorherigen Sitzung fahrenden Loks werden gestartet.\\

 \\
==== Arbeitsverzeichnis ====
Um ein anderes Arbeitsverzeichnis zu verwenden, als das, aus dem Rocrail aktuell startet, muss Rocrail mit der Option  ''-w [Pfad]'' gestartet werden.\\
Hierbei muss sichergestellt sein, dass Rocrail die benötigten Bibliotheken findet. Es kann also evtl. notwendig sein, zusätzlich das gewünschte Bibliotheksverzeichnis mit der Option ''-l [Pfad]'' mitzuteilen.\\

 \\
==== Bibliotheksverzeichnis ====
Standardmäßig sucht Rocrail im aktuellen Arbeitsverzeichnis nach den erforderlichen Bibliotheken. Wenn sie sich in einem anderen Verzeichnis befinden, dann kann man dies Rocrail mit der Option ''-l [Pfad]'' mitteilen. \\

 \\
==== Bildverzeichnis ====
Wenn sich zu verwendende Bild-Dateien in einem anderen Verzeichnis befinden, dann kann man dies Rocrail mit der Option ''-img [Pfad]'' mitteilen. \\

 \\
==== port ====
Wenn der standardmäßig verwendete Port **8051** schon durch eine andere Anwendung belegt ist, dann kann er mit der Option ''-p [portnr]'' geändert werden.\\

 \\

==== spez. Dateien ====
Wenn für Plan-Datei, Ini-Datei und Trace-Dateien alternative Namen verwendet werden sollen, können sie mit den Optionen ''-i [ini-Datei]'', ''-t [trace-Datei]'' ''-x [plan-Datei]'' eingestellt werden. \\
  
 \\
==== Anlage initialisieren ====
Diese Option ''-f'' hat den gleichen Effekt, wie die Option in Rocview: Alle Weichen werden einmal durchgeschaltet, um eine Synchronisation zwischen Rocrail und der Anlage zu gewährleisten.\\
Alle definierten Signale erhalten einen Befehl entsprechend des letzten bekannten Status oder 'ROT', wenn kein Status verfügbar ist.\\

 \\
==== Rückmelder abfragen ====
Diese Option ''-sod'' (Start of Day = Betriebsbeginn) fragt den Status aller Rückmelder ab.\\

 \\


====Stress====
Einige Bibliotheken unterstützen Kommunikations-Stress-Tests:
  * Loconet
  * BiDiB
  * CBUS
  * Virtual
  * Dinamo

Die Option ''-stress'' aktiviert die Stress-Tests. 

 \\

===== Beispiele=====
Der exakte komplette Befehl ist nicht nur vom Betriebssystem  (Windows, Linux, Mac, ...) abhängig, sondern auch von der Version und manchmal von der Sprache.

In den Beispielen
  * "My_Name" muss durch den Benutzer-Namen ersetzt werden. 
  * Der [[#arbeitsverzeichnis|-w Befehl]] spezifiziert das Arbeitsverzeichnis, dass die Plan- und die ".ini"-Dateien enthält
  * Im [[#console|-console Modus]] kann der Server nicht versehentlich von einem Client geschlossen werden.


Ein gültiger Start-Befehl kann so aussehen:

=== Windows 7 ===
Gilt für alle Sprachen.

Starten der Rocrail.exe in einem Befehlszeilen-Fenster (unabhängig vom aktuellen Verzeichnis):
<code>c:\"program files (x86)"\rocrail\rocrail.exe -w c:\users\My_Name\documents\rocrail -console</code>

  
Als eine Batch-Datei:
<code>cd c:\"program files (x86)"\rocrail
rocrail.exe -w c:\users\My_Name\documents\rocrail -console</code>

=== Windows XP ===
Deutsche Sprach-Version:

<code>c:\Programme\Rocrail\rocrail.exe -w "c:\Dokumente und Einstellungen\My_Name\Eigene Dateien\Rocrail" -console </code>

\\