iccicci/ccc

.. _cli:

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

**CCC** *cli* is simply a *shell interface* to the :ref:`node-module`. Please refer to
:ref:`compilation` to understand how the process works.

Usage
=====

.. code:: bash

    ccc [options] file

Options
=======

For more details about about options please refere to :ref:`compileoptions`.

-A --assembly
-------------

Includes the generated **assembly** in the output; assumes *input format* is in **CCC**.

-a --assemble
-------------

Assemble; assumes *input format* is in **assembly**.

-D<macro>[=<value>]
-------------------

Defines ``<macro>`` eventually with its ``<value>``. Can be used multiple times to define more
*macros*.

-h --help
---------

Prints a quick reference help screen and exits.

-O --opcode
-----------

Includes the generated **opcode** in the output.

-o <filename>
-------------

The output ``<filename>``. If omitted defaults *stdout*.

-p --preprocess
---------------

Includes the **preprocessor** result in the output; assumes *input format* is in **CCC**.

-v --version
------------

Prints **ccc** version and exits.