Difference between revisions of "Special switches"

From TTWiki
Jump to navigationJump to search
 
(Fix manual patches link)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
  +
{{Manual/Usage}}
 
In addition to all the [[Manual#Patches|patch switches]], the following switches control the operation of TTDPatch itself:
   
  +
{| class="wikitable"
'''''Special switches'''''
 
  +
|-
 
!Command line!!Configuration file!!Meaning
  +
|-
 
| -a || all on || Turn on all patch switches, except those marked as "off by default".
  +
|-
 
| -h || --- || Show a brief help summarizing all available options. Run "<tt>ttdpatch -h <nowiki>|</nowiki> more</tt>" if it scrolls by too fast.
  +
|-
 
| -v || verbose on/off || Before running TTD, display a brief summary of what switches are active
  +
|-
 
| -y || alwaysyes on/off || Do not wait for a keypress before starting TTDPatch if the TTD version is not recognized
  +
|-
 
| -C &lt;file&gt; || include &lt;file&gt; || Read a different [[ConfigurationFile|configuration file]].
  +
|-
 
| -W &lt;file&gt; || writecfg &lt;file&gt; || Write current configuration to this file. '''Note:''' Do not write to the file that contains this directive (i.e. in ttdpatch.cfg, do not put "writecfg ttdpatch.cfg"), because it will overwrite the file and discard all settings after the writecfg directive.
  +
|-
 
| -Xn &lt;file&gt; || newgrfcfg &lt;file&gt; || Read the given file as new graphics configuration file, instead of <tt>newgrf(w).cfg</tt>.
  +
|}
   
 
If the -C option is given, the specified configuration file will be read instead of the default <tt>ttdpatch.cfg</tt>. (This does not apply to the "include &lt;file&gt;" option, obviously.) You can use several configuration files by having multiple -C switches, they will be read in the order you supply them.
=Special switches=
 
   
 
And finally, after you have set all your switches the way you like them, you can tell TTDPatch to write them to your own configuration file (or <tt>ttdpatch.cfg</tt> for that matter) by using the -W switch or writecfg config file directive. With this, TTDPatch will create a commented file that has all the switches set as they are when the -W is encountered on the command line.
In addition to all the [[ManualThePatches|patch switches]], the following switches control the operation of TTDPatch itself:
 
 
||Command line|Configuration file|Meaning
 
 
-a|all on|Turn on all patch switches, except those marked as &quot;off by default&quot;.
 
 
-h|---|Show a brief help summarizing all available options. &nbsp;Run &nbsp;&quot;ttdpatch -h <nowiki><nowiki>|</nowiki></nowiki> more&quot; if it scrolls by too fast.
 
 
-v|verbose on/off|Before running TTD, display a brief summary of what switches are active
 
 
-y|alwaysyes on/off|Do not wait for a keypress before starting TTDPatch if the TTD version is not recognized
 
 
-C &lt;file&gt;|include &lt;file&gt;|Read a different [[ConfigurationFile|configuration file]].
 
 
-W &lt;file&gt;|writecfg &lt;file&gt;|Write current configuration to this file. '''Note:''' Do not write to the file that contains this directive (i.e. in ttdpatch.cfg, do not put &quot;writecfg ttdpatch.cfg&quot;), because it will overwrite the file and discard all settings after the writecfg directive.
 
 
-Xn &lt;file&gt;|newgrfcfg &lt;file&gt;|Read the given file as new graphics configuration file, instead of -+newgrf(w).cfg+-.||
 
 
If the -C option is given, the specified configuration file will be read instead of the default -+ttdpatch.cfg+-. &nbsp;(This does not apply to the &quot;include &lt;file&gt;&quot; option, obviously.) &nbsp;You can use several configuration files by having multiple -C switches, they will be read in the order you supply them.
 
 
And finally, after you have set all your switches the way you like them, you can tell TTDPatch to write them to your own configuration file (or -+ttdpatch.cfg+- for that matter) by using the -W switch or writecfg config file directive. &nbsp;With this, TTDPatch will create a commented file that has all the switches set as they are when the -W is encountered on the command line.
 
   
 
Just for completeness, there are also a number of [[DebugSwitches|debug switches]], but they are not meant to be useful for most people.
 
Just for completeness, there are also a number of [[DebugSwitches|debug switches]], but they are not meant to be useful for most people.

Latest revision as of 13:54, 31 July 2011

In addition to all the patch switches, the following switches control the operation of TTDPatch itself:

Command line Configuration file Meaning
-a all on Turn on all patch switches, except those marked as "off by default".
-h --- Show a brief help summarizing all available options. Run "ttdpatch -h | more" if it scrolls by too fast.
-v verbose on/off Before running TTD, display a brief summary of what switches are active
-y alwaysyes on/off Do not wait for a keypress before starting TTDPatch if the TTD version is not recognized
-C <file> include <file> Read a different configuration file.
-W <file> writecfg <file> Write current configuration to this file. Note: Do not write to the file that contains this directive (i.e. in ttdpatch.cfg, do not put "writecfg ttdpatch.cfg"), because it will overwrite the file and discard all settings after the writecfg directive.
-Xn <file> newgrfcfg <file> Read the given file as new graphics configuration file, instead of newgrf(w).cfg.

If the -C option is given, the specified configuration file will be read instead of the default ttdpatch.cfg. (This does not apply to the "include <file>" option, obviously.) You can use several configuration files by having multiple -C switches, they will be read in the order you supply them.

And finally, after you have set all your switches the way you like them, you can tell TTDPatch to write them to your own configuration file (or ttdpatch.cfg for that matter) by using the -W switch or writecfg config file directive. With this, TTDPatch will create a commented file that has all the switches set as they are when the -W is encountered on the command line.

Just for completeness, there are also a number of debug switches, but they are not meant to be useful for most people.