1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/openpkg/mirror.8 Tue Jul 31 12:23:42 2012 +0200
1.3 @@ -0,0 +1,227 @@
1.4 +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
1.5 +.\"
1.6 +.\" Standard preamble:
1.7 +.\" ========================================================================
1.8 +.de Sp \" Vertical space (when we can't use .PP)
1.9 +.if t .sp .5v
1.10 +.if n .sp
1.11 +..
1.12 +.de Vb \" Begin verbatim text
1.13 +.ft CW
1.14 +.nf
1.15 +.ne \\$1
1.16 +..
1.17 +.de Ve \" End verbatim text
1.18 +.ft R
1.19 +.fi
1.20 +..
1.21 +.\" Set up some character translations and predefined strings. \*(-- will
1.22 +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
1.23 +.\" double quote, and \*(R" will give a right double quote. \*(C+ will
1.24 +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
1.25 +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
1.26 +.\" nothing in troff, for use with C<>.
1.27 +.tr \(*W-
1.28 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
1.29 +.ie n \{\
1.30 +. ds -- \(*W-
1.31 +. ds PI pi
1.32 +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
1.33 +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
1.34 +. ds L" ""
1.35 +. ds R" ""
1.36 +. ds C`
1.37 +. ds C'
1.38 +'br\}
1.39 +.el\{\
1.40 +. ds -- \|\(em\|
1.41 +. ds PI \(*p
1.42 +. ds L" ``
1.43 +. ds R" ''
1.44 +'br\}
1.45 +.\"
1.46 +.\" Escape single quotes in literal strings from groff's Unicode transform.
1.47 +.ie \n(.g .ds Aq \(aq
1.48 +.el .ds Aq '
1.49 +.\"
1.50 +.\" If the F register is turned on, we'll generate index entries on stderr for
1.51 +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
1.52 +.\" entries marked with X<> in POD. Of course, you'll have to process the
1.53 +.\" output yourself in some meaningful fashion.
1.54 +.ie \nF \{\
1.55 +. de IX
1.56 +. tm Index:\\$1\t\\n%\t"\\$2"
1.57 +..
1.58 +. nr % 0
1.59 +. rr F
1.60 +.\}
1.61 +.el \{\
1.62 +. de IX
1.63 +..
1.64 +.\}
1.65 +.\"
1.66 +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
1.67 +.\" Fear. Run. Save yourself. No user-serviceable parts.
1.68 +. \" fudge factors for nroff and troff
1.69 +.if n \{\
1.70 +. ds #H 0
1.71 +. ds #V .8m
1.72 +. ds #F .3m
1.73 +. ds #[ \f1
1.74 +. ds #] \fP
1.75 +.\}
1.76 +.if t \{\
1.77 +. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
1.78 +. ds #V .6m
1.79 +. ds #F 0
1.80 +. ds #[ \&
1.81 +. ds #] \&
1.82 +.\}
1.83 +. \" simple accents for nroff and troff
1.84 +.if n \{\
1.85 +. ds ' \&
1.86 +. ds ` \&
1.87 +. ds ^ \&
1.88 +. ds , \&
1.89 +. ds ~ ~
1.90 +. ds /
1.91 +.\}
1.92 +.if t \{\
1.93 +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
1.94 +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
1.95 +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
1.96 +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
1.97 +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
1.98 +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
1.99 +.\}
1.100 +. \" troff and (daisy-wheel) nroff accents
1.101 +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
1.102 +.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
1.103 +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
1.104 +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
1.105 +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
1.106 +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
1.107 +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
1.108 +.ds ae a\h'-(\w'a'u*4/10)'e
1.109 +.ds Ae A\h'-(\w'A'u*4/10)'E
1.110 +. \" corrections for vroff
1.111 +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
1.112 +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
1.113 +. \" for low resolution devices (crt and lpr)
1.114 +.if \n(.H>23 .if \n(.V>19 \
1.115 +\{\
1.116 +. ds : e
1.117 +. ds 8 ss
1.118 +. ds o a
1.119 +. ds d- d\h'-1'\(ga
1.120 +. ds D- D\h'-1'\(hy
1.121 +. ds th \o'bp'
1.122 +. ds Th \o'LP'
1.123 +. ds ae ae
1.124 +. ds Ae AE
1.125 +.\}
1.126 +.rm #[ #] #H #V #F C
1.127 +.\" ========================================================================
1.128 +.\"
1.129 +.IX Title "MIRROR 8"
1.130 +.TH MIRROR 8 "OpenPKG" "MIRROR(8)" "OpenPKG"
1.131 +.\" For nroff, turn off justification. Always turn off hyphenation; it makes
1.132 +.\" way too many mistakes in technical documents.
1.133 +.if n .ad l
1.134 +.nh
1.135 +.SH "NAME"
1.136 +openpkg mirror \- OpenPKG Package Mirroring
1.137 +.SH "SYNOPSIS"
1.138 +.IX Header "SYNOPSIS"
1.139 +\&\fBopenpkg\fR
1.140 +\&\fBmirror\fR
1.141 +[\fB\-h\fR]
1.142 +[\fB\-f\fR]
1.143 +[\fB\-q\fR]
1.144 +[\fB\-C\fR \fIlocal-cache-file\fR]
1.145 +[\fB\-r\fR \fIremote-url\fR]
1.146 +[\fB\-p\fR \fIremote-url-prefix\fR]
1.147 +\&\fIlocal-dir-prefix\fR ...
1.148 +.SH "DESCRIPTION"
1.149 +.IX Header "DESCRIPTION"
1.150 +The \fBopenpkg mirror\fR tool is a frontend for mirroring OpenPKG
1.151 +repositories, based on the OpenPKG \s-1XML/RDF\s0 index files \fBopenpkg
1.152 +index \-S \-T \-D\fR creates. The resulting mirror can then be used with
1.153 +\&\fBopenpkg build\fR.
1.154 +.SH "COMMAND LINE ARGUMENTS"
1.155 +.IX Header "COMMAND LINE ARGUMENTS"
1.156 +The following command line options and arguments exist:
1.157 +.IP "\fB\-h\fR" 4
1.158 +.IX Item "-h"
1.159 +Print usage help.
1.160 +.IP "\fB\-f\fR" 4
1.161 +.IX Item "-f"
1.162 +Force deletion of local files, even if more than 30% of the existing
1.163 +local files have to be removed.
1.164 +.IP "\fB\-q\fR" 4
1.165 +.IX Item "-q"
1.166 +More quiet operation, i.e., do not print interactive download progress
1.167 +bars.
1.168 +.IP "\fB\-C\fR \fIlocal-cache-file\fR" 4
1.169 +.IX Item "-C local-cache-file"
1.170 +Use the text-file \fIlocal-cache-file\fR for caching size/mtime/MD5
1.171 +information of local files in order to especially avoid the expensive
1.172 +re-calculation of \s-1MD5\s0 message digests of local files on every mirror
1.173 +operation. It is strongly advised to use such a cache. Do \s-1NOT\s0 place
1.174 +\&\fIlocal-cache-file\fR under \fIlocal-dir-prefix\fR.
1.175 +.IP "\fB\-r\fR \fIremote-url\fR" 4
1.176 +.IX Item "-r remote-url"
1.177 +The OpenPKG repository \s-1URL\s0. By default the same \s-1URL\s0 as for \fBopenpkg
1.178 +build\fR is used: \f(CW\*(C`http://download.openpkg.org/stacks/current/source/\*(C'\fR
1.179 +.IP "\fB\-p\fR \fIremote-url-prefix\fR" 4
1.180 +.IX Item "-p remote-url-prefix"
1.181 +In case the \fIremote-url\fR (option \fB\-r\fR above) points \s-1NOT\s0 to a
1.182 +root/base directory of the remote repository, it is required to
1.183 +provide the corresponding base directory \fIremote-url-prefix\fR in
1.184 +order to allow all remote paths to be correctly mapped to sub-paths
1.185 +under \fIlocal-dir-prefix\fR. By default \fIremote-url-prefix\fR is
1.186 +just \fIremote-url\fR. For the public OpenPKG default repository \s-1URL\s0
1.187 +\&\f(CW\*(C`http://download.openpkg.org/stacks/current/source/\*(C'\fR the corresponding
1.188 +\&\fIremote-url-prefix\fR is \f(CW\*(C`http://download.openpkg.org/\*(C'\fR.
1.189 +.IP "\fIlocal-dir-prefix\fR" 4
1.190 +.IX Item "local-dir-prefix"
1.191 +The local base directory under which the mirror is established.
1.192 +Content-wise it directly corresponds to \fIremote-url-prefix\fR (option
1.193 +\&\fB\-p\fR above).
1.194 +.SH "EXAMPLE"
1.195 +.IX Header "EXAMPLE"
1.196 +The following command mirrors the public OpenPKG-CURRENT repository
1.197 +files from download.openpkg.org to the local directory \fIdownload/\fR. The
1.198 +prefix specification is important as the OpenPKG-CURRENT stack index
1.199 +points upwards.
1.200 +.PP
1.201 +.Vb 5
1.202 +\& $ openpkg mirror \e
1.203 +\& \-C download.cache \e
1.204 +\& \-r http://download.openpkg.org/stacks/current/source/ \e
1.205 +\& \-p http://download.openpkg.org/ \e
1.206 +\& download/
1.207 +.Ve
1.208 +.PP
1.209 +The mirror now can be used with \fBopenpkg build\fR:
1.210 +.PP
1.211 +.Vb 3
1.212 +\& $ openpkg build \e
1.213 +\& \-r file://\`pwd\`/download/stacks/current/source/ \e
1.214 +\& \-Uaq | sh
1.215 +.Ve
1.216 +.SH "SEE ALSO"
1.217 +.IX Header "SEE ALSO"
1.218 +\&\fIindex\fR\|(8).
1.219 +.SH "HISTORY"
1.220 +.IX Header "HISTORY"
1.221 +The \fBopenpkg mirror\fR command was invented in May 2012 by \fIRalf
1.222 +S. Engelschall\fR <rse@engelschall.com> for use inside the
1.223 +\&\fBOpenPKG\fR project <http://www.openpkg.org/>.
1.224 +.SH "AUTHORS"
1.225 +.IX Header "AUTHORS"
1.226 +.Vb 3
1.227 +\& Ralf S. Engelschall
1.228 +\& rse@engelschall.com
1.229 +\& www.engelschall.com
1.230 +.Ve
