.\" 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 "MCPANI 1p" .TH MCPANI 1p "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" mcpani \-\- A command line tool to manage a CPAN Mini Mirror. .SH "SYNOPSIS" .IX Header "SYNOPSIS" mcpani [options] < \-\-add | \-\-update | \-\-mirror | \-\-inject > .PP Commands: .PP .Vb 5 \& \-\-add Add a new package to the repository \& \-\-module Name of the module to add \& \-\-authorid Author ID of the module \& \-\-modversion Version number of the module \& \-\-file tar.gz file of the module \& \& \-\-update Update local CPAN mirror and inject modules \& \-\-mirror Update local CPAN mirror from remote \& \-\-inject Add modules from repository to CPAN mirror .Ve .PP Options: .PP .Vb 2 \& \-h, \-\-help This synopsis \& \-H, \-\-man Detailed description \& \& \-l, \-\-local local location for CPAN::Mini Mirror \& \-r, \-\-remote CPAN mirror to mirror from \& \-p, \-\-passive Enable passive ftp for mirroring. \& \-v, \-\-verbose verbose output \& \-V, \-\-version Version information. \& \-\-signing\-key See CPAN::Checksums $SIGNING_KEY .Ve .SH "COMMAND LINE OPTIONS" .IX Header "COMMAND LINE OPTIONS" .SS "\-\-add" .IX Subsection "--add" Add a module to the repository for later inclusion in the \s-1CPAN\s0 Mini mirror. The add command requires the following parameters: .IP "\-\-module" 4 .IX Item "--module" This is the name of the module (ie CPAN::Mini::Inject). .IP "\-\-authorid" 4 .IX Item "--authorid" A \s-1CPAN\s0 'like' author \s-1ID\s0 for the module. The author \s-1ID\s0 does not need to exist on \s-1CPAN.\s0 .IP "\-\-modversion" 4 .IX Item "--modversion" Version number of the module. This must match the version number in the file name. .IP "\-\-all\-in\-meta" 4 .IX Item "--all-in-meta" .PD 0 .IP "\-\-discover\-packages" 4 .IX Item "--discover-packages" .PD \&\*(L"add\*(R" in CPAN::Mini::Inject adds all modules found in the file. These options remain for backward compatibility and do nothing. .IP "\-\-file" 4 .IX Item "--file" File name and path of the module. The file name must follow the standard \s-1CPAN\s0 naming convention (the resulting file from a \&\f(CW\*(C`make tardist\*(C'\fR). .PP .Vb 1 \& Example: \& \& mcpani \-\-add \-\-module CPAN::Mini::Inject \-\-authorid SSORICHE \& \-\-modversion 0.01 \-\-file ./CPAN\-Mini\-Inject\-0.01.tar.gz .Ve .SS "\-\-update" .IX Subsection "--update" Update your local \s-1CPAN\s0 Mini mirror from a \s-1CPAN\s0 site. Once completed add the modules contained in the repository to it. This is the same as running \f(CW\*(C`mcpani \-\-mirror\*(C'\fR followed by \f(CW\*(C`mcpani \-\-inject\*(C'\fR .SS "\-\-mirror" .IX Subsection "--mirror" Update the local \s-1CPAN\s0 Mini mirror from \s-1CPAN.\s0 .SS "\-\-inject" .IX Subsection "--inject" Add the repository modules into the \s-1CPAN\s0 Mini mirror. .SS "\-l, \-\-local" .IX Subsection "-l, --local" A local directory to store the \s-1CPAN\s0 Mini mirror in. Specifying this option overrides the value in the config file. .SS "\-r, \-\-remote" .IX Subsection "-r, --remote" A \s-1CPAN\s0 site to create the local \s-1CPAN\s0 Mini mirror from. .SS "\-v, \-\-verbose" .IX Subsection "-v, --verbose" Display verbose processing information .SS "\-V, \-\-version" .IX Subsection "-V, --version" Display version information. .SH "CONFIGURATION FILE" .IX Header "CONFIGURATION FILE" \&\fImcpani\fR uses a simple configuration 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, with spaces between them. (*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 (octal value). The default value is based on the umask (if supported). .PP \&\fImcpani\fR 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 .SH "CURRENT MAINTAINER" .IX Header "CURRENT MAINTAINER" Christian Walde \f(CW\*(C`\*(C'\fR .SH "AUTHOR" .IX Header "AUTHOR" Shawn Sorichetti \f(CW\*(C`\*(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 . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .SH "Copyright & License" .IX Header "Copyright & License" Copyright 2004 Shawn Sorichetti, All Rights Reserved. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.