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