Waarp Analyze's documentation
=============================

:Version: |version|
:Date: |today|

Waarp Analyze is a tool that gathers information about Waarp instances
and about the server it runs on.

It is useful to generate reports about the state of the system when a
transfer is in error, or to verify the global configuration.

Reports are generated in Restructured Text and can be converted to any
format supported by docutils_ (or pandoc_, or any RST converter).

.. _docutils: http://docutils.sourceforge.net/
.. _pandoc: http://pandoc.org/

.. warning::

   **Compatibility**

   For now, Waarp Analyze *only* runs on GNU/Linux 32 and 64 bits.
   It *only* detects **running instances of Waarp R66 Server**.

Links
-----

* `Source code <https://github.com/waarp/analyze>`__
* `Download <https://dl.waarp.org/dist/waarp-analyze/>`__
* `Documentation <https://doc.waarp.org/waarp-analyze/latest/en>`__

License
-------

Waarp Analyze is provided under the terms of the MIT license.

Contents
--------

.. toctree::
   :maxdepth: 2

   install
   use
   sample
   roadmap
   changelog