CommandLineOptions.wiki
changeset 733 5e67a58c1361
parent 587 8105e95297e3
child 734 63cad3d4a62b
equal deleted inserted replaced
732:4a40a2b9ec52 733:5e67a58c1361
    79 
    79 
    80 ----
    80 ----
    81 
    81 
    82 = Frontend =
    82 = Frontend =
    83 
    83 
    84 There are two options that enable to load the data directory and the configuration directory in non standard locations.
    84 Symtax: `hedgewars [OPTION …] [CONNECTSTRING]`
    85 
    85 
    86   * {{{--data-dir=[path containing 'hedgewars/Data']}}}
    86 All command-line arguments are optional. When invoked without any command-line arguments, Hedgewars will start normally with standard directory locations.
    87   * {{{--config-dir=[path containing 'Demos' 'Saves' etc.]}}}
       
    88 
    87 
    89 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.
    88 `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:
    90 
    89 
    91 _Example_ 
    90   * {{{--data-dir=[path containing 'hedgewars/Data']}}}: Data directory
       
    91   * {{{--config-dir=[path containing 'Demos' 'Saves' etc.]}}}: Configuration directory
       
    92   * {{{--help:}}}: Display help about command-line arguments
       
    93 
       
    94 The program exits if either one of the folders is not correct; quotes are optional, but needed if your path contains spaces.
       
    95 
       
    96 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).
       
    97 
       
    98 == Examples ==
       
    99 This is an example on GNU/Linux on a shell (the dollar sign is not part of the input):
       
   100 
    92 {{{
   101 {{{
    93 $ /usr/bin/hedgewars --data-dir="/opt/local/share/" --config-dir=".hedgewars/tesing config/"
   102 $ /usr/bin/hedgewars --data-dir="/opt/local/share/" --config-dir=".hedgewars/tesing config/"
    94 }}}
   103 }}}
    95 
   104 
       
   105 This starts Hedgewars with the data directory `/opt/local/share/` and the configuration directory `.hedgewars/testing config/` (relative to the current working directory).
       
   106 
       
   107 Another example:
       
   108 {{{
       
   109 $ /usr/bin/hedgewars hwplay://example.org
       
   110 }}}
       
   111 
       
   112 Makes Hedgewars join an alternative server `example.org` on start.
    96 
   113 
    97 ----
   114 ----
    98 
   115 
    99 = Server =
   116 = Server =
   100 
   117