.. _guide:

Command Line Interface
======================

.. toctree::
   :maxdepth: 1
   :hidden:

    Generating submission scripts <gen_job>
    Plotting absorption spectra <plot_abs>

The ``orto`` command line interface (CLI) contains different subprograms that can be listed using the terminal command

.. code-block:: bash

    orto -h

``orto`` contains four groups of programs:

- ``gen`` - Generation of data, files, or jobs.
- ``plot`` - Plotting of data.
- ``extract`` - Extraction of data from ORCA output files, followed by saving to file.
- ``print`` - Extraction of data from ORCA output files, followed by printing to terminal.

Within each of these groups, further subprograms are available.

More information can be found on each of these groups by typing their name followed by ``-h`` into a terminal, e.g.

.. code-block:: bash

    orto gen -h

Further explanations of the functionality included in the command line interface are given within these pages.