Padre::Config::Constants.3pm

Langue: en

Version: 2009-03-29 (fedora - 05/07/09)

Section: 3 (Bibliothèques de fonctions)

NAME

Padre::Config::Constants - constants used by config subsystems

SYNOPSIS

         use Padre::Config::Constants qw{ :all };
         [...]
         # do stuff with exported constants
 
 

DESCRIPTION

Padre uses various configuration subsystems (see "Padre::Config" for more information). Those systems needs to somehow agree on some basic stuff, which is defined in this module.

PUBLIC API


Available constants

This module exports nothing by default. However, some constants can be imported with:

         use Padre::Config::Constants qw{ $FOO $BAR };
 
 

The list of available constants are:

$BOOLEAN, $POSINT, $INTEGER, $ASCII, $PATH

Settings types.

$HOST, $HUMAN, $PROJECT

Settings stores.

$CONFIG_FILE_HOST

DB configuration file storing host settings.

$CONFIG_FILE_USER

YAML configuration file storing user settings.

$PADRE_CONFIG_DIR

Private Padre configuration directory Padre, used to store stuff.

$PADRE_PLUGIN_DIR

Private directory where Padre can look for plugins.

$PADRE_PLUGIN_LIBDIR

Subdir of $PADRE_PLUGIN_DIR with the path "Padre/Plugin" added (or whatever depending on your platform) so that perl can load a "Padre::Plugin::" plugin.

Available group of constants

Since lots of constants are somehow related, this module defines some tags to import them all at once, with eg:

         use Padre::Config::Constants qw{ :dirs };
 
 

The tags available are:

all

Imports everything.

dirs

Imports $PADRE_CONFIG_DIR, $PADRE_PLUGIN_DIR and $PADRE_PLUGIN_LIBDIR.

files

Imports $CONFIG_FILE_HOST and $CONFIG_FILE_USER.

stores

Imports $BOOLEAN, $POSINT, $INTEGER, $ASCII and $PATH.

types

Imports $HOST, $HUMAN and $PROJECT.

Copyright 2008-2009 The Padre development team as listed in Padre.pm.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5 itself.