1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/openpkg/release.8 Tue Jan 06 23:40:39 2009 +0100
1.3 @@ -0,0 +1,224 @@
1.4 +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
1.5 +.\"
1.6 +.\" Standard preamble:
1.7 +.\" ========================================================================
1.8 +.de Sh \" Subsection heading
1.9 +.br
1.10 +.if t .Sp
1.11 +.ne 5
1.12 +.PP
1.13 +\fB\\$1\fR
1.14 +.PP
1.15 +..
1.16 +.de Sp \" Vertical space (when we can't use .PP)
1.17 +.if t .sp .5v
1.18 +.if n .sp
1.19 +..
1.20 +.de Vb \" Begin verbatim text
1.21 +.ft CW
1.22 +.nf
1.23 +.ne \\$1
1.24 +..
1.25 +.de Ve \" End verbatim text
1.26 +.ft R
1.27 +.fi
1.28 +..
1.29 +.\" Set up some character translations and predefined strings. \*(-- will
1.30 +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
1.31 +.\" double quote, and \*(R" will give a right double quote. | will give a
1.32 +.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
1.33 +.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
1.34 +.\" expand to `' in nroff, nothing in troff, for use with C<>.
1.35 +.tr \(*W-|\(bv\*(Tr
1.36 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
1.37 +.ie n \{\
1.38 +. ds -- \(*W-
1.39 +. ds PI pi
1.40 +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
1.41 +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
1.42 +. ds L" ""
1.43 +. ds R" ""
1.44 +. ds C`
1.45 +. ds C'
1.46 +'br\}
1.47 +.el\{\
1.48 +. ds -- \|\(em\|
1.49 +. ds PI \(*p
1.50 +. ds L" ``
1.51 +. ds R" ''
1.52 +'br\}
1.53 +.\"
1.54 +.\" If the F register is turned on, we'll generate index entries on stderr for
1.55 +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
1.56 +.\" entries marked with X<> in POD. Of course, you'll have to process the
1.57 +.\" output yourself in some meaningful fashion.
1.58 +.if \nF \{\
1.59 +. de IX
1.60 +. tm Index:\\$1\t\\n%\t"\\$2"
1.61 +..
1.62 +. nr % 0
1.63 +. rr F
1.64 +.\}
1.65 +.\"
1.66 +.\" For nroff, turn off justification. Always turn off hyphenation; it makes
1.67 +.\" way too many mistakes in technical documents.
1.68 +.hy 0
1.69 +.if n .na
1.70 +.\"
1.71 +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
1.72 +.\" Fear. Run. Save yourself. No user-serviceable parts.
1.73 +. \" fudge factors for nroff and troff
1.74 +.if n \{\
1.75 +. ds #H 0
1.76 +. ds #V .8m
1.77 +. ds #F .3m
1.78 +. ds #[ \f1
1.79 +. ds #] \fP
1.80 +.\}
1.81 +.if t \{\
1.82 +. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
1.83 +. ds #V .6m
1.84 +. ds #F 0
1.85 +. ds #[ \&
1.86 +. ds #] \&
1.87 +.\}
1.88 +. \" simple accents for nroff and troff
1.89 +.if n \{\
1.90 +. ds ' \&
1.91 +. ds ` \&
1.92 +. ds ^ \&
1.93 +. ds , \&
1.94 +. ds ~ ~
1.95 +. ds /
1.96 +.\}
1.97 +.if t \{\
1.98 +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
1.99 +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
1.100 +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
1.101 +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
1.102 +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
1.103 +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
1.104 +.\}
1.105 +. \" troff and (daisy-wheel) nroff accents
1.106 +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
1.107 +.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
1.108 +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
1.109 +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
1.110 +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
1.111 +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
1.112 +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
1.113 +.ds ae a\h'-(\w'a'u*4/10)'e
1.114 +.ds Ae A\h'-(\w'A'u*4/10)'E
1.115 +. \" corrections for vroff
1.116 +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
1.117 +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
1.118 +. \" for low resolution devices (crt and lpr)
1.119 +.if \n(.H>23 .if \n(.V>19 \
1.120 +\{\
1.121 +. ds : e
1.122 +. ds 8 ss
1.123 +. ds o a
1.124 +. ds d- d\h'-1'\(ga
1.125 +. ds D- D\h'-1'\(hy
1.126 +. ds th \o'bp'
1.127 +. ds Th \o'LP'
1.128 +. ds ae ae
1.129 +. ds Ae AE
1.130 +.\}
1.131 +.rm #[ #] #H #V #F C
1.132 +.\" ========================================================================
1.133 +.\"
1.134 +.IX Title "RELEASE 8"
1.135 +.TH RELEASE 8 "OpenPKG" "RELEASE(8)" "OpenPKG"
1.136 +.SH "NAME"
1.137 +\&\fBopenpkg release\fR \- OpenPKG Release Utility
1.138 +.SH "SYNOPSIS"
1.139 +.IX Header "SYNOPSIS"
1.140 +\&\fBopenpkg release\fR [\fB\-F\fR|\fB\-\-fmt\fR \fIformat\fR]
1.141 +.SH "DESCRIPTION"
1.142 +.IX Header "DESCRIPTION"
1.143 +The \fBopenpkg release\fR command displays the OpenPKG release tag and
1.144 +distribution \s-1URL\s0. The release tag uniquely identifies an OpenPKG
1.145 +distribution and the distribution \s-1URL\s0 is the location where the
1.146 +distribution packages and indices are stored.
1.147 +.SH "OPTIONS"
1.148 +.IX Header "OPTIONS"
1.149 +.IP "\fB\-F\fR, \fB\-\-fmt\fR \fIformat\fR" 4
1.150 +.IX Item "-F, --fmt format"
1.151 +The output format specification. The argument \fIformat\fR is an arbitrary
1.152 +string which can contain the special expansion constructs "\f(CW%t\fR\*(L" for
1.153 +expanding the release tag, \*(R"\f(CW%u\fR\*(L" for expanding the distribution \s-1URL\s0
1.154 +and \*(R"\f(CW\*(C`\en\*(C'\fR" for expanding an embedded newline character.
1.155 +The instance \s-1UUID\s0 information is also availble by expanding
1.156 +\&\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.
1.157 +The default \fIformat\fR is "\f(CW\*(C`OpenPKG\-%t %u\*(C'\fR".
1.158 +.IP "\fB\-r\fR, \fB\-\-release\fR \fIrelease\fR" 4
1.159 +.IX Item "-r, --release release"
1.160 +The package "\f(CW\*(C`Release\*(C'\fR" header value to use for deriving the release
1.161 +tag. The values in the \fI@l_prefix@/etc/openpkg/release\fR file and the
1.162 +"\f(CW\*(C`Release\*(C'\fR" header of the bootstrap package \fBopenpkg\fR are ignored if
1.163 +this option is used.
1.164 +.SH "FILES"
1.165 +.IX Header "FILES"
1.166 +.IP "\fI@l_prefix@/etc/openpkg/release\fR" 4
1.167 +.IX Item "@l_prefix@/etc/openpkg/release"
1.168 +This optional configuration file can be used to explicitly set values
1.169 +for the OpenPKG release tag and distribution URLs. It consists of lines
1.170 +with variable name/value pairs. The following configuration variables
1.171 +are recognized:
1.172 +.RS 4
1.173 +.IP "\fBTAG=\fR\fItag\fR" 4
1.174 +.IX Item "TAG=tag"
1.175 +The default \fItag\fR is automatically derived from the "\f(CW\*(C`Version\*(C'\fR" header
1.176 +of the OpenPKG bootstrap package \fBopenpkg\fR. One usually only sets this
1.177 +explicitly to a value if a bootstrap package is used from a foreign
1.178 +distribution version.
1.179 +.IP "\fBURL=\fR\fIurl\fR" 4
1.180 +.IX Item "URL=url"
1.181 +The fully-qualified distribution \s-1URL\s0 based on either the "\f(CW\*(C`ftp\*(C'\fR\*(L",
1.182 +\&\*(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
1.183 +"\f(CW\*(C`/*\*(C'\fR", this is expanded according to the \fItag\fR value of the \fB\s-1TAG\s0\fR
1.184 +variable and the corresponding filesystem layout on \f(CW\*(C`ftp.openpkg.org\*(C'\fR.
1.185 +The default \fIurl\fR is "\f(CW\*(C`ftp://ftp.openpkg.org/*\*(C'\fR".
1.186 +.RS 4
1.187 +.RE
1.188 +.RS 4
1.189 +.SH "EXAMPLE"
1.190 +.IX Header "EXAMPLE"
1.191 +.Vb 2
1.192 +\& $ openpkg release
1.193 +\& OpenPKG-CURRENT ftp://ftp.openpkg.org/current/SRC/
1.194 +.Ve
1.195 +.Sp
1.196 +.Vb 2
1.197 +\& $ openpkg release --fmt=%t
1.198 +\& CURRENT
1.199 +.Ve
1.200 +.Sp
1.201 +.Vb 2
1.202 +\& $ openpkg release --fmt=%u
1.203 +\& ftp://ftp.openpkg.org/current/SRC/
1.204 +.Ve
1.205 +.Sp
1.206 +.Vb 3
1.207 +\& $ openpkg release --fmt="OpenPKG %t is located at:\e\en%u"
1.208 +\& OpenPKG CURRENT is located at:
1.209 +\& ftp://ftp.openpkg.org/current/SRC/
1.210 +.Ve
1.211 +.Sp
1.212 +.Vb 2
1.213 +\& $ openpkg release --release=2.5.4 --fmt=%t
1.214 +\& 2.5-RELEASE
1.215 +.Ve
1.216 +.Sp
1.217 +.Vb 3
1.218 +\& $ cat /openpkg/etc/openpkg/release
1.219 +\& TAG=2-STABLE-20060622
1.220 +\& URL=ftp://ftp.example.com/mirror/openpkg.org/*
1.221 +.Ve
1.222 +.SH "SEE ALSO"
1.223 +.IX Header "SEE ALSO"
1.224 +\&\fIuuid\fR\|(8)
1.225 +.SH "HISTORY"
1.226 +.IX Header "HISTORY"
1.227 +The \fBopenpkg release\fR command first appeared in \fBOpenPKG 2\-STABLE\-20060622\fR.
