
.. _sitehopper_build_opt_params:
.. include:: ../../apps-substitutions

.. program:: sitehopper_build

=======================
Optional Parameters
=======================

Input/output
============

.. option:: -prefix <prefix>

   Prefix used to name output files. [Default=sitehopper_build]


Database options
================

.. option:: -overwrite

   Option to overwrite existing database (if exists). [Default=false]

.. option:: -append

   Option to append to an existing database. [Default=false]

.. option:: -ncpu

   Number of CPUs to use when building the database.
   0 implies use all available CPUs on the local machine. [Default=0]


Logging
=======

.. option:: -log <logfile>

   The argument for this flag specifies the name of
   the log file. This overrides any specified prefix.
   The default will be determined by -prefix if no log file is specified.


.. option:: -param <param_file>

   The argument for this flag specifies the name of
   the a param file. All command line parameters will
   be written to this file. Passing an existing file
   will cause **sitehopper_build** to use parameters
   read from the file.

   [Default=sitehopper_build_settings.param]

   [Aliases=**-settings**]

.. option:: -progress

   Show progress while building. [Default=true]


.. option:: -verbose

   Triggers copious logging output. [Default=false]

