.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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 >0, 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" 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 "CPAN::Mini::Inject::Config 3pm"
.TH CPAN::Mini::Inject::Config 3pm "2017-11-04" "perl v5.26.1" "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"
CPAN::Mini::Inject::Config \- Config for CPAN::Mini::Inject
.SH "VERSION"
.IX Header "VERSION"
Version 0.35
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
.ie n .SS """config_file( [FILE] )"""
.el .SS "\f(CWconfig_file( [FILE] )\fP"
.IX Subsection "config_file( [FILE] )"
.ie n .SS """load_config()"""
.el .SS "\f(CWload_config()\fP"
.IX Subsection "load_config()"
loadcfg accepts a CPAN::Mini::Inject config file or if not defined
will search the following four places in order:
.IP "\(bu" 4
file pointed to by the environment variable \s-1MCPANI_CONFIG\s0
.IP "\(bu" 4
\&\f(CW$HOME\fR/.mcpani/config
.IP "\(bu" 4
/usr/local/etc/mcpani
.IP "\(bu" 4
/etc/mcpani
.PP
loadcfg sets the instance variable cfgfile to the file found or undef if
none is found.
.PP
.Vb 1
\& print "$mcpi\->{cfgfile}\en"; # /etc/mcpani
.Ve
.ie n .SS """parse_config()"""
.el .SS "\f(CWparse_config()\fP"
.IX Subsection "parse_config()"
parsecfg reads the config file stored in the instance variable cfgfile and
creates a hash in config with each setting.
.PP
.Vb 1
\&  $mcpi\->{config}{remote} # CPAN sites to mirror from.
.Ve
.PP
parsecfg expects the config file in the following format:
.PP
.Vb 5
\& local: /www/CPAN
\& remote: ftp://ftp.cpan.org/pub/CPAN ftp://ftp.kernel.org/pub/CPAN
\& repository: /work/mymodules
\& passive: yes
\& dirmode: 0755
.Ve
.PP
Description of options:
.IP "\(bu" 4
local
.Sp
location to store local CPAN::Mini mirror (*REQUIRED*)
.IP "\(bu" 4
remote
.Sp
\&\s-1CPAN\s0 site(s) to mirror from. Multiple sites can be listed space separated.
(*REQUIRED*)
.IP "\(bu" 4
repository
.Sp
Location to store modules to add to the local CPAN::Mini mirror.
.IP "\(bu" 4
passive
.Sp
Enable passive \s-1FTP.\s0
.IP "\(bu" 4
dirmode
.Sp
Set the permissions of created directories to the specified mode. The default
value is based on umask if supported.
.PP
If either local or remote are not defined parsecfg croaks.
.ie n .SS """get( DIRECTIVE )"""
.el .SS "\f(CWget( DIRECTIVE )\fP"
.IX Subsection "get( DIRECTIVE )"
Return the value for the named configuration directive.
.ie n .SS """set( DIRECTIVE, VALUE )"""
.el .SS "\f(CWset( DIRECTIVE, VALUE )\fP"
.IX Subsection "set( DIRECTIVE, VALUE )"
Sets the value for the named configuration directive.
.SH "CURRENT MAINTAINER"
.IX Header "CURRENT MAINTAINER"
Christian Walde \f(CW\*(C`<walde.christian@googlemail.com>\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-cpan\-mini\-inject@rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org>.  I will be notified, and then you'll automatically
be notified of progress on your bug as I make changes.