OpenLMI Tools documentation
===========================
`OpenLMI Tools` currently consist of *LMIShell* and the content of the
documentation itself is devoted to the LMIShell.

LMIShell
--------

.. only:: not man

    LMIShell provides a (non)interactive way how to access CIM objects provided
    by *OpenPegasus* or *sblim-sfcb* broker. The shell is based on a python
    interpreter and added logic, therefore what you can do in pure python, it
    is possible in LMIShell. There are classes added to manipulate with CIM
    classes, instance names, instances, etc.  Additional classes are added to
    fulfill wrapper pattern and expose only those methods, which are necessary
    for the purpose of a shell.

    **Contents:**

.. only:: html

    .. toctree::
        :maxdepth: 1

        shell/startup
        shell/namespaces
        shell/classes
        shell/instances
        shell/instance_names
        shell/associated_objects
        shell/association_objects
        shell/indications
        shell/return_values
        shell/interactive_interface
        shell/builtins
        shell/code

.. only:: not man and not html

    .. toctree::
        :maxdepth: 1

        shell/startup
        shell/namespaces
        shell/classes
        shell/instances
        shell/instance_names
        shell/associated_objects
        shell/association_objects
        shell/indications
        shell/return_values
        shell/interactive_interface
        shell/builtins

.. only:: man

    LMIShell provides a (non)interactive way how to access CIM objects provided
    by *OpenPegasus* or *sblim-sfcb* broker.

    .. toctree::

        shell/man_page
        shell/startup
        shell/namespaces
        shell/classes
        shell/instances
        shell/instance_names
        shell/associated_objects
        shell/association_objects
        shell/indications
        shell/return_values
        shell/interactive_interface
        shell/builtins

OpenLMI Meta-command
--------------------

Sits on up of *LMIShell*. It's a command line interface to OpenLMI Providers.
Its set of subcommands is dynamically extended by registering new modules. Most
of them are available in upstream repository on `github`_ and downloadable from
`PyPi`_ as python eggs.

.. only:: not man

    **Contents:**

.. only:: not man and html

    .. toctree::
        :maxdepth: 2

        scripts/usage
        scripts/configuration
        scripts/script-development
        scripts/api
        scripts/commands

    Indices and tables
    ------------------

    * :ref:`genindex`
    * :ref:`modindex`
    * :ref:`search`

.. only:: not man and not html

    .. toctree::
        :maxdepth: 2

        scripts/usage
        scripts/configuration
        scripts/script-development
        scripts/commands

.. only:: man

    .. toctree::

        scripts/usage
        scripts/configuration
        scripts/commands

.. _github: https://github.com/openlmi/openlmi-scripts
.. _PyPi:   https://pypi.python.org/pypi?%3Aaction=search&term=openlmi-scripts&submit=search
