Item10729: Documenting dependencies_installer.pl.

git-svn-id: http://svn.foswiki.org/trunk@12601 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
foswiki · Sep 21, 2011 · cb13596 · cb13596
1 parent a7f6ae1
commit cb13596
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/core/data/System/CommandAndCGIScripts.txt b/core/data/System/CommandAndCGIScripts.txt
@@ -501,6 +501,19 @@ Note that this script is a generic version of the =_installer= script shipped wi
    * run =./tools/extension_installer !SomePlugin= - the extension will be downloaded and installed
    * Use the configure web interface to the Extensions Installer.
 
+---+++ =dependencies_installer.pl=
+This script searches for missing Perl modules that should be available according to your Foswiki environment and offers installation via CPANPLUS or a supported package management system. It eases perl module installation, which is part of a Foswiki installation, may be part of an extension installation or may need to follow upgrades. The script can be used to just provide an overview of Foswiki related perl modules in your installation by running it with option =-v=.
+
+For more details, execute it using option -h (help) or -m (manual):
+<verbatim>
+./dependencies_installer.pl -h                                                                                                                                           
+Usage:                                                                                                                                                                                               
+    dependencies_installer.pl [-h|?|--help] [-m|--man] [-p|--print]                                                                                                                                  
+    [-q|--questions] [-v|--verbose]
+
+[...]
+</verbatim>
+
 ---
 *Related Topics:* AdminDocumentationCategory, DeveloperDocumentationCategory
 <!-- %JQREQUIRE{"chili"}% -->
diff --git a/core/data/System/InstallationGuidePart1.txt b/core/data/System/InstallationGuidePart1.txt
@@ -289,7 +289,7 @@ Most of the <a href="http://cpan.perl.org/" rel="nofollow" target="_top">CPAN</a
 
 A more complete module status is listed in Foswiki [[%SCRIPTURLPATH{"configure"}%][configure]] (Foswiki 1.0.x: _CGI Setup_, 1.1.x: _Web Server Environment > Perl modules_). It should be easier to deal with CPAN modules from this perspective.
 
-The following CPAN modules are shipped with Foswiki, require a comment or may optionally be needed. In case the standard Foswiki will be enhanced with Foswiki:Extensions, please look at the related extension page for dependencies which may require additional modules.
+The following CPAN modules are shipped with Foswiki, require a comment or may optionally be needed. In case the standard Foswiki will be enhanced with Foswiki:Extensions, please look at the related extension page for dependencies which may require additional modules. Try the script =dependencies_installer.pl= located in the =tools= directory, which makes perl module installation easier. Run it with option =-h= to understand basics. This script requires confirmation before it actually does something.
 
 %TABLE{ initsort="3" initdirection="up" }%
 | *Module* | *Preferred version* | *Required/Optional* | *Description* |