Add README.

2 files changed, 94 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..49f5704
--- /dev/null
+++ b/README
@@ -0,0 +1,84 @@
+* Overview
+
+Mangemange is a remote management system for Ping903. It allows the user
+to inspect configuration of the running server, add or remove IP
+addresses, synchronize the monitored IP list with the Nagios
+configuration or an SQL database etc.
+
+* Examples
+
+** Identify the running serever
+
+   $ mangemanche ident
+   package ping903
+   pid 3864
+   version 0.4.90
+
+** Inspect the server configuration
+
+   $ mangemanche inspect
+
+** Inspect a particular configuration setting
+
+   $ mangemanche inspect ip-list
+
+** Add an IP address to monitoring
+
+   $ mangemanche ipadd 198.51.100.2
+
+** Import IP addresses from the Nagios configuration
+
+   $ mangemanche nagios
+
+* Installation
+
+The usual incantations apply:
+
+  perl Makefile.PL
+  make install
+
+* Documentation
+
+Run "mangemanche --help" for a detailed help.
+Run "mangemanche -?" for a list of available subcommands.
+Run "mangemanche COMMAND --help" for a detailed help for a particular
+COMMAND.
+
+Manual pages are also installed, so "man mangemanche" will give you
+the manual for the tool, and, e.g. "man inspect" will give you a
+manpage for the "mangemanche inspect" subcommand.
+
+* Notes
+
+If you plan to use "mangemanche nagios" and your Nagios configuration
+makes use of multiple template inheritance[1], you will need a modified
+version of the Nagios::Config module, available from [2].  The authors
+of the module have been informed about a proposed change[3], so
+hopefully it will be included in the next release.
+
+* References
+
+[1] https://assets.nagios.com/downloads/nagioscore/docs/nagioscore/3/en/objectinheritance.html
+[2] https://github.com/graygnuorg/perl-nagios-object
+[3] https://rt.cpan.org/Ticket/Display.html?id=132053
+
+
+* Copyright information:
+
+Copyright (C) 2020 Sergey Poznyakoff
+
+   Permission is granted to anyone to make or distribute verbatim copies
+   of this document as received, in any medium, provided that the
+   copyright notice and this permission notice are preserved,
+   thus giving the recipient permission to redistribute in turn.
+
+   Permission is granted to distribute modified versions
+   of this document, or of portions of it,
+   under the above conditions, provided also that they
+   carry prominent notices stating who last changed them.
+
+Local Variables:
+mode: outline
+paragraph-separate: "[  ]*$"
+version-control: never
+End:
diff --git a/lib/App/Mangemanche/Command/nagios.pm b/lib/App/Mangemanche/Command/nagios.pm
index d3ad347..690f33a 100644
--- a/lib/App/Mangemanche/Command/nagios.pm
+++ b/lib/App/Mangemanche/Command/nagios.pm
@@ -94,6 +94,16 @@ Look for I<PROG> in addition to B<ping903q>.
 
 =back
 
+=head1 NOTES
+
+If your Nagios configuration makes use of multiple template inheritance,
+you would need a modified version of Nagios::Config, available from
+
+L<https://github.com/graygnuorg/perl-nagios-object>.
+
+The bug was reported to the upstream.  See
+L<https://rt.cpan.org/Ticket/Display.html?id=132053>.
+    
 =head1 SEE ALSO
 
 L<ping903>,