1Publican(3)           User Contributed Perl Documentation          Publican(3)
2
3
4

NAME

6       Publican - Used to control settings for sub modules.
7

VERSION

9       This document describes Publican version $VERSION
10

SYNOPSIS

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

DESCRIPTION

17       Handles general configuration of all sub modules.
18

INTERFACE

20   _load_config
21       Private method for loading a config file
22
23   _validate_config
24       Private method for validating configuration
25
26   new
27       Create a Publican object.
28
29       my $publican = Publican->new({debug => 1});
30
31       Parameters:
32
33          configfile       Override Configuration file to use.
34          debug            Use debug mode for messages.
35          common_config    Override path to coomo configuration files.
36          common_content   Override path to common content files.
37
38   debug_msg
39       Print out debugging information.
40
41   param
42       Return the current value of a configuration parameter
43
44       $publican->param('debug');
45
46   help_config
47       Display a list of config file parameters and a short description of
48       them.
49
50   dir_list
51       list all the files in a directory, and its sub-directories, matching
52       the supplied regex.
53
54   get_all_langs
55       Get all valid language directories.
56
57   logger
58       Log something, currently emits to STDERR
59
60       TODO: consider using Log::Dispatch or similar
61
62   valid_lang
63       Is the requested language valid according to I18N::LangTags::List
64
65   maketext
66       Get localised strings
67
68   old2new
69       Parse a publican 0.x Makefile and create a publican 1.x config file.
70

DIAGNOSTICS

72       "unknown args %s"
73           All subs with named parameters will return this error when
74           unexpected named arguments are provided.
75
76       "%s is a required argument"
77           Any sub with a mandatory parameter will return this error if the
78           parameter is undef.
79
80       "Config file not found: %s"
81           publican can not find the named configuration file.
82
83       "Failed to load config file: %s"
84           The named configuration file could not be loaded.
85
86       "Can't locate required file: %s"
87           A file required for processing could not be found.
88
89       "title not found in Info file"
90           The <type>_Info.xml file does not contain a title tag.
91
92       "productname not found in Info file"
93           The <type>_Info.xml file does not contain a productname tag.
94
95       "productnumber not found in Info file"
96           The <type>_Info.xml file does not contain a productnumber tag.
97
98       "edition not found in Info file"
99           The <type>_Info.xml file does not contain a edition tag.
100
101       "pubsnumber not found in Info file"
102           The <type>_Info.xml file does not contain a pubsnumber tag.
103
104       "Failed to load brand default config file"
105           A detected defaults.cfg for the current brand could not be loaded.
106
107       "Failed to load brand overrides config file"
108           A detected overrides.cfg for the current brand could not be loaded.
109
110       "Could not create a Publican::Localise object"
111           Could not create a Publican::Localise object
112
113       "Can't open directory"
114

CONFIGURATION AND ENVIRONMENT

116       Publican requires no configuration files or environment variables.
117

DEPENDENCIES

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

INCOMPATIBILITIES

123       None reported.
124

BUGS AND LIMITATIONS

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

AUTHOR

133       Jeff Fearn  "<jfearn@redhat.com>"
134
135
136
137perl v5.10.1                      2010-11-12                       Publican(3)