0

Make command line option docs more complete

Mainly, the genPOI options were finally documented.
This commit is contained in:
Nicolas F
2016-06-30 09:07:13 +02:00
parent 4287fc5f0b
commit 917e38fd53
2 changed files with 24 additions and 6 deletions

View File

@@ -110,10 +110,10 @@ The first render can take a while, depending on the size of your world.
Options
-------
The following three options change the way The Overviewer determines which tiles
to update, and are intended to be things you only have to use in special
situations. You should not normally have to specify these options; the default
is typically correct.
The following options change the way The Overviewer generates or updates the
map, and are intended to be things you only have to use in special situations.
You should not normally have to specify these options; the default is
typically correct.
.. cmdoption:: --no-tile-checks

View File

@@ -238,9 +238,27 @@ outputdir.
Options
-------
genPOI.py has a single option :option:`--config`. You should use the same configfile as
used for your normal renders.
genPOI comes with a few options of its own.
.. cmdoption:: -c <file>, --config=<file>
The config file to use for the genPOI operation. This must be the same
config file that you use for your normal rendering runs.
.. cmdoption:: -q, --quiet
Outputs less information onto the terminal while running.
.. cmdoption:: --skip-scan
Skip scanning the world for entities and tile entities. Useful if you only
want to generate markers for players or through manual POIs, as you can
speed up the genPOI operation considerably.
.. cmdoption:: --skip-players
Skip reading and retrieving player data during genPOI runs. This is useful
if you don't plan on generating markers for the player locations.
.. _predefined_filter_functions: