=========================================================================
Config::File -- Configuration File Management with versionning
-------------------------------------------------------------------------
$Id: README,v 1.2 2013/05/22 11:38:44 doccy Exp $
=========================================================================


OVERVIEW:
========

The Config::File module helps to manage configuration files.
It provides versionning and check for updates of obsolete
versions

All files are self documented using the POD format and tools.

DESCRIPTION:
===========

Usage:

 use Config::File;

 my $cfg = new Config(
                      # Mandatory settings
                      "toolname" => "tool name",
                      # Optional settings
                      "version" => "version string", # default to undef
                      "filename" => "config file basename", # default to "config"
                      "paths" => [qw(list of/paths /to/look ./for)], # default to [qw(. __APPDIR__ /usr/local/etc /etc)],
                      "interactive" => 0, # default to 1
                     );

INSTALLATION:
============

To install this module type the following:

   perl Makefile.PL
   make
   make test
   make install


DEPENDENCIES:
============

This package requires these other programs, modules and libraries* :

- perl 5.1 or +
- strict
- warnings
- utf8
- Exporter
- File::Basename
- File::HomeDir
- POSIX
- Pod::Usage
- Text::Patch
- Text::Diff
- Data::Dumper
- Carp

Notice that almost required modules/libraries are standard.


PROBLEMS:
========


COPYRIGHT AND LICENCE:
=====================

  Copyright © 2012-2013 -- LIRMM/UM2
                          (Laboratoire d'Informatique, de Robotique et de
                           Microélectronique de Montpellier /
                           Université de Montpellier 2)
                           IRB/INSERM
                          (Institut de Recherche en Biothérapie /
                           Institut National de la Santé et de la
                           Recherche Médicale)

Auteurs/Authors: Alban MANCHERON  <alban.mancheron@lirmm.fr>
                 Nicolas PHILIPPE <nicolas.philippe@inserm.fr>

-------------------------------------------------------------------------

Ce fichier  fait partie  du Pipeline  de traitement  de données NGS de la
plateforme ATGC labélisée par le GiS IBiSA.

Ce logiciel est régi  par la licence CeCILL  soumise au droit français et
respectant les principes  de diffusion des logiciels libres.  Vous pouvez
utiliser, modifier et/ou redistribuer ce programme sous les conditions de
la licence CeCILL  telle que diffusée par le CEA,  le CNRS et l'INRIA sur
le site "http://www.cecill.info".

En contrepartie de l'accessibilité au code source et des droits de copie,
de modification et de redistribution accordés par cette licence, il n'est
offert aux utilisateurs qu'une garantie limitée.  Pour les mêmes raisons,
seule une responsabilité  restreinte pèse  sur l'auteur du programme,  le
titulaire des droits patrimoniaux et les concédants successifs.

À  cet égard  l'attention de  l'utilisateur est  attirée sur  les risques
associés  au chargement,  à  l'utilisation,  à  la modification  et/ou au
développement  et à la reproduction du  logiciel par  l'utilisateur étant
donné  sa spécificité  de logiciel libre,  qui peut le rendre  complexe à
manipuler et qui le réserve donc à des développeurs et des professionnels
avertis  possédant  des  connaissances  informatiques  approfondies.  Les
utilisateurs  sont donc  invités  à  charger  et  tester  l'adéquation du
logiciel  à leurs besoins  dans des conditions  permettant  d'assurer  la
sécurité de leurs systêmes et ou de leurs données et,  plus généralement,
à l'utiliser et l'exploiter dans les mêmes conditions de sécurité.

Le fait  que vous puissiez accéder  à cet en-tête signifie  que vous avez
pris connaissance  de la licence CeCILL,  et que vous en avez accepté les
termes.

-------------------------------------------------------------------------

This File is part of the NGS data processing Pipeline of the ATGC
accredited by the IBiSA GiS.

This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".

As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.

In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the same
conditions as regards security.

The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.


