2. EL 6 ELS
  3. publican
  4. Publican(3pm)

Scroll to navigation

Publican(3) User Contributed Perl Documentation Publican(3)

NAME

Publican - Used to control settings for sub modules.

VERSION

This document describes Publican version $VERSION

SYNOPSIS

    use Publican;
    my $publican = Publican->new({DEBUG => 1});

DESCRIPTION

Handles general configuration of all sub modules.

INTERFACE

_load_config

Private method for loading a config file

_validate_config

Private method for validating configuration

new

Create a Publican object.

my $publican = Publican->new({debug => 1});

Parameters:

   configfile       Override Configuration file to use.
   debug            Use debug mode for messages.
   common_config    Override path to coomo configuration files.
   common_content   Override path to common content files.

debug_msg

Print out debugging information.

param

Return the current value of a configuration parameter

$publican->param('debug');

help_config

Display a list of config file parameters and a short description of them.

dir_list

list all the files in a directory, and its sub-directories, matching the supplied regex.

get_all_langs

Get all valid language directories.

logger

Log something, currently emits to STDERR

TODO: consider using Log::Dispatch or similar

valid_lang

Is the requested language valid according to I18N::LangTags::List

maketext

Get localised strings

old2new

Parse a publican 0.x Makefile and create a publican 1.x config file.

DIAGNOSTICS

"unknown args %s"
All subs with named parameters will return this error when unexpected named arguments are provided.
"%s is a required argument"
Any sub with a mandatory parameter will return this error if the parameter is undef.
"Config file not found: %s"
publican can not find the named configuration file.
"Failed to load config file: %s"
The named configuration file could not be loaded.
"Can't locate required file: %s"
A file required for processing could not be found.
"title not found in Info file"
The <type>_Info.xml file does not contain a title tag.
"productname not found in Info file"
The <type>_Info.xml file does not contain a productname tag.
"productnumber not found in Info file"
The <type>_Info.xml file does not contain a productnumber tag.
"edition not found in Info file"
The <type>_Info.xml file does not contain a edition tag.
"pubsnumber not found in Info file"
The <type>_Info.xml file does not contain a pubsnumber tag.
"Failed to load brand default config file"
A detected defaults.cfg for the current brand could not be loaded.
"Failed to load brand overrides config file"
A detected overrides.cfg for the current brand could not be loaded.
"Could not create a Publican::Localise object"
Could not create a Publican::Localise object
"Can't open directory"

CONFIGURATION AND ENVIRONMENT

Publican requires no configuration files or environment variables.

DEPENDENCIES

Carp version Config::Simple XML::TreeBuilder I18N::LangTags::List Term::ANSIColor File::Find::Rule; Publican::Localise;

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to "publican-list@redhat.com", or through the web interface at <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora&amp;version=rawhide&amp;component=publican>.

AUTHOR

Jeff Fearn "<jfearn@redhat.com>"

2010-11-23 perl v5.10.1