Foswiki on GitHub is open for business! Next release meeting: Monday September 29, 1300Z

Item10729: Document all core tools scripts in System/CommandAndCGIScripts

Priority: CurrentState: AppliesTo: Component: WaitingFor:
Normal Closed Engine Documentation  
or at least linked to? don't make the poor admins search.

heck, why doesn't the script tell the user what the params are...

-- SvenDowideit - 10 May 2011

I see the following scripts listed in MANIFEST:
  • tools/extender.pl (not callable as a stand-alone script, as described in the file)
  • tools/geturl.pl (documented)
  • tools/rewriteshebang.pl (documented)
  • tools/tick_foswiki.pl (documented)
  • tools/extension_installer (documented)
  • tools/dependencies_installer.pl - not documented
So I assume this report relates to tools/dependencies_installer.pl

Confirmed that this is not documented, and downgraded to normal as the script should be rarely used (it duplicates configure AFAICT). Marked for IngoKappler's attention as he is author of the script.

-- CrawfordCurrie - 08 Jun 2011

Hi,

sorry, my issue and thanks for indicating a place to document it. I don't think it duplicates configure, as it purely installs missing perl modules, so something admins otherwise need to do manually per packaging system or from CPAN. The script is based on discussions in ScanForMissingPerlModules.

Running it with -h leads to:
tools# ./dependencies_installer.pl -h                                                                                                                                           
Usage:                                                                                                                                                                                               
    dependencies_installer.pl [-h|?|--help] [-m|--man] [-p|--print]                                                                                                                                  
    [-q|--questions] [-v|--verbose]                                                                                                                                                                  
                                                                                                                                                                                                     
    Options:                                                                                                                                                                                         
                                                                                                                                                                                                     
    -h or -? or --help brief help message                                                                                                                                                            
                                                                                                                                                                                                     
    -m or --man full documentation                                                                                                                                                                   
                                                                                                                                                                                                     
    -p or --print list all Perl modules we are aware of, plus uninstall                                                                                                                              
    commands                                                                                                                                                                                         
                                                                                                                                                                                                     
    -q or --questions ask additional questions instead of using default                                                                                                                              

    -v or --verbose lists installed Perl modules with version numbers

Options:
    -h|--help
            Prints a brief help message and exits.

    -m|--man
            Prints the manual page and exits.

    -p or --print
            List all Perl modules this program is currently aware of. Also
            reflect which are covered by a package manager versus the ones
            only available from CPAN.

    -q or --questions
            Ask additional questions instead of just using the default.
            Currently this only applies to Apache related modules, being
            available for Apache 1.x and 2.x. By default modules for 2.x are
            installed. Use this option if the default isn't matching for
            you.

    -v|--verbose
            Lists installed Perl modules with version numbers.

Using -m leads to:
NAME
       dependencies_installer.pl - Searches missing Perl modules and offers installation via CPANPLUS or a supported package management system.  Currently only CPANPLUS and Debian packages
       using suffix "deb" are supported.

SYNOPSIS
       dependencies_installer.pl [-h|?|--help] [-m|--man] [-p|--print] [-q|--questions] [-v|--verbose]

       Options:

       -h or -? or --help brief help message

       -m or --man full documentation

       -p or --print list all Perl modules we are aware of, plus uninstall commands

       -q or --questions ask additional questions instead of using default

       -v or --verbose lists installed Perl modules with version numbers

OPTIONS
       -h|--help
               Prints a brief help message and exits.

       -m|--man
               Prints the manual page and exits.

       -p or --print
               List all Perl modules this program is currently aware of. Also reflect which are covered by a package manager versus the ones only available from CPAN.

       -q or --questions
               Ask additional questions instead of just using the default. Currently this only applies to Apache related modules, being available for Apache 1.x and 2.x. By default modules for
               2.x are installed. Use this option if the default isnít matching for you.

       -v|--verbose
               Lists installed Perl modules with version numbers.

DESCRIPTION
       This Perl program will analyse if the core Foswiki, a shipped tool in the tools directory or any of the installed extensions use Perl modules which are not yet available in the system.
       All identified modules can be listed with their version number (--verbose). Finally an overview is presented about which should be installed.

       Currently the following installation methods are supported:

       1. Directly from CPAN using CPANPLUS

       2. Debian packages using suffix "deb"

       On all systems it should be possible to install modules from CPAN. This program offers to install missing modules by using CPANPLUS (cpanp). Recent Perl versions ship with CPANPLUS and
       have it pre-configured allowing to install immediately. If its configuration hasnít been tweaked to your local needs, upon first run it may take a bit until it indeed starts
       installation but it should work. On Windows the script was tested with ActivePerl (5.12.1; initially a missing C compiler and make utility was installed automatically).

       On Debian and Ubuntu the system related package management can be used to install required modules. Since on Debian aptitude is the recommended installer, the program prefers it if
       available. Otherwise it offers to install it or to use apt-get instead. Some modules might only be available from CPAN. If so, the program asks you to start over to complete
       installation of remaining modules by using CPANPLUS additionally.

       If a module isnít mapped correctly to an existing package or not considered although a package exists for the related package manager, then please raise it as an issue on foswiki.org
       (e.g. as task), so it can be addressed.

So it is documented but this is not yet linked into official Foswiki places. I will do that.

-- IngoKappler - 21 Sep 2011
 

ItemTemplate edit

Summary Document all core tools scripts in System/CommandAndCGIScripts
ReportedBy SvenDowideit
Codebase 1.1.3, trunk
SVN Range
AppliesTo Engine
Component Documentation
Priority Normal
CurrentState Closed
WaitingFor
Checkins Foswikirev:12601 Foswikirev:12602 Foswikirev:12603 Foswikirev:12606
TargetRelease patch
ReleasedIn 1.1.4
Topic revision: r12 - 17 Dec 2011, GeorgeClark
 
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement. Creative Commons License