dfhack/docs/builtins/script.rst

script
======

.. dfhack-tool::
    :summary: Execute a batch file of DFHack commands.
    :tags: dfhack

It reads a text file and runs each line as a DFHack command as if it had been
typed in by the user -- treating the input like `an init file <init-files>`.

Some other tools, such as `autobutcher` and `workflow`, export their settings as
the commands to create them - which can later be reloaded with ``script``.

Usage
-----

::

    script <filename>

Example
-------

``script startup.txt``
    Executes the commands in ``startup.txt``, which exists in your DF game
    directory.
move builtin docs to individual files 2022-07-18 11:58:35 -06:00			`script`
reformat builtins and properly read tags 2022-07-20 00:01:25 -06:00			`======`
move builtin docs to individual files 2022-07-18 11:58:35 -06:00
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file. 2022-08-09 23:37:24 -06:00			`.. dfhack-tool::`
			`:summary: Execute a batch file of DFHack commands.`
revise tag list and assignments 2022-08-12 00:34:37 -06:00			`:tags: dfhack`
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file. 2022-08-09 23:37:24 -06:00
			`It reads a text file and runs each line as a DFHack command as if it had been`
			typed in by the user -- treating the input like `an init file <init-files>`.
move builtin docs to individual files 2022-07-18 11:58:35 -06:00
			Some other tools, such as `autobutcher` and `workflow`, export their settings as
			the commands to create them - which can later be reloaded with ``script``.

make Usage a proper header 2022-08-17 23:42:02 -06:00			`Usage`
			`-----`

			`::`
move builtin docs to individual files 2022-07-18 11:58:35 -06:00
			`script <filename>`

update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			`Example`
			`-------`
move builtin docs to individual files 2022-07-18 11:58:35 -06:00
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			``script startup.txt``
spacing is important otherwise the usage and examples lists don't put the explanations on the next line 2022-07-18 12:16:05 -06:00			Executes the commands in ``startup.txt``, which exists in your DF game
			`directory.`