1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/openpkg/release.pod Tue Jan 06 23:40:39 2009 +0100
1.3 @@ -0,0 +1,128 @@
1.4 +##
1.5 +## release -- OpenPKG Release Utility
1.6 +## Copyright (c) 2000-2007 OpenPKG Foundation e.V. <http://openpkg.net/>
1.7 +## Copyright (c) 2000-2007 Ralf S. Engelschall <http://engelschall.com/>
1.8 +##
1.9 +## Permission to use, copy, modify, and distribute this software for
1.10 +## any purpose with or without fee is hereby granted, provided that
1.11 +## the above copyright notice and this permission notice appear in all
1.12 +## copies.
1.13 +##
1.14 +## THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
1.15 +## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
1.16 +## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1.17 +## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
1.18 +## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1.19 +## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1.20 +## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
1.21 +## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
1.22 +## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
1.23 +## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
1.24 +## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
1.25 +## SUCH DAMAGE.
1.26 +##
1.27 +
1.28 +=pod
1.29 +
1.30 +=head1 NAME
1.31 +
1.32 +B<openpkg release> - OpenPKG Release Utility
1.33 +
1.34 +=head1 SYNOPSIS
1.35 +
1.36 +B<openpkg release> [B<-F>|B<--fmt> I<format>]
1.37 +
1.38 +=head1 DESCRIPTION
1.39 +
1.40 +The B<openpkg release> command displays the OpenPKG release tag and
1.41 +distribution URL. The release tag uniquely identifies an OpenPKG
1.42 +distribution and the distribution URL is the location where the
1.43 +distribution packages and indices are stored.
1.44 +
1.45 +=head1 OPTIONS
1.46 +
1.47 +=over 4
1.48 +
1.49 +=item B<-F>, B<--fmt> I<format>
1.50 +
1.51 +The output format specification. The argument I<format> is an arbitrary
1.52 +string which can contain the special expansion constructs "C<%t>" for
1.53 +expanding the release tag, "C<%u>" for expanding the distribution URL
1.54 +and "C<\n>" for expanding an embedded newline character.
1.55 +The instance UUID information is also availble by expanding
1.56 +C<%r> to UUID_REGISTRY, C<%i> to UUID_INSTANCE, C<%p> to UUID_PLATFORM.
1.57 +The default I<format> is "C<OpenPKG-%t %u>".
1.58 +
1.59 +=item B<-r>, B<--release> I<release>
1.60 +
1.61 +The package "C<Release>" header value to use for deriving the release
1.62 +tag. The values in the F<@l_prefix@/etc/openpkg/release> file and the
1.63 +"C<Release>" header of the bootstrap package B<openpkg> are ignored if
1.64 +this option is used.
1.65 +
1.66 +=back
1.67 +
1.68 +=head1 FILES
1.69 +
1.70 +=over 4
1.71 +
1.72 +=item F<@l_prefix@/etc/openpkg/release>
1.73 +
1.74 +This optional configuration file can be used to explicitly set values
1.75 +for the OpenPKG release tag and distribution URLs. It consists of lines
1.76 +with variable name/value pairs. The following configuration variables
1.77 +are recognized:
1.78 +
1.79 +=over 4
1.80 +
1.81 +=item B<TAG=>I<tag>
1.82 +
1.83 +The default I<tag> is automatically derived from the "C<Version>" header
1.84 +of the OpenPKG bootstrap package B<openpkg>. One usually only sets this
1.85 +explicitly to a value if a bootstrap package is used from a foreign
1.86 +distribution version.
1.87 +
1.88 +=item B<URL=>I<url>
1.89 +
1.90 +The fully-qualified distribution URL based on either the "C<ftp>",
1.91 +"C<http>" or "C<file>" URL schemes. If I<url> contains a trailing
1.92 +"C</*>", this is expanded according to the I<tag> value of the B<TAG>
1.93 +variable and the corresponding filesystem layout on C<ftp.openpkg.org>.
1.94 +The default I<url> is "C<ftp://ftp.openpkg.org/*>".
1.95 +
1.96 +=over
1.97 +
1.98 +=back
1.99 +
1.100 +=head1 EXAMPLE
1.101 +
1.102 + $ openpkg release
1.103 + OpenPKG-CURRENT ftp://ftp.openpkg.org/current/SRC/
1.104 +
1.105 + $ openpkg release --fmt=%t
1.106 + CURRENT
1.107 +
1.108 + $ openpkg release --fmt=%u
1.109 + ftp://ftp.openpkg.org/current/SRC/
1.110 +
1.111 + $ openpkg release --fmt="OpenPKG %t is located at:\\n%u"
1.112 + OpenPKG CURRENT is located at:
1.113 + ftp://ftp.openpkg.org/current/SRC/
1.114 +
1.115 + $ openpkg release --release=2.5.4 --fmt=%t
1.116 + 2.5-RELEASE
1.117 +
1.118 + $ cat /openpkg/etc/openpkg/release
1.119 + TAG=2-STABLE-20060622
1.120 + URL=ftp://ftp.example.com/mirror/openpkg.org/*
1.121 +
1.122 +=head1 SEE ALSO
1.123 +
1.124 +uuid(8)
1.125 +
1.126 +=head1 HISTORY
1.127 +
1.128 +The B<openpkg release> command first appeared in B<OpenPKG 2-STABLE-20060622>.
1.129 +
1.130 +=cut
1.131 +
