openpkg/release.pod@3ca9c03168f4 (annotated)
openpkg/release.pod
Thu, 08 Jan 2009 23:26:54 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 08 Jan 2009 23:26:54 +0100
- changeset 49
- 3ca9c03168f4
- child 428
- f880f219c566
- permissions
- -rw-r--r--
Import package vendor original specs for necessary manipulations.
| michael@13 | 1 | ## |
| michael@13 | 2 | ## release -- OpenPKG Release Utility |
| michael@13 | 3 | ## Copyright (c) 2000-2007 OpenPKG Foundation e.V. <http://openpkg.net/> |
| michael@13 | 4 | ## Copyright (c) 2000-2007 Ralf S. Engelschall <http://engelschall.com/> |
| michael@13 | 5 | ## |
| michael@13 | 6 | ## Permission to use, copy, modify, and distribute this software for |
| michael@13 | 7 | ## any purpose with or without fee is hereby granted, provided that |
| michael@13 | 8 | ## the above copyright notice and this permission notice appear in all |
| michael@13 | 9 | ## copies. |
| michael@13 | 10 | ## |
| michael@13 | 11 | ## THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| michael@13 | 12 | ## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| michael@13 | 13 | ## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| michael@13 | 14 | ## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR |
| michael@13 | 15 | ## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| michael@13 | 16 | ## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| michael@13 | 17 | ## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| michael@13 | 18 | ## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| michael@13 | 19 | ## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| michael@13 | 20 | ## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| michael@13 | 21 | ## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| michael@13 | 22 | ## SUCH DAMAGE. |
| michael@13 | 23 | ## |
| michael@13 | 24 | |
| michael@13 | 25 | =pod |
| michael@13 | 26 | |
| michael@13 | 27 | =head1 NAME |
| michael@13 | 28 | |
| michael@13 | 29 | B<openpkg release> - OpenPKG Release Utility |
| michael@13 | 30 | |
| michael@13 | 31 | =head1 SYNOPSIS |
| michael@13 | 32 | |
| michael@13 | 33 | B<openpkg release> [B<-F>|B<--fmt> I<format>] |
| michael@13 | 34 | |
| michael@13 | 35 | =head1 DESCRIPTION |
| michael@13 | 36 | |
| michael@13 | 37 | The B<openpkg release> command displays the OpenPKG release tag and |
| michael@13 | 38 | distribution URL. The release tag uniquely identifies an OpenPKG |
| michael@13 | 39 | distribution and the distribution URL is the location where the |
| michael@13 | 40 | distribution packages and indices are stored. |
| michael@13 | 41 | |
| michael@13 | 42 | =head1 OPTIONS |
| michael@13 | 43 | |
| michael@13 | 44 | =over 4 |
| michael@13 | 45 | |
| michael@13 | 46 | =item B<-F>, B<--fmt> I<format> |
| michael@13 | 47 | |
| michael@13 | 48 | The output format specification. The argument I<format> is an arbitrary |
| michael@13 | 49 | string which can contain the special expansion constructs "C<%t>" for |
| michael@13 | 50 | expanding the release tag, "C<%u>" for expanding the distribution URL |
| michael@13 | 51 | and "C<\n>" for expanding an embedded newline character. |
| michael@13 | 52 | The instance UUID information is also availble by expanding |
| michael@13 | 53 | C<%r> to UUID_REGISTRY, C<%i> to UUID_INSTANCE, C<%p> to UUID_PLATFORM. |
| michael@13 | 54 | The default I<format> is "C<OpenPKG-%t %u>". |
| michael@13 | 55 | |
| michael@13 | 56 | =item B<-r>, B<--release> I<release> |
| michael@13 | 57 | |
| michael@13 | 58 | The package "C<Release>" header value to use for deriving the release |
| michael@13 | 59 | tag. The values in the F<@l_prefix@/etc/openpkg/release> file and the |
| michael@13 | 60 | "C<Release>" header of the bootstrap package B<openpkg> are ignored if |
| michael@13 | 61 | this option is used. |
| michael@13 | 62 | |
| michael@13 | 63 | =back |
| michael@13 | 64 | |
| michael@13 | 65 | =head1 FILES |
| michael@13 | 66 | |
| michael@13 | 67 | =over 4 |
| michael@13 | 68 | |
| michael@13 | 69 | =item F<@l_prefix@/etc/openpkg/release> |
| michael@13 | 70 | |
| michael@13 | 71 | This optional configuration file can be used to explicitly set values |
| michael@13 | 72 | for the OpenPKG release tag and distribution URLs. It consists of lines |
| michael@13 | 73 | with variable name/value pairs. The following configuration variables |
| michael@13 | 74 | are recognized: |
| michael@13 | 75 | |
| michael@13 | 76 | =over 4 |
| michael@13 | 77 | |
| michael@13 | 78 | =item B<TAG=>I<tag> |
| michael@13 | 79 | |
| michael@13 | 80 | The default I<tag> is automatically derived from the "C<Version>" header |
| michael@13 | 81 | of the OpenPKG bootstrap package B<openpkg>. One usually only sets this |
| michael@13 | 82 | explicitly to a value if a bootstrap package is used from a foreign |
| michael@13 | 83 | distribution version. |
| michael@13 | 84 | |
| michael@13 | 85 | =item B<URL=>I<url> |
| michael@13 | 86 | |
| michael@13 | 87 | The fully-qualified distribution URL based on either the "C<ftp>", |
| michael@13 | 88 | "C<http>" or "C<file>" URL schemes. If I<url> contains a trailing |
| michael@13 | 89 | "C</*>", this is expanded according to the I<tag> value of the B<TAG> |
| michael@13 | 90 | variable and the corresponding filesystem layout on C<ftp.openpkg.org>. |
| michael@13 | 91 | The default I<url> is "C<ftp://ftp.openpkg.org/*>". |
| michael@13 | 92 | |
| michael@13 | 93 | =over |
| michael@13 | 94 | |
| michael@13 | 95 | =back |
| michael@13 | 96 | |
| michael@13 | 97 | =head1 EXAMPLE |
| michael@13 | 98 | |
| michael@13 | 99 | $ openpkg release |
| michael@13 | 100 | OpenPKG-CURRENT ftp://ftp.openpkg.org/current/SRC/ |
| michael@13 | 101 | |
| michael@13 | 102 | $ openpkg release --fmt=%t |
| michael@13 | 103 | CURRENT |
| michael@13 | 104 | |
| michael@13 | 105 | $ openpkg release --fmt=%u |
| michael@13 | 106 | ftp://ftp.openpkg.org/current/SRC/ |
| michael@13 | 107 | |
| michael@13 | 108 | $ openpkg release --fmt="OpenPKG %t is located at:\\n%u" |
| michael@13 | 109 | OpenPKG CURRENT is located at: |
| michael@13 | 110 | ftp://ftp.openpkg.org/current/SRC/ |
| michael@13 | 111 | |
| michael@13 | 112 | $ openpkg release --release=2.5.4 --fmt=%t |
| michael@13 | 113 | 2.5-RELEASE |
| michael@13 | 114 | |
| michael@13 | 115 | $ cat /openpkg/etc/openpkg/release |
| michael@13 | 116 | TAG=2-STABLE-20060622 |
| michael@13 | 117 | URL=ftp://ftp.example.com/mirror/openpkg.org/* |
| michael@13 | 118 | |
| michael@13 | 119 | =head1 SEE ALSO |
| michael@13 | 120 | |
| michael@13 | 121 | uuid(8) |
| michael@13 | 122 | |
| michael@13 | 123 | =head1 HISTORY |
| michael@13 | 124 | |
| michael@13 | 125 | The B<openpkg release> command first appeared in B<OpenPKG 2-STABLE-20060622>. |
| michael@13 | 126 | |
| michael@13 | 127 | =cut |
| michael@13 | 128 |
