openpkg/release.8

Mon, 28 Jan 2013 17:37:18 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Mon, 28 Jan 2013 17:37:18 +0100
changeset 758
a2c6460cfb16
parent 13
cb59d6afeb61
permissions
-rw-r--r--

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

michael@428 1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
michael@13 2 .\"
michael@13 3 .\" Standard preamble:
michael@13 4 .\" ========================================================================
michael@13 5 .de Sp \" Vertical space (when we can't use .PP)
michael@13 6 .if t .sp .5v
michael@13 7 .if n .sp
michael@13 8 ..
michael@13 9 .de Vb \" Begin verbatim text
michael@13 10 .ft CW
michael@13 11 .nf
michael@13 12 .ne \\$1
michael@13 13 ..
michael@13 14 .de Ve \" End verbatim text
michael@13 15 .ft R
michael@13 16 .fi
michael@13 17 ..
michael@13 18 .\" Set up some character translations and predefined strings. \*(-- will
michael@13 19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
michael@428 20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
michael@428 21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
michael@428 22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
michael@428 23 .\" nothing in troff, for use with C<>.
michael@428 24 .tr \(*W-
michael@13 25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
michael@13 26 .ie n \{\
michael@13 27 . ds -- \(*W-
michael@13 28 . ds PI pi
michael@13 29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
michael@13 30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
michael@13 31 . ds L" ""
michael@13 32 . ds R" ""
michael@13 33 . ds C`
michael@13 34 . ds C'
michael@13 35 'br\}
michael@13 36 .el\{\
michael@13 37 . ds -- \|\(em\|
michael@13 38 . ds PI \(*p
michael@13 39 . ds L" ``
michael@13 40 . ds R" ''
michael@13 41 'br\}
michael@13 42 .\"
michael@428 43 .\" Escape single quotes in literal strings from groff's Unicode transform.
michael@428 44 .ie \n(.g .ds Aq \(aq
michael@428 45 .el .ds Aq '
michael@428 46 .\"
michael@13 47 .\" If the F register is turned on, we'll generate index entries on stderr for
michael@428 48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
michael@13 49 .\" entries marked with X<> in POD. Of course, you'll have to process the
michael@13 50 .\" output yourself in some meaningful fashion.
michael@428 51 .ie \nF \{\
michael@13 52 . de IX
michael@13 53 . tm Index:\\$1\t\\n%\t"\\$2"
michael@13 54 ..
michael@13 55 . nr % 0
michael@13 56 . rr F
michael@13 57 .\}
michael@428 58 .el \{\
michael@428 59 . de IX
michael@428 60 ..
michael@428 61 .\}
michael@13 62 .\"
michael@13 63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
michael@13 64 .\" Fear. Run. Save yourself. No user-serviceable parts.
michael@13 65 . \" fudge factors for nroff and troff
michael@13 66 .if n \{\
michael@13 67 . ds #H 0
michael@13 68 . ds #V .8m
michael@13 69 . ds #F .3m
michael@13 70 . ds #[ \f1
michael@13 71 . ds #] \fP
michael@13 72 .\}
michael@13 73 .if t \{\
michael@13 74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
michael@13 75 . ds #V .6m
michael@13 76 . ds #F 0
michael@13 77 . ds #[ \&
michael@13 78 . ds #] \&
michael@13 79 .\}
michael@13 80 . \" simple accents for nroff and troff
michael@13 81 .if n \{\
michael@13 82 . ds ' \&
michael@13 83 . ds ` \&
michael@13 84 . ds ^ \&
michael@13 85 . ds , \&
michael@13 86 . ds ~ ~
michael@13 87 . ds /
michael@13 88 .\}
michael@13 89 .if t \{\
michael@13 90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
michael@13 91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
michael@13 92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
michael@13 93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
michael@13 94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
michael@13 95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
michael@13 96 .\}
michael@13 97 . \" troff and (daisy-wheel) nroff accents
michael@13 98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
michael@13 99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
michael@13 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
michael@13 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
michael@13 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
michael@13 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
michael@13 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
michael@13 105 .ds ae a\h'-(\w'a'u*4/10)'e
michael@13 106 .ds Ae A\h'-(\w'A'u*4/10)'E
michael@13 107 . \" corrections for vroff
michael@13 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
michael@13 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
michael@13 110 . \" for low resolution devices (crt and lpr)
michael@13 111 .if \n(.H>23 .if \n(.V>19 \
michael@13 112 \{\
michael@13 113 . ds : e
michael@13 114 . ds 8 ss
michael@13 115 . ds o a
michael@13 116 . ds d- d\h'-1'\(ga
michael@13 117 . ds D- D\h'-1'\(hy
michael@13 118 . ds th \o'bp'
michael@13 119 . ds Th \o'LP'
michael@13 120 . ds ae ae
michael@13 121 . ds Ae AE
michael@13 122 .\}
michael@13 123 .rm #[ #] #H #V #F C
michael@13 124 .\" ========================================================================
michael@13 125 .\"
michael@13 126 .IX Title "RELEASE 8"
michael@13 127 .TH RELEASE 8 "OpenPKG" "RELEASE(8)" "OpenPKG"
michael@428 128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
michael@428 129 .\" way too many mistakes in technical documents.
michael@428 130 .if n .ad l
michael@428 131 .nh
michael@13 132 .SH "NAME"
michael@428 133 openpkg release \- OpenPKG Release Utility
michael@13 134 .SH "SYNOPSIS"
michael@13 135 .IX Header "SYNOPSIS"
michael@13 136 \&\fBopenpkg release\fR [\fB\-F\fR|\fB\-\-fmt\fR \fIformat\fR]
michael@13 137 .SH "DESCRIPTION"
michael@13 138 .IX Header "DESCRIPTION"
michael@13 139 The \fBopenpkg release\fR command displays the OpenPKG release tag and
michael@13 140 distribution \s-1URL\s0. The release tag uniquely identifies an OpenPKG
michael@13 141 distribution and the distribution \s-1URL\s0 is the location where the
michael@13 142 distribution packages and indices are stored.
michael@13 143 .SH "OPTIONS"
michael@13 144 .IX Header "OPTIONS"
michael@13 145 .IP "\fB\-F\fR, \fB\-\-fmt\fR \fIformat\fR" 4
michael@13 146 .IX Item "-F, --fmt format"
michael@13 147 The output format specification. The argument \fIformat\fR is an arbitrary
michael@13 148 string which can contain the special expansion constructs "\f(CW%t\fR\*(L" for
michael@13 149 expanding the release tag, \*(R"\f(CW%u\fR\*(L" for expanding the distribution \s-1URL\s0
michael@428 150 and \*(R"\f(CW\*(C`\en\*(C'\fR" for expanding an embedded newline character.
michael@13 151 The instance \s-1UUID\s0 information is also availble by expanding
michael@13 152 \&\f(CW%r\fR to \s-1UUID_REGISTRY\s0, \f(CW%i\fR to \s-1UUID_INSTANCE\s0, \f(CW%p\fR to \s-1UUID_PLATFORM\s0.
michael@13 153 The default \fIformat\fR is "\f(CW\*(C`OpenPKG\-%t %u\*(C'\fR".
michael@13 154 .IP "\fB\-r\fR, \fB\-\-release\fR \fIrelease\fR" 4
michael@13 155 .IX Item "-r, --release release"
michael@13 156 The package "\f(CW\*(C`Release\*(C'\fR" header value to use for deriving the release
michael@428 157 tag. The values in the \fI\f(CI@l_prefix\fI@/etc/openpkg/release\fR file and the
michael@13 158 "\f(CW\*(C`Release\*(C'\fR" header of the bootstrap package \fBopenpkg\fR are ignored if
michael@13 159 this option is used.
michael@13 160 .SH "FILES"
michael@13 161 .IX Header "FILES"
michael@428 162 .ie n .IP "\fI\fI@l_prefix\fI@/etc/openpkg/release\fR" 4
michael@428 163 .el .IP "\fI\f(CI@l_prefix\fI@/etc/openpkg/release\fR" 4
michael@13 164 .IX Item "@l_prefix@/etc/openpkg/release"
michael@13 165 This optional configuration file can be used to explicitly set values
michael@13 166 for the OpenPKG release tag and distribution URLs. It consists of lines
michael@13 167 with variable name/value pairs. The following configuration variables
michael@13 168 are recognized:
michael@13 169 .RS 4
michael@13 170 .IP "\fBTAG=\fR\fItag\fR" 4
michael@13 171 .IX Item "TAG=tag"
michael@13 172 The default \fItag\fR is automatically derived from the "\f(CW\*(C`Version\*(C'\fR" header
michael@13 173 of the OpenPKG bootstrap package \fBopenpkg\fR. One usually only sets this
michael@13 174 explicitly to a value if a bootstrap package is used from a foreign
michael@13 175 distribution version.
michael@13 176 .IP "\fBURL=\fR\fIurl\fR" 4
michael@13 177 .IX Item "URL=url"
michael@13 178 The fully-qualified distribution \s-1URL\s0 based on either the "\f(CW\*(C`ftp\*(C'\fR\*(L",
michael@13 179 \&\*(R"\f(CW\*(C`http\*(C'\fR\*(L" or \*(R"\f(CW\*(C`file\*(C'\fR" \s-1URL\s0 schemes. If \fIurl\fR contains a trailing
michael@13 180 "\f(CW\*(C`/*\*(C'\fR", this is expanded according to the \fItag\fR value of the \fB\s-1TAG\s0\fR
michael@428 181 variable and the corresponding filesystem layout on \f(CW\*(C`download.openpkg.org\*(C'\fR.
michael@428 182 The default \fIurl\fR is "\f(CW\*(C`http://download.openpkg.org/stacks/*\*(C'\fR".
michael@428 183 .RE
michael@13 184 .RS 4
michael@13 185 .RE
michael@13 186 .SH "EXAMPLE"
michael@13 187 .IX Header "EXAMPLE"
michael@13 188 .Vb 2
michael@13 189 \& $ openpkg release
michael@428 190 \& OpenPKG\-CURRENT http://download.openpkg.org/stacks/current/
michael@428 191 \&
michael@428 192 \& $ openpkg release \-\-fmt=%t
michael@13 193 \& CURRENT
michael@428 194 \&
michael@428 195 \& $ openpkg release \-\-fmt=%u
michael@428 196 \& http://download.openpkg.org/stacks/current/
michael@428 197 \&
michael@428 198 \& $ openpkg release \-\-fmt="OpenPKG %t is located at:\e\en%u"
michael@13 199 \& OpenPKG CURRENT is located at:
michael@428 200 \& http://download.openpkg.org/stacks/current/
michael@428 201 \&
michael@428 202 \& $ openpkg release \-\-release=2.5.4 \-\-fmt=%t
michael@428 203 \& 2.5\-RELEASE
michael@428 204 \&
michael@13 205 \& $ cat /openpkg/etc/openpkg/release
michael@428 206 \& TAG=CURRENT
michael@428 207 \& URL=http://download.example.com/stack/current/
michael@13 208 .Ve
michael@13 209 .SH "SEE ALSO"
michael@13 210 .IX Header "SEE ALSO"
michael@13 211 \&\fIuuid\fR\|(8)
michael@13 212 .SH "HISTORY"
michael@13 213 .IX Header "HISTORY"
michael@13 214 The \fBopenpkg release\fR command first appeared in \fBOpenPKG 2\-STABLE\-20060622\fR.

mercurial