From 917e38fd53ddec4aa9911c4625e52125a82decaa Mon Sep 17 00:00:00 2001 From: Nicolas F Date: Thu, 30 Jun 2016 09:07:13 +0200 Subject: [PATCH] Make command line option docs more complete Mainly, the genPOI options were finally documented. --- docs/running.rst | 8 ++++---- docs/signs.rst | 22 ++++++++++++++++++++-- 2 files changed, 24 insertions(+), 6 deletions(-) diff --git a/docs/running.rst b/docs/running.rst index 56d7752..ff20ba9 100644 --- a/docs/running.rst +++ b/docs/running.rst @@ -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 diff --git a/docs/signs.rst b/docs/signs.rst index 512cf2d..1c433da 100644 --- a/docs/signs.rst +++ b/docs/signs.rst @@ -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 , --config= + + 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: