path: root/README
diff options
authorDaniel Friesel <>2013-09-30 17:40:20 +0200
committerDaniel Friesel <>2013-09-30 17:40:20 +0200
commite3ce3a77fccdd9377b0e3023f1f38ef86201aa45 (patch)
tree396af7e9beaf115c15f3203597f019595318f12c /README
parentf77c71dec31f5a416757a313e1f9e6cfd891ad48 (diff)
allow build-time specification of icinga paths
Diffstat (limited to 'README')
1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
index c71ddc8..7dddf74 100644
--- a/README
+++ b/README
@@ -20,5 +20,23 @@ Extra modules required for testing:
* Test::Pod
* Test::Command
+Note: To work with an Icinga installation, icli needs to know the path to
+three files:
+* objects.cache (icinga.cfg object_cache_file)
+* status.dat (icinga.cfg status_file)
+* icinga.cmd (icinga.cfg command_file)
+If you are building interactively and the default values for these paths
+do not exist, you will be asked for them -- hit return to keep the default.
+In a non-interactive build, the defaults will be used (unless changed using
+an option, see below).
+If you need to set them regardless of the build host, do not wish to be
+promited at all, or are using a non-interactive build process (perhaps even
+for a whole distribution), you can set them using the following options:
+> perl Build.PL --icli-object-file=.../objects.cache \
+ --icli-status-file=.../status.dat \
+ --icli-command-file=.../icinga.cmd