michael@428: .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
michael@428: .\"
michael@428: .\" Standard preamble:
michael@428: .\" ========================================================================
michael@428: .de Sp \" Vertical space (when we can't use .PP)
michael@428: .if t .sp .5v
michael@428: .if n .sp
michael@428: ..
michael@428: .de Vb \" Begin verbatim text
michael@428: .ft CW
michael@428: .nf
michael@428: .ne \\$1
michael@428: ..
michael@428: .de Ve \" End verbatim text
michael@428: .ft R
michael@428: .fi
michael@428: ..
michael@428: .\" Set up some character translations and predefined strings.  \*(-- will
michael@428: .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
michael@428: .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
michael@428: .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
michael@428: .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
michael@428: .\" nothing in troff, for use with C<>.
michael@428: .tr \(*W-
michael@428: .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
michael@428: .ie n \{\
michael@428: .    ds -- \(*W-
michael@428: .    ds PI pi
michael@428: .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
michael@428: .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
michael@428: .    ds L" ""
michael@428: .    ds R" ""
michael@428: .    ds C` 
michael@428: .    ds C' 
michael@428: 'br\}
michael@428: .el\{\
michael@428: .    ds -- \|\(em\|
michael@428: .    ds PI \(*p
michael@428: .    ds L" ``
michael@428: .    ds R" ''
michael@428: 'br\}
michael@428: .\"
michael@428: .\" Escape single quotes in literal strings from groff's Unicode transform.
michael@428: .ie \n(.g .ds Aq \(aq
michael@428: .el       .ds Aq '
michael@428: .\"
michael@428: .\" If the F register is turned on, we'll generate index entries on stderr for
michael@428: .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
michael@428: .\" entries marked with X<> in POD.  Of course, you'll have to process the
michael@428: .\" output yourself in some meaningful fashion.
michael@428: .ie \nF \{\
michael@428: .    de IX
michael@428: .    tm Index:\\$1\t\\n%\t"\\$2"
michael@428: ..
michael@428: .    nr % 0
michael@428: .    rr F
michael@428: .\}
michael@428: .el \{\
michael@428: .    de IX
michael@428: ..
michael@428: .\}
michael@428: .\"
michael@428: .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
michael@428: .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
michael@428: .    \" fudge factors for nroff and troff
michael@428: .if n \{\
michael@428: .    ds #H 0
michael@428: .    ds #V .8m
michael@428: .    ds #F .3m
michael@428: .    ds #[ \f1
michael@428: .    ds #] \fP
michael@428: .\}
michael@428: .if t \{\
michael@428: .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
michael@428: .    ds #V .6m
michael@428: .    ds #F 0
michael@428: .    ds #[ \&
michael@428: .    ds #] \&
michael@428: .\}
michael@428: .    \" simple accents for nroff and troff
michael@428: .if n \{\
michael@428: .    ds ' \&
michael@428: .    ds ` \&
michael@428: .    ds ^ \&
michael@428: .    ds , \&
michael@428: .    ds ~ ~
michael@428: .    ds /
michael@428: .\}
michael@428: .if t \{\
michael@428: .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
michael@428: .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
michael@428: .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
michael@428: .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
michael@428: .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
michael@428: .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
michael@428: .\}
michael@428: .    \" troff and (daisy-wheel) nroff accents
michael@428: .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
michael@428: .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
michael@428: .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
michael@428: .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
michael@428: .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
michael@428: .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
michael@428: .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
michael@428: .ds ae a\h'-(\w'a'u*4/10)'e
michael@428: .ds Ae A\h'-(\w'A'u*4/10)'E
michael@428: .    \" corrections for vroff
michael@428: .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
michael@428: .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
michael@428: .    \" for low resolution devices (crt and lpr)
michael@428: .if \n(.H>23 .if \n(.V>19 \
michael@428: \{\
michael@428: .    ds : e
michael@428: .    ds 8 ss
michael@428: .    ds o a
michael@428: .    ds d- d\h'-1'\(ga
michael@428: .    ds D- D\h'-1'\(hy
michael@428: .    ds th \o'bp'
michael@428: .    ds Th \o'LP'
michael@428: .    ds ae ae
michael@428: .    ds Ae AE
michael@428: .\}
michael@428: .rm #[ #] #H #V #F C
michael@428: .\" ========================================================================
michael@428: .\"
michael@428: .IX Title "MIRROR 8"
michael@428: .TH MIRROR 8 "OpenPKG" "MIRROR(8)" "OpenPKG"
michael@428: .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
michael@428: .\" way too many mistakes in technical documents.
michael@428: .if n .ad l
michael@428: .nh
michael@428: .SH "NAME"
michael@428: openpkg mirror \- OpenPKG Package Mirroring
michael@428: .SH "SYNOPSIS"
michael@428: .IX Header "SYNOPSIS"
michael@428: \&\fBopenpkg\fR
michael@428: \&\fBmirror\fR
michael@428: [\fB\-h\fR]
michael@428: [\fB\-f\fR]
michael@428: [\fB\-q\fR]
michael@428: [\fB\-C\fR \fIlocal-cache-file\fR]
michael@428: [\fB\-r\fR \fIremote-url\fR]
michael@428: [\fB\-p\fR \fIremote-url-prefix\fR]
michael@428: \&\fIlocal-dir-prefix\fR ...
michael@428: .SH "DESCRIPTION"
michael@428: .IX Header "DESCRIPTION"
michael@428: The \fBopenpkg mirror\fR tool is a frontend for mirroring OpenPKG
michael@428: repositories, based on the OpenPKG \s-1XML/RDF\s0 index files \fBopenpkg
michael@428: index \-S \-T \-D\fR creates. The resulting mirror can then be used with
michael@428: \&\fBopenpkg build\fR.
michael@428: .SH "COMMAND LINE ARGUMENTS"
michael@428: .IX Header "COMMAND LINE ARGUMENTS"
michael@428: The following command line options and arguments exist:
michael@428: .IP "\fB\-h\fR" 4
michael@428: .IX Item "-h"
michael@428: Print usage help.
michael@428: .IP "\fB\-f\fR" 4
michael@428: .IX Item "-f"
michael@428: Force deletion of local files, even if more than 30% of the existing
michael@428: local files have to be removed.
michael@428: .IP "\fB\-q\fR" 4
michael@428: .IX Item "-q"
michael@428: More quiet operation, i.e., do not print interactive download progress
michael@428: bars.
michael@428: .IP "\fB\-C\fR \fIlocal-cache-file\fR" 4
michael@428: .IX Item "-C local-cache-file"
michael@428: Use the text-file \fIlocal-cache-file\fR for caching size/mtime/MD5
michael@428: information of local files in order to especially avoid the expensive
michael@428: re-calculation of \s-1MD5\s0 message digests of local files on every mirror
michael@428: operation. It is strongly advised to use such a cache. Do \s-1NOT\s0 place
michael@428: \&\fIlocal-cache-file\fR under \fIlocal-dir-prefix\fR.
michael@428: .IP "\fB\-r\fR \fIremote-url\fR" 4
michael@428: .IX Item "-r remote-url"
michael@428: The OpenPKG repository \s-1URL\s0. By default the same \s-1URL\s0 as for \fBopenpkg
michael@428: build\fR is used: \f(CW\*(C`http://download.openpkg.org/stacks/current/source/\*(C'\fR
michael@428: .IP "\fB\-p\fR \fIremote-url-prefix\fR" 4
michael@428: .IX Item "-p remote-url-prefix"
michael@428: In case the \fIremote-url\fR (option \fB\-r\fR above) points \s-1NOT\s0 to a
michael@428: root/base directory of the remote repository, it is required to
michael@428: provide the corresponding base directory \fIremote-url-prefix\fR in
michael@428: order to allow all remote paths to be correctly mapped to sub-paths
michael@428: under \fIlocal-dir-prefix\fR. By default \fIremote-url-prefix\fR is
michael@428: just \fIremote-url\fR. For the public OpenPKG default repository \s-1URL\s0
michael@428: \&\f(CW\*(C`http://download.openpkg.org/stacks/current/source/\*(C'\fR the corresponding
michael@428: \&\fIremote-url-prefix\fR is \f(CW\*(C`http://download.openpkg.org/\*(C'\fR.
michael@428: .IP "\fIlocal-dir-prefix\fR" 4
michael@428: .IX Item "local-dir-prefix"
michael@428: The local base directory under which the mirror is established.
michael@428: Content-wise it directly corresponds to \fIremote-url-prefix\fR (option
michael@428: \&\fB\-p\fR above).
michael@428: .SH "EXAMPLE"
michael@428: .IX Header "EXAMPLE"
michael@428: The following command mirrors the public OpenPKG-CURRENT repository
michael@428: files from download.openpkg.org to the local directory \fIdownload/\fR. The
michael@428: prefix specification is important as the OpenPKG-CURRENT stack index
michael@428: points upwards.
michael@428: .PP
michael@428: .Vb 5
michael@428: \& $ openpkg mirror \e
michael@428: \&   \-C download.cache \e
michael@428: \&   \-r http://download.openpkg.org/stacks/current/source/ \e
michael@428: \&   \-p http://download.openpkg.org/ \e
michael@428: \&   download/
michael@428: .Ve
michael@428: .PP
michael@428: The mirror now can be used with \fBopenpkg build\fR:
michael@428: .PP
michael@428: .Vb 3
michael@428: \& $ openpkg build \e
michael@428: \&   \-r file://\`pwd\`/download/stacks/current/source/ \e
michael@428: \&   \-Uaq | sh
michael@428: .Ve
michael@428: .SH "SEE ALSO"
michael@428: .IX Header "SEE ALSO"
michael@428: \&\fIindex\fR\|(8).
michael@428: .SH "HISTORY"
michael@428: .IX Header "HISTORY"
michael@428: The \fBopenpkg mirror\fR command was invented in May 2012 by \fIRalf
michael@428: S.  Engelschall\fR <rse@engelschall.com> for use inside the
michael@428: \&\fBOpenPKG\fR project <http://www.openpkg.org/>.
michael@428: .SH "AUTHORS"
michael@428: .IX Header "AUTHORS"
michael@428: .Vb 3
michael@428: \& Ralf S. Engelschall
michael@428: \& rse@engelschall.com
michael@428: \& www.engelschall.com
michael@428: .Ve