Invoking Kynema-UGF - Command-line options
------------------------------------------

Kynema-UGF's runtime behavior can be controlled by using several command line input
options during invocation. Users can invoke ``-h`` to determine the
various options available.

.. program:: kynema-ugf

.. option:: -h, --help

   Print the help message describing all Kynema-UGF options and exit

.. option:: -i, --input-deck

   Use the filename provided as the input file. If this option is not provided,
   :program:`kynema-ugf` will attempt to load a file called :file:`kynema-ugf.i` in the
   current working directory as the input file.

.. option:: -o, --log-file

   The log file where the output generated by Kynema-UGF is directed to. If no file is
   provided, then :program:`kynema-ugf` will use the base name of the Kynema-UGF input file
   with the extension ``.log`` as the output file. For example, if
   :program:`kynema-ugf` was invoked as ``kynema-ugf -i ABL.neutral.i`` then the output
   will be redirected to a file named :file:`ABL.neutral.log`. Note that the
   file is overwritten if it already exists.

.. option:: -v, --version

   Print the Kynema-UGF version string.

.. option:: -p, --pprint

   Enable parallel printing from all MPI ranks.

.. option:: -D, --debug

   Enable verbose debug printing to log file.