OpenPKG Specs: openpkg/mirror.8@a2c6460cfb16

Correct socket error reporting improvement with IPv6 portable code,
after helpful recommendation by Saúl Ibarra Corretgé on OSips devlist.

     1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)

     2 .\"

     3 .\" Standard preamble:

     4 .\" ========================================================================

     5 .de Sp \" Vertical space (when we can't use .PP)

     6 .if t .sp .5v

     7 .if n .sp

     8 ..

     9 .de Vb \" Begin verbatim text

    10 .ft CW

    11 .nf

    12 .ne \\$1

    13 ..

    14 .de Ve \" End verbatim text

    15 .ft R

    16 .fi

    17 ..

    18 .\" Set up some character translations and predefined strings.  \*(-- will

    19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left

    20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will

    21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and

    22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,

    23 .\" nothing in troff, for use with C<>.

    24 .tr \(*W-

    25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'

    26 .ie n \{\

    27 .    ds -- \(*W-

    28 .    ds PI pi

    29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch

    30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch

    31 .    ds L" ""

    32 .    ds R" ""

    33 .    ds C`

    34 .    ds C'

    35 'br\}

    36 .el\{\

    37 .    ds -- \|\(em\|

    38 .    ds PI \(*p

    39 .    ds L" ``

    40 .    ds R" ''

    41 'br\}

    42 .\"

    43 .\" Escape single quotes in literal strings from groff's Unicode transform.

    44 .ie \n(.g .ds Aq \(aq

    45 .el       .ds Aq '

    46 .\"

    47 .\" If the F register is turned on, we'll generate index entries on stderr for

    48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index

    49 .\" entries marked with X<> in POD.  Of course, you'll have to process the

    50 .\" output yourself in some meaningful fashion.

    51 .ie \nF \{\

    52 .    de IX

    53 .    tm Index:\\$1\t\\n%\t"\\$2"

    54 ..

    55 .    nr % 0

    56 .    rr F

    57 .\}

    58 .el \{\

    59 .    de IX

    60 ..

    61 .\}

    62 .\"

    63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).

    64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.

    65 .    \" fudge factors for nroff and troff

    66 .if n \{\

    67 .    ds #H 0

    68 .    ds #V .8m

    69 .    ds #F .3m

    70 .    ds #[ \f1

    71 .    ds #] \fP

    72 .\}

    73 .if t \{\

    74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)

    75 .    ds #V .6m

    76 .    ds #F 0

    77 .    ds #[ \&

    78 .    ds #] \&

    79 .\}

    80 .    \" simple accents for nroff and troff

    81 .if n \{\

    82 .    ds ' \&

    83 .    ds ` \&

    84 .    ds ^ \&

    85 .    ds , \&

    86 .    ds ~ ~

    87 .    ds /

    88 .\}

    89 .if t \{\

    90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"

    91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'

    92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'

    93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'

    94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'

    95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'

    96 .\}

    97 .    \" troff and (daisy-wheel) nroff accents

    98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'

    99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'

   100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]

   101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'

   102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'

   103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]

   104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]

   105 .ds ae a\h'-(\w'a'u*4/10)'e

   106 .ds Ae A\h'-(\w'A'u*4/10)'E

   107 .    \" corrections for vroff

   108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'

   109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'

   110 .    \" for low resolution devices (crt and lpr)

   111 .if \n(.H>23 .if \n(.V>19 \

   112 \{\

   113 .    ds : e

   114 .    ds 8 ss

   115 .    ds o a

   116 .    ds d- d\h'-1'\(ga

   117 .    ds D- D\h'-1'\(hy

   118 .    ds th \o'bp'

   119 .    ds Th \o'LP'

   120 .    ds ae ae

   121 .    ds Ae AE

   122 .\}

   123 .rm #[ #] #H #V #F C

   124 .\" ========================================================================

   125 .\"

   126 .IX Title "MIRROR 8"

   127 .TH MIRROR 8 "OpenPKG" "MIRROR(8)" "OpenPKG"

   128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes

   129 .\" way too many mistakes in technical documents.

   130 .if n .ad l

   131 .nh

   132 .SH "NAME"

   133 openpkg mirror \- OpenPKG Package Mirroring

   134 .SH "SYNOPSIS"

   135 .IX Header "SYNOPSIS"

   136 \&\fBopenpkg\fR

   137 \&\fBmirror\fR

   138 [\fB\-h\fR]

   139 [\fB\-f\fR]

   140 [\fB\-q\fR]

   141 [\fB\-C\fR \fIlocal-cache-file\fR]

   142 [\fB\-r\fR \fIremote-url\fR]

   143 [\fB\-p\fR \fIremote-url-prefix\fR]

   144 \&\fIlocal-dir-prefix\fR ...

   145 .SH "DESCRIPTION"

   146 .IX Header "DESCRIPTION"

   147 The \fBopenpkg mirror\fR tool is a frontend for mirroring OpenPKG

   148 repositories, based on the OpenPKG \s-1XML/RDF\s0 index files \fBopenpkg

   149 index \-S \-T \-D\fR creates. The resulting mirror can then be used with

   150 \&\fBopenpkg build\fR.

   151 .SH "COMMAND LINE ARGUMENTS"

   152 .IX Header "COMMAND LINE ARGUMENTS"

   153 The following command line options and arguments exist:

   154 .IP "\fB\-h\fR" 4

   155 .IX Item "-h"

   156 Print usage help.

   157 .IP "\fB\-f\fR" 4

   158 .IX Item "-f"

   159 Force deletion of local files, even if more than 30% of the existing

   160 local files have to be removed.

   161 .IP "\fB\-q\fR" 4

   162 .IX Item "-q"

   163 More quiet operation, i.e., do not print interactive download progress

   164 bars.

   165 .IP "\fB\-C\fR \fIlocal-cache-file\fR" 4

   166 .IX Item "-C local-cache-file"

   167 Use the text-file \fIlocal-cache-file\fR for caching size/mtime/MD5

   168 information of local files in order to especially avoid the expensive

   169 re-calculation of \s-1MD5\s0 message digests of local files on every mirror

   170 operation. It is strongly advised to use such a cache. Do \s-1NOT\s0 place

   171 \&\fIlocal-cache-file\fR under \fIlocal-dir-prefix\fR.

   172 .IP "\fB\-r\fR \fIremote-url\fR" 4

   173 .IX Item "-r remote-url"

   174 The OpenPKG repository \s-1URL\s0. By default the same \s-1URL\s0 as for \fBopenpkg

   175 build\fR is used: \f(CW\*(C`http://download.openpkg.org/stacks/current/source/\*(C'\fR

   176 .IP "\fB\-p\fR \fIremote-url-prefix\fR" 4

   177 .IX Item "-p remote-url-prefix"

   178 In case the \fIremote-url\fR (option \fB\-r\fR above) points \s-1NOT\s0 to a

   179 root/base directory of the remote repository, it is required to

   180 provide the corresponding base directory \fIremote-url-prefix\fR in

   181 order to allow all remote paths to be correctly mapped to sub-paths

   182 under \fIlocal-dir-prefix\fR. By default \fIremote-url-prefix\fR is

   183 just \fIremote-url\fR. For the public OpenPKG default repository \s-1URL\s0

   184 \&\f(CW\*(C`http://download.openpkg.org/stacks/current/source/\*(C'\fR the corresponding

   185 \&\fIremote-url-prefix\fR is \f(CW\*(C`http://download.openpkg.org/\*(C'\fR.

   186 .IP "\fIlocal-dir-prefix\fR" 4

   187 .IX Item "local-dir-prefix"

   188 The local base directory under which the mirror is established.

   189 Content-wise it directly corresponds to \fIremote-url-prefix\fR (option

   190 \&\fB\-p\fR above).

   191 .SH "EXAMPLE"

   192 .IX Header "EXAMPLE"

   193 The following command mirrors the public OpenPKG-CURRENT repository

   194 files from download.openpkg.org to the local directory \fIdownload/\fR. The

   195 prefix specification is important as the OpenPKG-CURRENT stack index

   196 points upwards.

   197 .PP

   198 .Vb 5

   199 \& $ openpkg mirror \e

   200 \&   \-C download.cache \e

   201 \&   \-r http://download.openpkg.org/stacks/current/source/ \e

   202 \&   \-p http://download.openpkg.org/ \e

   203 \&   download/

   204 .Ve

   205 .PP

   206 The mirror now can be used with \fBopenpkg build\fR:

   207 .PP

   208 .Vb 3

   209 \& $ openpkg build \e

   210 \&   \-r file://\`pwd\`/download/stacks/current/source/ \e

   211 \&   \-Uaq | sh

   212 .Ve

   213 .SH "SEE ALSO"

   214 .IX Header "SEE ALSO"

   215 \&\fIindex\fR\|(8).

   216 .SH "HISTORY"

   217 .IX Header "HISTORY"

   218 The \fBopenpkg mirror\fR command was invented in May 2012 by \fIRalf

   219 S.  Engelschall\fR <rse@engelschall.com> for use inside the

   220 \&\fBOpenPKG\fR project <http://www.openpkg.org/>.

   221 .SH "AUTHORS"

   222 .IX Header "AUTHORS"

   223 .Vb 3

   224 \& Ralf S. Engelschall

   225 \& rse@engelschall.com

   226 \& www.engelschall.com

   227 .Ve

OpenPKG Specs / file revision

openpkg/mirror.8@a2c6460cfb16

openpkg/mirror.8