added server options and table of contents
authorvittorio.giovara@gmail.com
Tue, 29 Jan 2013 23:25:43 +0000
changeset 293 2dc603c7d7e6
parent 292 27c4a3aec2a0
child 294 54ad5ec9bfae
added server options and table of contents
CommandLineOptions.wiki
--- a/CommandLineOptions.wiki	Tue Jan 29 23:15:57 2013 +0000
+++ b/CommandLineOptions.wiki	Tue Jan 29 23:25:43 2013 +0000
@@ -1,21 +1,10 @@
-#summary Full list of command line switches for hedgewars and hwengine
+#summary Full list of command line switches for hedgewars, hwengine and server
 #labels Documentation,Engine,Frontend
 
-The basic parameters to pass to the Hedgewars frontend and engine control the location of the game data, configuration files and saves.
-
-= Frontend =
-
-There are two options that enable to load the data directory and the configuration directory in non standard locations.
+*Table of Contents*
+<wiki:toc max_depth="2" />
 
-  * {{{--data-dir=[path containing 'hedgewars/Data']}}}
-  * {{{--config-dir=[path containing 'Demos' 'Saves' etc.]}}}
-
-You can set up both on the command line. The program exits if either of the folders is not correct; quotes are optional, but needed if your path contains spaces
-
-_Example_ 
-{{{
-$ /usr/bin/hedgewars --data-dir="/opt/local/share/" --config-dir=".hedgewars/tesing config/"
-}}}
+----
 
 = Engine =
 
@@ -81,9 +70,35 @@
   * {{{rqTooltipsOff  = 1024}}}
   * {{{rqDesyncVBlank = 2048}}}
 
-Ex: to have blurry land and simple rope, you would use the number 10 (2+8)
+Eg: to have blurry land and simple rope, you would use the number 10 (2+8)
 
 There are some internal commands, such as --internal, --port [int], that are not meant for command line usage.
 
 If you want to get your hands dirty and see how the engine interprets commands, you can check out the source code.
-[http://code.google.com/p/hedgewars/source/browse/hedgewars/ArgParsers.inc ArgParsers.inc]
\ No newline at end of file
+[http://code.google.com/p/hedgewars/source/browse/hedgewars/ArgParsers.inc ArgParsers.inc]
+
+----
+
+= Frontend =
+
+There are two options that enable to load the data directory and the configuration directory in non standard locations.
+
+  * {{{--data-dir=[path containing 'hedgewars/Data']}}}
+  * {{{--config-dir=[path containing 'Demos' 'Saves' etc.]}}}
+
+You can set up both on the command line. The program exits if either one of the folders is not correct; quotes are optional, but needed if your path contains spaces.
+
+_Example_ 
+{{{
+$ /usr/bin/hedgewars --data-dir="/opt/local/share/" --config-dir=".hedgewars/tesing config/"
+}}}
+
+
+----
+
+= Server =
+
+Server can be configured to run on non standard port or to run as separate process.
+
+  * {{{--port=PORT}}} - Server listens on PORT (-p)
+  * {{{--dedicated=BOOL}}} - Spawn a separate process (-d)
\ No newline at end of file