# HG changeset patch
# User Wuzzy
# Date 1452977758 0
# Node ID 5e67a58c136198c52f10d104ba41a69de34b1fe1
# Parent  4a40a2b9ec5235a541b2d1332efa108c2653043f
CommandLineOptions: Update command-line arguments of frontend

diff -r 4a40a2b9ec52 -r 5e67a58c1361 CommandLineOptions.wiki
--- a/CommandLineOptions.wiki	Sat Jan 16 20:45:18 2016 +0000
+++ b/CommandLineOptions.wiki	Sat Jan 16 20:55:58 2016 +0000
@@ -81,18 +81,35 @@
 
 = Frontend =
 
-There are two options that enable to load the data directory and the configuration directory in non standard locations.
+Symtax: `hedgewars [OPTION …] [CONNECTSTRING]`
+
+All command-line arguments are optional. When invoked without any command-line arguments, Hedgewars will start normally with standard directory locations.
+
+`OPTION` is a sequence of one or more options (seperated by spaces. There are options that enable to load the data directory and the configuration directory in non-standard locations. The following options are available:
 
-  * {{{--data-dir=[path containing 'hedgewars/Data']}}}
-  * {{{--config-dir=[path containing 'Demos' 'Saves' etc.]}}}
+  * {{{--data-dir=[path containing 'hedgewars/Data']}}}: Data directory
+  * {{{--config-dir=[path containing 'Demos' 'Saves' etc.]}}}: Configuration directory
+  * {{{--help:}}}: Display help about command-line arguments
+
+The program exits if either one of the folders is not correct; quotes are optional, but needed if your path contains spaces.
 
-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.
+Specify `CONNECTSTRING` if you want Hedgewars to join a server and possibly even a room on start. This must be a `hwplay` URL (see [HWPlaySchemeSyntax] to learn more about this).
 
-_Example_ 
+== Examples ==
+This is an example on GNU/Linux on a shell (the dollar sign is not part of the input):
+
 {{{
 $ /usr/bin/hedgewars --data-dir="/opt/local/share/" --config-dir=".hedgewars/tesing config/"
 }}}
 
+This starts Hedgewars with the data directory `/opt/local/share/` and the configuration directory `.hedgewars/testing config/` (relative to the current working directory).
+
+Another example:
+{{{
+$ /usr/bin/hedgewars hwplay://example.org
+}}}
+
+Makes Hedgewars join an alternative server `example.org` on start.
 
 ----