diff -r 333964c621f1 -r cb59d6afeb61 openpkg/release.8 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/openpkg/release.8 Tue Jan 06 23:40:39 2009 +0100 @@ -0,0 +1,224 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.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. | will give a +.\" real vertical bar. \*(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-|\(bv\*(Tr +.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\} +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 +.if n .na +.\" +.\" 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 "RELEASE 8" +.TH RELEASE 8 "OpenPKG" "RELEASE(8)" "OpenPKG" +.SH "NAME" +\&\fBopenpkg release\fR \- OpenPKG Release Utility +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBopenpkg release\fR [\fB\-F\fR|\fB\-\-fmt\fR \fIformat\fR] +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBopenpkg release\fR command displays the OpenPKG release tag and +distribution \s-1URL\s0. The release tag uniquely identifies an OpenPKG +distribution and the distribution \s-1URL\s0 is the location where the +distribution packages and indices are stored. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-F\fR, \fB\-\-fmt\fR \fIformat\fR" 4 +.IX Item "-F, --fmt format" +The output format specification. The argument \fIformat\fR is an arbitrary +string which can contain the special expansion constructs "\f(CW%t\fR\*(L" for +expanding the release tag, \*(R"\f(CW%u\fR\*(L" for expanding the distribution \s-1URL\s0 +and \*(R"\f(CW\*(C`\en\*(C'\fR" for expanding an embedded newline character. +The instance \s-1UUID\s0 information is also availble by expanding +\&\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. +The default \fIformat\fR is "\f(CW\*(C`OpenPKG\-%t %u\*(C'\fR". +.IP "\fB\-r\fR, \fB\-\-release\fR \fIrelease\fR" 4 +.IX Item "-r, --release release" +The package "\f(CW\*(C`Release\*(C'\fR" header value to use for deriving the release +tag. The values in the \fI@l_prefix@/etc/openpkg/release\fR file and the +"\f(CW\*(C`Release\*(C'\fR" header of the bootstrap package \fBopenpkg\fR are ignored if +this option is used. +.SH "FILES" +.IX Header "FILES" +.IP "\fI@l_prefix@/etc/openpkg/release\fR" 4 +.IX Item "@l_prefix@/etc/openpkg/release" +This optional configuration file can be used to explicitly set values +for the OpenPKG release tag and distribution URLs. It consists of lines +with variable name/value pairs. The following configuration variables +are recognized: +.RS 4 +.IP "\fBTAG=\fR\fItag\fR" 4 +.IX Item "TAG=tag" +The default \fItag\fR is automatically derived from the "\f(CW\*(C`Version\*(C'\fR" header +of the OpenPKG bootstrap package \fBopenpkg\fR. One usually only sets this +explicitly to a value if a bootstrap package is used from a foreign +distribution version. +.IP "\fBURL=\fR\fIurl\fR" 4 +.IX Item "URL=url" +The fully-qualified distribution \s-1URL\s0 based on either the "\f(CW\*(C`ftp\*(C'\fR\*(L", +\&\*(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 +"\f(CW\*(C`/*\*(C'\fR", this is expanded according to the \fItag\fR value of the \fB\s-1TAG\s0\fR +variable and the corresponding filesystem layout on \f(CW\*(C`ftp.openpkg.org\*(C'\fR. +The default \fIurl\fR is "\f(CW\*(C`ftp://ftp.openpkg.org/*\*(C'\fR". +.RS 4 +.RE +.RS 4 +.SH "EXAMPLE" +.IX Header "EXAMPLE" +.Vb 2 +\& $ openpkg release +\& OpenPKG-CURRENT ftp://ftp.openpkg.org/current/SRC/ +.Ve +.Sp +.Vb 2 +\& $ openpkg release --fmt=%t +\& CURRENT +.Ve +.Sp +.Vb 2 +\& $ openpkg release --fmt=%u +\& ftp://ftp.openpkg.org/current/SRC/ +.Ve +.Sp +.Vb 3 +\& $ openpkg release --fmt="OpenPKG %t is located at:\e\en%u" +\& OpenPKG CURRENT is located at: +\& ftp://ftp.openpkg.org/current/SRC/ +.Ve +.Sp +.Vb 2 +\& $ openpkg release --release=2.5.4 --fmt=%t +\& 2.5-RELEASE +.Ve +.Sp +.Vb 3 +\& $ cat /openpkg/etc/openpkg/release +\& TAG=2-STABLE-20060622 +\& URL=ftp://ftp.example.com/mirror/openpkg.org/* +.Ve +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fIuuid\fR\|(8) +.SH "HISTORY" +.IX Header "HISTORY" +The \fBopenpkg release\fR command first appeared in \fBOpenPKG 2\-STABLE\-20060622\fR.