--- /dev/null
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.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. | will give a
+.\" real vertical bar. \*(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-|\(bv\*(Tr
+.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\}
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. nr % 0
+. rr F
+.\}
+.\"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
+.\"
+.\" 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 "Catalyst::Plugin::ConfigLoader::Manual 3"
+.TH Catalyst::Plugin::ConfigLoader::Manual 3 "2009-05-26" "perl v5.8.7" "User Contributed Perl Documentation"
+.SH "NAME"
+Catalyst::Plugin::ConfigLoader::Manual \- Guide to using the ConfigLoader plugin
+.SH "BASIC USAGE"
+.IX Header "BASIC USAGE"
+.Vb 1
+\& package MyApp;
+.Ve
+.PP
+.Vb 1
+\& use Catalyst qw( ConfigLoader ... );
+.Ve
+.SH "ENVIRONMENT VARIABLES"
+.IX Header "ENVIRONMENT VARIABLES"
+.ie n .IP "* ""MYAPP_CONFIG"" \- specific config file to load for ""MyApp""" 4
+.el .IP "* \f(CWMYAPP_CONFIG\fR \- specific config file to load for ``MyApp''" 4
+.IX Item "MYAPP_CONFIG - specific config file to load for MyApp"
+.PD 0
+.ie n .IP "* ""CATALYST_CONFIG_LOCAL_SUFFIX"" \- global suffix for extra config files" 4
+.el .IP "* \f(CWCATALYST_CONFIG_LOCAL_SUFFIX\fR \- global suffix for extra config files" 4
+.IX Item "CATALYST_CONFIG_LOCAL_SUFFIX - global suffix for extra config files"
+.ie n .IP "* ""MYAPP_CONFIG_LOCAL_SUFFIX"" \- suffix specifically for ""MyApp""" 4
+.el .IP "* \f(CWMYAPP_CONFIG_LOCAL_SUFFIX\fR \- suffix specifically for ``MyApp''" 4
+.IX Item "MYAPP_CONFIG_LOCAL_SUFFIX - suffix specifically for MyApp"
+.PD
+.SH "CONFIG FORMATS"
+.IX Header "CONFIG FORMATS"
+.Sh "Config::General"
+.IX Subsection "Config::General"
+\fIExtensions\fR
+.IX Subsection "Extensions"
+.IP "* cnf" 4
+.IX Item "cnf"
+.PD 0
+.IP "* conf" 4
+.IX Item "conf"
+.PD
+.PP
+\fIExample Config\fR
+.IX Subsection "Example Config"
+.PP
+.Vb 7
+\& name = TestApp
+\& <Component Controller::Foo>
+\& foo bar
+\& </Component>
+\& <Model Baz>
+\& qux xyzzy
+\& </Model>
+.Ve
+.Sh "\s-1INI\s0"
+.IX Subsection "INI"
+\fIExtensions\fR
+.IX Subsection "Extensions"
+.IP "* ini" 4
+.IX Item "ini"
+.PP
+\fIExample Config\fR
+.IX Subsection "Example Config"
+.PP
+.Vb 1
+\& name=TestApp
+.Ve
+.PP
+.Vb 2
+\& [Controller::Foo]
+\& foo=bar
+.Ve
+.PP
+.Vb 2
+\& [Model::Baz]
+\& qux=xyzzy
+.Ve
+.Sh "\s-1JSON\s0"
+.IX Subsection "JSON"
+\fIExtensions\fR
+.IX Subsection "Extensions"
+.IP "* jsn" 4
+.IX Item "jsn"
+.PD 0
+.IP "* json" 4
+.IX Item "json"
+.PD
+.PP
+\fIExample Config\fR
+.IX Subsection "Example Config"
+.PP
+.Vb 9
+\& {
+\& "name": "TestApp",
+\& "Controller::Foo": {
+\& "foo": "bar"
+\& },
+\& "Model::Baz": {
+\& "qux": "xyzzy"
+\& }
+\& }
+.Ve
+.Sh "Perl"
+.IX Subsection "Perl"
+\fIExtensions\fR
+.IX Subsection "Extensions"
+.IP "* pl" 4
+.IX Item "pl"
+.PD 0
+.IP "* perl" 4
+.IX Item "perl"
+.PD
+.PP
+\fIExample Config\fR
+.IX Subsection "Example Config"
+.PP
+.Vb 9
+\& {
+\& name => 'TestApp',
+\& 'Controller::Foo' => {
+\& foo => 'bar'
+\& },
+\& 'Model::Baz' => {
+\& qux => 'xyzzy'
+\& }
+\& }
+.Ve
+.Sh "\s-1XML\s0"
+.IX Subsection "XML"
+\fIExtensions\fR
+.IX Subsection "Extensions"
+.IP "* xml" 4
+.IX Item "xml"
+.PP
+\fIExample Config\fR
+.IX Subsection "Example Config"
+.PP
+.Vb 9
+\& <config>
+\& <name>TestApp</name>
+\& <component name="Controller::Foo">
+\& <foo>bar</foo>
+\& </component>
+\& <model name="Baz">
+\& <qux>xyzzy</qux>
+\& </model>
+\& </config>
+.Ve
+.Sh "\s-1YAML\s0"
+.IX Subsection "YAML"
+\fIExtensions\fR
+.IX Subsection "Extensions"
+.IP "* yml" 4
+.IX Item "yml"
+.PD 0
+.IP "* yaml" 4
+.IX Item "yaml"
+.PD
+.PP
+\fIExample Config\fR
+.IX Subsection "Example Config"
+.PP
+.Vb 6
+\& \-\-\-
+\& name: TestApp
+\& Controller::Foo:
+\& foo: bar
+\& Model::Baz:
+\& qux: xyzzy
+.Ve
+.SH "COOKBOOK"
+.IX Header "COOKBOOK"
+.Sh "Configuring a Catalyst::Model::DBIC::Schema model from a \s-1YAML\s0 config"
+.IX Subsection "Configuring a Catalyst::Model::DBIC::Schema model from a YAML config"
+.Vb 7
+\& Model::MyModel:
+\& schema_class: MyApp::MySchema
+\& connect_info:
+\& \- dbi:SQLite:myapp.db
+\& \- ''
+\& \- ''
+\& \- AutoCommit: 1
+.Ve
+.Sh "Converting your existing config to Config::General format"
+.IX Subsection "Converting your existing config to Config::General format"
+As of Catalyst::Devel 1.07, a newly created application will use
+Config::General for configuration. If you wish to convert your existing
+config, run the following one-liner (replacing MyApp with your app's name):
+.PP
+.Vb 1
+\& perl \-Ilib \-MMyApp \-MConfig::General \-e 'Config::General\->new\->save_file("myapp.conf", MyApp\->config);'
+.Ve
+.Sh "Using \s-1UTF\-8\s0 strings in a Config::General file"
+.IX Subsection "Using UTF-8 strings in a Config::General file"
+If you have \s-1UTF\-8\s0 strings in your Config::General\-based config file, you
+should add the following config information to MyApp.pm:
+.PP
+.Vb 5
+\& __PACKAGE__\->config( 'Plugin::ConfigLoader' => {
+\& driver => {
+\& 'General' => { \-UTF8 => 1 },
+\& }
+\& } );
+.Ve
+.Sh "Using a local configuration file"
+.IX Subsection "Using a local configuration file"
+When ConfigLoader reads configurations, it starts by reading the configuration
+file for \f(CW\*(C`myapp\*(C'\fR with one of the supported extensions as listed
+above.
+.PP
+For example, A Config::General config file is \f(CW\*(C`myapp.conf\*(C'\fR.
+.PP
+If a configuration file called \f(CW\*(C`myapp_local\*(C'\fR exists with one of the supported
+file extensions, it will also be read, and values from that file will
+override values from the main config file.
+.PP
+A Config::General local configuration file would be called
+\&\f(CW\*(C`myapp_local.conf\*(C'\fR.
+.PP
+The \f(CW\*(C`local\*(C'\fR suffix can be changed. See
+\&\*(L"get_config_local_suffix\*(R" in Catalyst::Plugin::ConfigLoader for the details of
+how.
+.PP
+This is useful because it allows different people or environments to have
+different configuration files. A project with three developers,
+\&\fITom\fR, \fIDick\fR, and \fIHarry\fR as well as a production environment can have
+a \f(CW\*(C`myapp_tom.conf\*(C'\fR, a \f(CW\*(C`myapp_dick.conf\*(C'\fR, a \f(CW\*(C`myapp_harry.conf\*(C'\fR, and a
+\&\f(CW\*(C`myapp_production.conf\*(C'\fR.
+.PP
+Each developer, and the web server, would set the environment variable
+to load their proper configuration file. All of the configurations can
+be stored properly in source control.
+.PP
+If there is no \f(CW\*(C`myapp.local\*(C'\fR, and the individual configuration files contain
+something required to start the application, such as the Model's data source
+definition, the applicaton won't start unless the environment variable
+is set properly.
projects / catagits/Gitalist.git / blobdiff