.. _popy_doc:

popy_doc
########

For convenient access to |popy|'s documentation, :ref:`open_a_popy_command_prompt` and type:-

.. code-block:: console

    $ popy_doc 
 
This opens the :ref:`main_index` |html| documentation page.

Examples
---------

You can access the online documentation as follows (default is locally installed .html files):-

.. code-block:: console

    $ popy_doc -o

Alternatively you can open documentation for a specific tool (e.g., :ref:`popy_run`) with the **-t** or **--tool** option:-

.. code-block:: console

    $ popy_doc --tool run
 
You can also open documentation for specific :ref:`script_formats` (e.g., a :ref:`fit_script`) with the **-s** or **--script** option:-

.. code-block:: console

    $ popy_doc --script fit
 

Command line options
--------------------
    
.. literalinclude:: /_autogen/tool_help/popy_doc_help.inc
    :language: console 

