.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Publican 3pm" .TH Publican 3pm "2012-06-18" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Publican \- Used to control settings for sub modules. .SH "VERSION" .IX Header "VERSION" This document describes Publican version \f(CW$VERSION\fR .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Publican; \& \& my $publican = Publican\->new({DEBUG => 1}); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Handles general configuration of all sub modules. .SH "INTERFACE" .IX Header "INTERFACE" .SS "_load_config" .IX Subsection "_load_config" Private method for loading a config file .SS "_validate_config" .IX Subsection "_validate_config" Private method for validating configuration .SS "new" .IX Subsection "new" Create a Publican object. .PP my \f(CW$publican\fR = Publican\->new({debug => 1}); .PP \fIParameters:\fR .IX Subsection "Parameters:" .PP .Vb 4 \& 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. .Ve .SS "debug_msg" .IX Subsection "debug_msg" Print out debugging information. .SS "param" .IX Subsection "param" Return the current value of a configuration parameter .PP \&\f(CW$publican\fR\->param('debug'); .SS "help_config" .IX Subsection "help_config" Display a list of config file parameters and a short description of them. .SS "dir_list" .IX Subsection "dir_list" list all the files in a directory, and its sub-directories, matching the supplied regex. .SS "get_all_langs" .IX Subsection "get_all_langs" Get all valid language directories. .SS "logger" .IX Subsection "logger" Log something, currently emits to \s-1STDOUT\s0 .PP \&\s-1TODO:\s0 consider using Log::Dispatch or similar .SS "valid_lang" .IX Subsection "valid_lang" Is the requested language valid according to I18N::LangTags::List .SS "maketext" .IX Subsection "maketext" Get localised strings .SS "old2new" .IX Subsection "old2new" Parse a publican 0.x Makefile and create a publican 1.x config file. .SS "get_abstract" .IX Subsection "get_abstract" Return the abstract for the supplied langauge with all white space truncted. .SS "get_subtitle" .IX Subsection "get_subtitle" Return the subtitle for the supplied langauge with white space truncted. .SS "run_xslt" .IX Subsection "run_xslt" Apply the supplied xslt file to teh supplied \s-1XML\s0 and return a string of the output. .SS "new_tree" .IX Subsection "new_tree" Create a new XML::TreeBuilder object with the required attributes for DocBook. .PP \&\s-1TODO:\s0 Make XmlClean use this. .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" .ie n .IP """unknown args %s""" 4 .el .IP "\f(CWunknown args %s\fR" 4 .IX Item "unknown args %s" All subs with named parameters will return this error when unexpected named arguments are provided. .ie n .IP """%s is a required argument""" 4 .el .IP "\f(CW%s is a required argument\fR" 4 .IX Item "%s is a required argument" Any sub with a mandatory parameter will return this error if the parameter is undef. .ie n .IP """Config file not found: %s""" 4 .el .IP "\f(CWConfig file not found: %s\fR" 4 .IX Item "Config file not found: %s" publican can not find the named configuration file. .ie n .IP """Failed to load config file: %s""" 4 .el .IP "\f(CWFailed to load config file: %s\fR" 4 .IX Item "Failed to load config file: %s" The named configuration file could not be loaded. .ie n .IP """Can\*(Aqt locate required file: %s""" 4 .el .IP "\f(CWCan\*(Aqt locate required file: %s\fR" 4 .IX Item "Cant locate required file: %s" A file required for processing could not be found. .ie n .IP """title not found in Info file""" 4 .el .IP "\f(CWtitle not found in Info file\fR" 4 .IX Item "title not found in Info file" The _Info.xml file does not contain a title tag. .ie n .IP """productname not found in Info file""" 4 .el .IP "\f(CWproductname not found in Info file\fR" 4 .IX Item "productname not found in Info file" The _Info.xml file does not contain a productname tag. .ie n .IP """productnumber not found in Info file""" 4 .el .IP "\f(CWproductnumber not found in Info file\fR" 4 .IX Item "productnumber not found in Info file" The _Info.xml file does not contain a productnumber tag. .ie n .IP """edition not found in Info file""" 4 .el .IP "\f(CWedition not found in Info file\fR" 4 .IX Item "edition not found in Info file" The _Info.xml file does not contain a edition tag. .ie n .IP """pubsnumber not found in Info file""" 4 .el .IP "\f(CWpubsnumber not found in Info file\fR" 4 .IX Item "pubsnumber not found in Info file" The _Info.xml file does not contain a pubsnumber tag. .ie n .IP """Failed to load brand default config file""" 4 .el .IP "\f(CWFailed to load brand default config file\fR" 4 .IX Item "Failed to load brand default config file" A detected defaults.cfg for the current brand could not be loaded. .ie n .IP """Failed to load brand overrides config file""" 4 .el .IP "\f(CWFailed to load brand overrides config file\fR" 4 .IX Item "Failed to load brand overrides config file" A detected overrides.cfg for the current brand could not be loaded. .ie n .IP """Could not create a Publican::Localise object""" 4 .el .IP "\f(CWCould not create a Publican::Localise object\fR" 4 .IX Item "Could not create a Publican::Localise object" Could not create a Publican::Localise object .ie n .IP """Can\*(Aqt open directory""" 4 .el .IP "\f(CWCan\*(Aqt open directory\fR" 4 .IX Item "Cant open directory" .SH "CONFIGURATION AND ENVIRONMENT" .IX Header "CONFIGURATION AND ENVIRONMENT" Publican requires no configuration files or environment variables. .SH "DEPENDENCIES" .IX Header "DEPENDENCIES" Carp version Config::Simple XML::TreeBuilder I18N::LangTags::List Term::ANSIColor File::Find::Rule; Publican::Localise; .SH "INCOMPATIBILITIES" .IX Header "INCOMPATIBILITIES" None reported. .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" No bugs have been reported. .PP Please report any bugs or feature requests to \&\f(CW\*(C`publican\-list@redhat.com\*(C'\fR, or through the web interface at . .SH "AUTHOR" .IX Header "AUTHOR" Jeff Fearn \f(CW\*(C`\*(C'\fR