openpkg/release.8

Fri, 09 Jan 2009 01:40:36 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Fri, 09 Jan 2009 01:40:36 +0100
changeset 54
f012bbb2a542
child 428
f880f219c566
permissions
-rw-r--r--

Import package vendor original specs for necessary manipulations.

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

mercurial