Examples
========

Help
----
The **--help** flag will output a help message with all of the available options:

.. code-block:: bash

   archmap --help


Basic use
---------
By default, running **archmap** will output three files to /tmp, **archmap_users.txt**, **archmap.geojson** and **archmap.kml**,
this can be overridden by either using the config file or by the following command line switches.

Using the **--verbose** flag will print information on what the script is doing:

.. code-block:: bash

   archmap --verbose

You can specify the output location for the GeoJSON, KML and CSV:

.. code-block:: bash

   archmap --geojson /tmp/archmap.geojson --kml /tmp/archmap.kml --csv /tmp/archmap.csv


geojson.io
----------
http://geojson.io is a website that allows you to visualise GeoJSON on an OpenStreetMap map,
it also has options for converting the GeoJSON to a range of other formats.

Using the **--geojsonio** flag will send the GeoJSON to the site via a GitHub gist.

.. code-block:: bash

   archmap --geojsonio


Logging
-------
If the script is run on a system that uses systemd, it will log to it using the syslog identifier - "archmap".

You can review all logs generated by **archmap** by using:

.. code-block:: bash

   journalctl SYSLOG_IDENTIFIER=archmap

Examples
========

All of these example assume you have installed **archmap** via pacman or pip,
if you would like to use the script directly, just use ``./archmap.py``.


Help
----
The **--help** flag will output a help message with all of the available options:

.. code-block:: bash

   archmap --help


Basic use
---------
By default, running **archmap** will output three files to /tmp, **archmap_users.txt**, **archmap.geojson** and **archmap.kml**,
this can be overridden by either using the config file or by the following command line switches.

Using the **--verbose** flag will print information on what the script is doing:

.. code-block:: bash

   archmap --verbose

You can specify the output location for the GeoJSON, KML and CSV:

.. code-block:: bash

   archmap --geojson /tmp/archmap.geojson --kml /tmp/archmap.kml --csv /tmp/archmap.csv


geojson.io
----------
http://geojson.io is a website that allows you to visualise GeoJSON on an OpenStreetMap map,
it also has options for converting the GeoJSON to a range of other formats.

Using the **--geojsonio** flag will send the GeoJSON to the site via a GitHub gist.

.. code-block:: bash

   archmap --geojsonio


Logging
-------
If the script is run on a system that uses systemd, it will log to it using the syslog identifier - "archmap".

You can review all logs generated by **archmap** by using:

.. code-block:: bash

   journalctl SYSLOG_IDENTIFIER=archmap

Add docs info about how to use the script locally
Add docs info about how to use the script locally
