.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "Poet::Manual::Configuring 3pm"
.TH Poet::Manual::Configuring 3pm "2015-01-08" "perl v5.20.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"
Poet::Manual::Configuring \- Built\-in Poet configuration options
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a list of configuration keys used by Poet itself. These may be placed
in any Poet conf file, e.g. \f(CW\*(C`local.cfg\*(C'\fR or
\&\f(CW\*(C`conf/global/*.cfg\*(C'\fR.
.PP
Entries like \f(CW\*(C`foo.bar\*(C'\fR can be listed either in dot notation
.PP
.Vb 1
\&    foo.bar: 5
.Ve
.PP
or as part of a hash:
.PP
.Vb 2
\&    foo:
\&       bar: 5
.Ve
.PP
See Dot notation for details.
.IP "cache" 4
.IX Item "cache"
The entire hash under this entry will be passed to
Poet::Cache\->\fIconfig()\fR. See
Poet::Cache for examples. e.g.
.Sp
.Vb 10
\&   cache:
\&      defaults:
\&         expires_variance: 0.2
\&      storage:
\&         file:
\&            driver: File
\&            root_dir: ${root}/data/cache
\&         memcached:
\&            driver: Memcached
\&            servers: ["10.0.0.15:11211", "10.0.0.15:11212"]
\&            compress_threshold: 4096
\&      namespace:
\&         /some/component:       { storage: file, expires_in: 5min }
\&         /some/other/component: { storage: memcached, expires_in: 1h }
\&         Some::Library:         { storage: memcached, expires_in: 10min }
.Ve
.IP "env.bin_dir, env.comps_dir, etc." 4
.IX Item "env.bin_dir, env.comps_dir, etc."
These entries affect what is returned from \f(CW\*(C`$poet\->bin_dir\*(C'\fR,
\&\f(CW\*(C`$poet\->bin_path\*(C'\fR, \f(CW\*(C`$poet\->comps_dir\*(C'\fR, etc., and thus where various
Poet resources are kept. See Poet::Environment. For example, to move data and logs into external
directories outside the environment:
.Sp
.Vb 3
\&    env:
\&      data_dir: /some/external/data/dir
\&      logs_dir: /some/external/logs/dir
.Ve
.IP "log.defaults, log.category" 4
.IX Item "log.defaults, log.category"
Specify the log level, output location, and layout string for logging, in the
default case and for particular categories respectively. See
Poet::Log for examples. e.g.
.Sp
.Vb 12
\&    log:
\&      defaults:
\&        level: info
\&        output: poet.log
\&        layout: "%d{dd/MMM/yyyy:HH:mm:ss.SS} [%p] %c \- %m \- %F:%L \- %P%n"
\&      class:
\&        CHI:
\&          level: debug
\&          output: chi.log
\&          layout: "%d{dd/MMM/yyyy:HH:mm:ss.SS} %m \- %P%n"
\&        MyApp::Foo:
\&          output: stdout
.Ve
.IP "log.log4perl_conf" 4
.IX Item "log.log4perl_conf"
Bypass Poet's simplified logging configuration and specify a log4perl conf file
directly. e.g.
.Sp
.Vb 2
\&    log:
\&      log4perl_conf: /path/to/log4perl.conf
.Ve
.IP "mason" 4
.IX Item "mason"
The hash under this entry will be treated as options that are passed to
\&\f(CW\*(C`Mason\->new\*(C'\fR for the main Mason instance, overriding any default options.
See Poet::Mason. e.g.
.Sp
.Vb 3
\&    mason:
\&      static_source: 1
\&      static_source_touch_file: ${root}/data/purge.dat
.Ve
.IP "server.default_content_type" 4
.IX Item "server.default_content_type"
Content type for requests that don't explicitly set one. Defaults to
\&\f(CW\*(C`text/html\*(C'\fR.
.IP "server.host" 4
.IX Item "server.host"
The \s-1IP\s0 address to listen on.
.IP "server.load_modules" 4
.IX Item "server.load_modules"
A list of modules to load on server startup, e.g.
.Sp
.Vb 5
\&    server.load_modules:
\&       \- DBI
\&       \- List::Util
\&       \- MyApp::Foo
\&       \- MyApp::Bar
.Ve
.IP "server.port" 4
.IX Item "server.port"
The port to listen on.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Poet
.SH "AUTHOR"
.IX Header "AUTHOR"
Jonathan Swartz <swartz@pobox.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2012 by Jonathan Swartz.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.