
.. _pkatyper_help:
.. include:: ../substitutions
.. include:: ../../apps-substitutions

.. program:: pkatyper 

======================
Command Line Help
======================

A description of the commandline interface can be obtained by executing **pkatyper**
with the `--help` option.

.. code-block:: bash
   
   prompt> pkatyper --help

will generate the following output:

::

   Help functions:
     pkatyper --help simple      : Get a list of simple parameters (as seen above)
     pkatyper --help all         : Get a complete list of parameters
     pkatyper --help defaults    : List the defaults for all parameters
     pkatyper --help <parameter> : Get detailed help on a parameter
     pkatyper --help html        : Create an html help file for this program
     pkatyper --help versions    : List the toolkits and versions used in the application