SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE


YUM REPOSITORY

 
 

MAN page from OpenSuSE perl-ProjectBuilder-0.15.2-1.opensuse15.1.noarch.rpm

ProjectBuilder::Conf

Section: User Contributed Perl Documentation (3)
Updated: 2019-09-06
Index 

NAME

ProjectBuilder::Conf, part of the project-builder.org - module dealing with configuration files 

DESCRIPTION

This modules provides functions dealing with configuration files. 

SYNOPSIS

  use ProjectBuilder::Conf;  #  # Read hash codes of values from a configuration file and return table of pointers  #  my ($k1, $k2) = pb_conf_read_if("$ENV{'HOME'}/.pbrc.yml","key1","key2");  my ($k) = pb_conf_read("$ENV{'HOME'}/.pbrc.yml","key");
 

USAGE

The configuration files are loaded in a specific order from most generic to the most specific to allow for overwrite to work:

For recent versions of pb (>= 0.15):1. /usr/share/pb/pb.yml - the read-only system conf file provided by install2. /etc/pb/pb.yml - the same global conf file given to the sysadmin in order to make system wide modifications3. /path/to/project.yml - Configuration file for the project we're building for4. /vm|vepath/to/.pbrc.yml - configuration file for VM, VE or RM specific parameters. Cumulative should be orthogonal5. $HOME/.pbrc.yml - user's configuration file

For versions of pb up to 0.14:1. /usr/share/pb/pb.conf - the read-only system conf file provided by install2. /etc/pb/pb.conf - the same global conf file given to the sysadmin in order to make system wide modifications3. /path/to/project.pb - Configuration file for the project we're building for4. /(vm|ve|rm)path/to/.pbrc - configuration file for VM, VE or RM specific parameters. Cumulative should be orthogonal5. $HOME/.pbrc - user's configuration file

The format of the configuration file is as follows:

For recent versions of pb (>= 0.15):YAML format is now used - The version of the configuration files is

Supposing the file is called ``$ENV{'HOME'}/.pbrc.yml'', containing the following:

  $ cat $HOME/.pbrc.yml  ---    pbver:      - pb: 3      - default: 1    pblist:      - pb: 12,25

calling it like this:

  my ($k1, $k2) = pb_conf_read_if("$ENV{'HOME'}/.pbrc.yml","pbver","pblist");

will allow to get the mapping:

  $k1->{'pb'} contains 3  $k1->{'default'} contains 1  $k2->{'pb'} contains 12,25

For versions of pb up to 0.14:An own format was used - The version of the configuration files is 0

key tag = value1,value2,...

Supposing the file is called ``$ENV{'HOME'}/.pbrc'', containing the following:

  $ cat $HOME/.pbrc  pbver pb = 3  pbver default = 1  pblist pb = 12,25

calling it like this:

  my ($k1, $k2) = pb_conf_read_if("$ENV{'HOME'}/.pbrc","pbver","pblist");

will allow to get the mapping:

  $k1->{'pb'}  contains 3  $k1->{'default'} contains 1  $k2->{'pb'} contains 12,25

Valid chars for keys and tags are letters, numbers, '-' and '_'.

pb_conf_init
This function setup the environment PBPROJ for project-builder function usage from other projects.The first parameter is the project name.It sets up environment variables (PBPROJ)
pb_conf_cache
This function caches the configuration file content passed as first parameter into the hash passed in second parameterIt returns the modified hashCan be used in correlation with the %h hash to store permanently values or not if temporarily.
pb_conf_add
This function adds the configuration file to the list last, and cache their content in the %h hash
pb_conf_read_if
This function returns a table of pointers on hashescorresponding to the keys in a configuration file passed in parameter.If that file doesn't exist, it returns undef.

The file read is forgotten after its usage. If you want permanent caching of the data, use pb_conf_add then pb_conf_get

pb_conf_read
This function is similar to pb_conf_read_if except that it dies when the file in parameter doesn't exist.
pb_conf_write
This function writes in the file passed as first parameter the hash of values passed as second parameter
pb_conf_get_in_hash_if
This function returns a table, corresponding to a set of values queried in the hash passed in parameter or undef if it doesn't exist. It takes a table of keys as an input parameter.
pb_conf_get_if
This function returns a table, corresponding to a set of values queried in the %h hash or undef if it doen't exist. It takes a table of keys as an input parameter.
pb_conf_add_last_in_hash
This function merges the values passed in the hash parameter into the %h hash, but only if itdoesn't already contain a value, or if the value is more precise (real value instead of default)

It is used internally by pb_conf_add and is not exported.

pb_conf_get
This function is the same pb_conf_get_if, except that it tests each returned value as they need to exist in that case.
pb_conf_get_all
This function returns an array with all configuration parameters
pb_conf_get_hash
This function returns a pointer to the hash with all configuration parameters
pb_conf_update_v0
This function transform the old configuration v0 file as first param into a new v1 one as second param
 

WEB SITES

The main Web site of the project is available at <http://www.project-builder.org/>. Bug reports should be filled using the trac instance of the project at <http://trac.project-builder.org/>. 

USER MAILING LIST

None exists for the moment. 

AUTHORS

The Project-Builder.org team <http://trac.project-builder.org/> lead by Bruno Cornec <mailto:brunoAATTproject-builder.org>. 

COPYRIGHT

Project-Builder.org is distributed under the GPL v2.0 licensedescribed in the file "COPYING" included with the distribution.


 

Index

NAME
DESCRIPTION
SYNOPSIS
USAGE
WEB SITES
USER MAILING LIST
AUTHORS
COPYRIGHT

This document was created byman2html,using the manual pages.