.\" Automatically generated by Pod::Man 2.27 (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 "MINICPAN 1p" .TH MINICPAN 1p "2014-08-08" "perl v5.18.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" minicpan \- uses CPAN::Mini to create or update a local mirror .SH "VERSION" .IX Header "VERSION" version 1.111016 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& minicpan [options] \& \& Options \& \-l LOCAL \- where is the local minicpan? (required) \& \-r REMOTE \- where is the remote cpan mirror? (required) \& \-d 0### \- permissions (numeric) to use when creating directories \& \-f \- check all directories, even if indices are unchanged \& \-p \- mirror perl, ponie, and parrot distributions \& \-\-debug \- run in debug mode (print even banal messages) \& \-q \- run in quiet mode (don\*(Aqt print status) \& \-qq \- run in silent mode (don\*(Aqt even print warnings) \& \-c CLASS \- what class to use to mirror (default: CPAN::Mini) \& \-C FILE \- what config file to use (default: ~/.minicpanrc) \& \-h \- print help and exit \& \-v \- print version and exit \& \-x \- build an exact mirror, getting even normally disallowed files \& \-t SEC \- timeout in sec. Defaults to 180 sec \& \-\-offline \- operate in offline mode (generally: do nothing) \& \-\-log\-level \- provide a log level; instead of \-\-debug, \-q, or \-qq \& \-\-remote\-from TYPE \- cpan remote from \*(Aqcpan\*(Aq or \*(Aqcpanplus\*(Aq configs .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This simple shell script just updates (or creates) a miniature \s-1CPAN\s0 mirror as described in CPAN::Mini. .SH "CONFIGURATION FILE" .IX Header "CONFIGURATION FILE" By default, \f(CW\*(C`minicpan\*(C'\fR will read a configuration file to get configuration information. The file is a simple set of names and values, as in the following example: .PP .Vb 3 \& local: /home/rjbs/mirrors/minicpan/ \& remote: http://your.favorite.cpan/cpan/ \& exact_mirror: 1 .Ve .PP \&\f(CW\*(C`minicpan\*(C'\fR tries to find a configuration file through the following process. It takes the first defined it finds: .IP "\(bu" 4 Use the value specified by \f(CW\*(C`\-C\*(C'\fR on the command line .IP "\(bu" 4 Use the value in the \f(CW\*(C`CPAN_MINI_CONFIG\*(C'\fR environment variable .IP "\(bu" 4 Use \fI~/.minicpanrc\fR .IP "\(bu" 4 Use \fICPAN/Mini/minicpan.conf\fR .PP If the selected file does not exist, \f(CW\*(C`minicpan\*(C'\fR does not keep looking. .PP You can override this process with a \f(CW\*(C`config_file\*(C'\fR method in your subclass. .PP See \f(CW\*(C`CPAN::Mini\*(C'\fR for a full listing of available options. .SH "TO DO" .IX Header "TO DO" Improve command-line options. .SH "SEE ALSO" .IX Header "SEE ALSO" Randal Schwartz's original article, which can be found here: .PP .Vb 1 \& http://www.stonehenge.com/merlyn/LinuxMag/col42.html .Ve .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Ricardo \s-1SIGNES\s0 .IP "\(bu" 4 Randal Schwartz .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2004 by Ricardo \s-1SIGNES.\s0 .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.