From c287247b86cde270c8b6976cac9a530ab2b527d6 Mon Sep 17 00:00:00 2001 From: Sean Kilgore Date: Mon, 26 Mar 2012 13:41:16 -0700 Subject: [PATCH] Updated sign docs, including --genpoi usage --- docs/running.rst | 9 +++++++++ docs/signs.rst | 25 ++++++++++++++++++------- 2 files changed, 27 insertions(+), 7 deletions(-) diff --git a/docs/running.rst b/docs/running.rst index 7b9d26b..4d5fc42 100644 --- a/docs/running.rst +++ b/docs/running.rst @@ -184,6 +184,15 @@ is typically correct. This option is automatically activated for first-time renders. This option conflicts with :option:`--check-tiles` and :option:`--no-tile-checks` +.. cmdoption:: --genpoi + + .. note:: + Don't use this flag without first reading :ref:`signsmarkers`! + + Generates the POI markers for your map. This option does not do any tile/map + generation, and ONLY generates markers. See :ref:`signsmarkers` on how to + configure POI options. + .. cmdoption:: -p , --processes diff --git a/docs/signs.rst b/docs/signs.rst index 62bc42e..d10e755 100644 --- a/docs/signs.rst +++ b/docs/signs.rst @@ -70,17 +70,28 @@ rendered map. For example:: Generating the POI Markers ========================== +.. note:: + Markers will not be updated or added during a regular overviewer.py map render! + You must use one of the following options to generate your markers. + +The --genpoi option +------------------- +Running overviewer.py with the :option:`--genpoi` option flag will generate your +POI markers. For example:: + + /path/to/overviewer.py --config /path/to/your/config/file.conf --genpoi + +.. note:: + A --genpoi run will NOT generate a map render, it will only generate markers. + genPOI.py --------- -In order to actually generate the markers and add them to your map, the script -genPOI.py must be run. For example:: +The genPOI.py script is also provided, and can be used directly. For example:: + + /path/to/overviewer/genpoi.py --config=/path/to/your/config.file - genpoi.py --config=/path/to/your/config.file -.. note:: - Markers will not be updated or added during a regular overviewer.py - map render! This will generate the necessary JavaScript files needed in your config file's outputdir. @@ -88,7 +99,7 @@ outputdir. Options ------- -genPOI.py has a single option:: --config. You should use the same configfile as +genPOI.py has a single option :option:`--config`. You should use the same configfile as used for your normal renders.