.. _popy_format:

popy_format
#############

Occasionally, we make changes to the :ref:`script_formats` that render old script files defunct. So that you do not need to rewrite all of your old script files, we provide a tool called :command:`popy_format` that reads in the old-style script file and outputs it with the new format.

Do this by opening a :ref:`open_a_popy_command_prompt` and typing:-

.. code-block:: console

    $ popy_format my_script.pyml
 
which will output a new version of **my_script.pyml** called:-

.. code-block:: console

    my_script_formatted.pyml
 
The output of :command:`popy_format` may need to be manually edited to obtain desired results (|eg| to change from the default value for newly added options).

As usual, a log file will be created to document the formatting process.

 
Command line options
--------------------

.. literalinclude:: /_autogen/tool_help/popy_format_help.inc
    :language: console 