README

# INTRODUCTION

crmsh is a command-line interface for High-Availability cluster
management on GNU/Linux systems. It simplifies the configuration,
management and troubleshooting of Pacemaker-based clusters, by
providing a powerful and intuitive set of features.

crmsh can function both as an interactive shell with tab completion
and inline documentation, and as a command-line tool. It can also be
used in batch mode to execute commands from files.

# MORE INFORMATION

The website for crmsh is:

  * http://crmsh.github.io/

Documentation for the latest stable release is found at:

  * http://crmsh.github.io/documentation.html

# DEVELOPMENT

crmsh is implemented in Python. The source code for crmsh is kept in a
git source repository. To check out the latest development
version, install git and run this command:

    git clone https://github.com/crmsh/crmsh

Bugs and issues can be reported here:

 * https://github.com/crmsh/crmsh/issues

Any other questions or comments can be made on the linux-ha mailing
list at:

 * http://lists.linux-ha.org/mailman/listinfo/linux-ha

# INSTALLING

Autoconf is used to take care of platform dependendent locations.
It is mainly inherited from the Pacemaker source.

    ./autogen.sh
    ./configure
    make
    make install

# MANIFEST

    ./doc: man page, source for the website and other documentation
    ./modules: the code
    ./templates: configuration templates
    ./test: unit tests and regression tests
    ./contrib: vim highlighting scripts and other semi-related
               contributions
    ./hb_report: log file collection and analysis tool