diff -r 71503088f51b -r f880f219c566 openpkg/mirror.8 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/openpkg/mirror.8 Tue Jul 31 12:23:42 2012 +0200 @@ -0,0 +1,227 @@ +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22) +.\" +.\" 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" '' +'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. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" 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 "MIRROR 8" +.TH MIRROR 8 "OpenPKG" "MIRROR(8)" "OpenPKG" +.\" 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" +openpkg mirror \- OpenPKG Package Mirroring +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBopenpkg\fR +\&\fBmirror\fR +[\fB\-h\fR] +[\fB\-f\fR] +[\fB\-q\fR] +[\fB\-C\fR \fIlocal-cache-file\fR] +[\fB\-r\fR \fIremote-url\fR] +[\fB\-p\fR \fIremote-url-prefix\fR] +\&\fIlocal-dir-prefix\fR ... +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBopenpkg mirror\fR tool is a frontend for mirroring OpenPKG +repositories, based on the OpenPKG \s-1XML/RDF\s0 index files \fBopenpkg +index \-S \-T \-D\fR creates. The resulting mirror can then be used with +\&\fBopenpkg build\fR. +.SH "COMMAND LINE ARGUMENTS" +.IX Header "COMMAND LINE ARGUMENTS" +The following command line options and arguments exist: +.IP "\fB\-h\fR" 4 +.IX Item "-h" +Print usage help. +.IP "\fB\-f\fR" 4 +.IX Item "-f" +Force deletion of local files, even if more than 30% of the existing +local files have to be removed. +.IP "\fB\-q\fR" 4 +.IX Item "-q" +More quiet operation, i.e., do not print interactive download progress +bars. +.IP "\fB\-C\fR \fIlocal-cache-file\fR" 4 +.IX Item "-C local-cache-file" +Use the text-file \fIlocal-cache-file\fR for caching size/mtime/MD5 +information of local files in order to especially avoid the expensive +re-calculation of \s-1MD5\s0 message digests of local files on every mirror +operation. It is strongly advised to use such a cache. Do \s-1NOT\s0 place +\&\fIlocal-cache-file\fR under \fIlocal-dir-prefix\fR. +.IP "\fB\-r\fR \fIremote-url\fR" 4 +.IX Item "-r remote-url" +The OpenPKG repository \s-1URL\s0. By default the same \s-1URL\s0 as for \fBopenpkg +build\fR is used: \f(CW\*(C`http://download.openpkg.org/stacks/current/source/\*(C'\fR +.IP "\fB\-p\fR \fIremote-url-prefix\fR" 4 +.IX Item "-p remote-url-prefix" +In case the \fIremote-url\fR (option \fB\-r\fR above) points \s-1NOT\s0 to a +root/base directory of the remote repository, it is required to +provide the corresponding base directory \fIremote-url-prefix\fR in +order to allow all remote paths to be correctly mapped to sub-paths +under \fIlocal-dir-prefix\fR. By default \fIremote-url-prefix\fR is +just \fIremote-url\fR. For the public OpenPKG default repository \s-1URL\s0 +\&\f(CW\*(C`http://download.openpkg.org/stacks/current/source/\*(C'\fR the corresponding +\&\fIremote-url-prefix\fR is \f(CW\*(C`http://download.openpkg.org/\*(C'\fR. +.IP "\fIlocal-dir-prefix\fR" 4 +.IX Item "local-dir-prefix" +The local base directory under which the mirror is established. +Content-wise it directly corresponds to \fIremote-url-prefix\fR (option +\&\fB\-p\fR above). +.SH "EXAMPLE" +.IX Header "EXAMPLE" +The following command mirrors the public OpenPKG-CURRENT repository +files from download.openpkg.org to the local directory \fIdownload/\fR. The +prefix specification is important as the OpenPKG-CURRENT stack index +points upwards. +.PP +.Vb 5 +\& $ openpkg mirror \e +\& \-C download.cache \e +\& \-r http://download.openpkg.org/stacks/current/source/ \e +\& \-p http://download.openpkg.org/ \e +\& download/ +.Ve +.PP +The mirror now can be used with \fBopenpkg build\fR: +.PP +.Vb 3 +\& $ openpkg build \e +\& \-r file://\`pwd\`/download/stacks/current/source/ \e +\& \-Uaq | sh +.Ve +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fIindex\fR\|(8). +.SH "HISTORY" +.IX Header "HISTORY" +The \fBopenpkg mirror\fR command was invented in May 2012 by \fIRalf +S. Engelschall\fR for use inside the +\&\fBOpenPKG\fR project . +.SH "AUTHORS" +.IX Header "AUTHORS" +.Vb 3 +\& Ralf S. Engelschall +\& rse@engelschall.com +\& www.engelschall.com +.Ve