openpkg/build.8

changeset 428
f880f219c566
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/openpkg/build.8	Tue Jul 31 12:23:42 2012 +0200
     1.3 @@ -0,0 +1,513 @@
     1.4 +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
     1.5 +.\"
     1.6 +.\" Standard preamble:
     1.7 +.\" ========================================================================
     1.8 +.de Sp \" Vertical space (when we can't use .PP)
     1.9 +.if t .sp .5v
    1.10 +.if n .sp
    1.11 +..
    1.12 +.de Vb \" Begin verbatim text
    1.13 +.ft CW
    1.14 +.nf
    1.15 +.ne \\$1
    1.16 +..
    1.17 +.de Ve \" End verbatim text
    1.18 +.ft R
    1.19 +.fi
    1.20 +..
    1.21 +.\" Set up some character translations and predefined strings.  \*(-- will
    1.22 +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
    1.23 +.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
    1.24 +.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
    1.25 +.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
    1.26 +.\" nothing in troff, for use with C<>.
    1.27 +.tr \(*W-
    1.28 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
    1.29 +.ie n \{\
    1.30 +.    ds -- \(*W-
    1.31 +.    ds PI pi
    1.32 +.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
    1.33 +.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
    1.34 +.    ds L" ""
    1.35 +.    ds R" ""
    1.36 +.    ds C` 
    1.37 +.    ds C' 
    1.38 +'br\}
    1.39 +.el\{\
    1.40 +.    ds -- \|\(em\|
    1.41 +.    ds PI \(*p
    1.42 +.    ds L" ``
    1.43 +.    ds R" ''
    1.44 +'br\}
    1.45 +.\"
    1.46 +.\" Escape single quotes in literal strings from groff's Unicode transform.
    1.47 +.ie \n(.g .ds Aq \(aq
    1.48 +.el       .ds Aq '
    1.49 +.\"
    1.50 +.\" If the F register is turned on, we'll generate index entries on stderr for
    1.51 +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
    1.52 +.\" entries marked with X<> in POD.  Of course, you'll have to process the
    1.53 +.\" output yourself in some meaningful fashion.
    1.54 +.ie \nF \{\
    1.55 +.    de IX
    1.56 +.    tm Index:\\$1\t\\n%\t"\\$2"
    1.57 +..
    1.58 +.    nr % 0
    1.59 +.    rr F
    1.60 +.\}
    1.61 +.el \{\
    1.62 +.    de IX
    1.63 +..
    1.64 +.\}
    1.65 +.\"
    1.66 +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
    1.67 +.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
    1.68 +.    \" fudge factors for nroff and troff
    1.69 +.if n \{\
    1.70 +.    ds #H 0
    1.71 +.    ds #V .8m
    1.72 +.    ds #F .3m
    1.73 +.    ds #[ \f1
    1.74 +.    ds #] \fP
    1.75 +.\}
    1.76 +.if t \{\
    1.77 +.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
    1.78 +.    ds #V .6m
    1.79 +.    ds #F 0
    1.80 +.    ds #[ \&
    1.81 +.    ds #] \&
    1.82 +.\}
    1.83 +.    \" simple accents for nroff and troff
    1.84 +.if n \{\
    1.85 +.    ds ' \&
    1.86 +.    ds ` \&
    1.87 +.    ds ^ \&
    1.88 +.    ds , \&
    1.89 +.    ds ~ ~
    1.90 +.    ds /
    1.91 +.\}
    1.92 +.if t \{\
    1.93 +.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
    1.94 +.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
    1.95 +.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
    1.96 +.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
    1.97 +.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
    1.98 +.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
    1.99 +.\}
   1.100 +.    \" troff and (daisy-wheel) nroff accents
   1.101 +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
   1.102 +.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
   1.103 +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
   1.104 +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
   1.105 +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
   1.106 +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
   1.107 +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
   1.108 +.ds ae a\h'-(\w'a'u*4/10)'e
   1.109 +.ds Ae A\h'-(\w'A'u*4/10)'E
   1.110 +.    \" corrections for vroff
   1.111 +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
   1.112 +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
   1.113 +.    \" for low resolution devices (crt and lpr)
   1.114 +.if \n(.H>23 .if \n(.V>19 \
   1.115 +\{\
   1.116 +.    ds : e
   1.117 +.    ds 8 ss
   1.118 +.    ds o a
   1.119 +.    ds d- d\h'-1'\(ga
   1.120 +.    ds D- D\h'-1'\(hy
   1.121 +.    ds th \o'bp'
   1.122 +.    ds Th \o'LP'
   1.123 +.    ds ae ae
   1.124 +.    ds Ae AE
   1.125 +.\}
   1.126 +.rm #[ #] #H #V #F C
   1.127 +.\" ========================================================================
   1.128 +.\"
   1.129 +.IX Title "BUILD 8"
   1.130 +.TH BUILD 8 "OpenPKG" "BUILD(8)" "OpenPKG"
   1.131 +.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
   1.132 +.\" way too many mistakes in technical documents.
   1.133 +.if n .ad l
   1.134 +.nh
   1.135 +.SH "NAME"
   1.136 +openpkg build \- OpenPKG Package Building and Installing
   1.137 +.SH "SYNOPSIS"
   1.138 +.IX Header "SYNOPSIS"
   1.139 +\&\fBopenpkg\fR
   1.140 +\&\fBbuild\fR
   1.141 +[\fB\-R\fR \fIrpm\fR]
   1.142 +[\fB\-r\fR \fIrepository\fR]
   1.143 +[\fB\-f\fR \fIindex.rdf\fR]
   1.144 +[\fB\-u\fR]
   1.145 +[\fB\-U\fR]
   1.146 +[\fB\-z\fR]
   1.147 +[\fB\-Z\fR]
   1.148 +[\fB\-i\fR]
   1.149 +[\fB\-q\fR]
   1.150 +[\fB\-s\fR]
   1.151 +[\fB\-S\fR]
   1.152 +[\fB\-M\fR]
   1.153 +[\fB\-L\fR]
   1.154 +[\fB\-W\fR]
   1.155 +[\fB\-X\fR]
   1.156 +[\fB\-K\fR]
   1.157 +[\fB\-k\fR]
   1.158 +[\fB\-e\fR]
   1.159 +[\fB\-b\fR]
   1.160 +[\fB\-B\fR]
   1.161 +[\fB\-G\fR]
   1.162 +[\fB\-P\fR \fIpriv-cmd\fR]
   1.163 +[\fB\-N\fR \fInon-priv-cmd\fR]
   1.164 +[\fB\-p\fR \fIplatform\fR]
   1.165 +[\fB\-D\fR \fIvar\fR=\fIval\fR ...]
   1.166 +[\fB\-E\fR \fIname\fR ...]
   1.167 +[\fB\-H\fR \fIname\fR ...]
   1.168 +([\fB\-a\fR] [\fB\-A\fR] | \fIpattern\fR ...)
   1.169 +.SH "DESCRIPTION"
   1.170 +.IX Header "DESCRIPTION"
   1.171 +The \fBopenpkg build\fR tool provides automated recursive from-scratch
   1.172 +installation of packages and the updating and upgrading of installed
   1.173 +packages.
   1.174 +.PP
   1.175 +It generates a Bourne-Shell script on standard output (\fIstdout\fR)
   1.176 +that can be executed to perform the package installation or
   1.177 +updating/upgrading procedure for all requested packages and their
   1.178 +dependencies.
   1.179 +.PP
   1.180 +Packages that are upgraded automatically trigger rebuilds of all
   1.181 +packages that depend on the upgraded package (\*(L"reverse dependencies\*(R").
   1.182 +The dependency information is read from an \s-1XML/RDF\s0 index generated by
   1.183 +the companion tool \fBopenpkg index\fR.
   1.184 +.SH "ARGUMENTS"
   1.185 +.IX Header "ARGUMENTS"
   1.186 +Packages are selected by providing a list of name patterns. Each
   1.187 +pattern is either a package name or a name prefix followed by a '\fI*\fR'
   1.188 +character. Additionally, in order to resolve ambiguous dependencies, you
   1.189 +can append a discrimination prefix separated by a comma that matches
   1.190 +against the full "\fIname\fR\-\fIversion\fR\-\fIrevision\fR" string of a package.
   1.191 +.SH "OPTIONS"
   1.192 +.IX Header "OPTIONS"
   1.193 +The following command line options exist:
   1.194 +.IP "\fB\-R\fR \fIcommand\fR" 4
   1.195 +.IX Item "-R command"
   1.196 +Specify the "\fBopenpkg rpm\fR" command with fully qualified path.
   1.197 +Several other internal paths are deduced from the \fIcommand\fR path,
   1.198 +so this has to be something like "\fIprefix\fR\f(CW\*(C`/bin/openpkg rpm\*(C'\fR".
   1.199 +.IP "\fB\-r\fR \fIrepository\fR" 4
   1.200 +.IX Item "-r repository"
   1.201 +Specify the path to an OpenPKG \s-1RPM\s0 package repository.
   1.202 +This can be a \s-1URL\s0 (including \*(L"file://\*(R") to download packages from or
   1.203 +an absolute directory path (identified by leading \*(L"/\*(R") or
   1.204 +a relative directory path (identified by leading \*(L"./\*(R") to access packages directly.
   1.205 +The name of the package file is appended to this path.
   1.206 +The default is to use a \s-1URL\s0 pointing to the \fBOpenPKG\fR download service
   1.207 +as determined by the "\fBopenpkg release\fR" command.
   1.208 +.IP "\fB\-f\fR \fIindex.rdf\fR" 4
   1.209 +.IX Item "-f index.rdf"
   1.210 +Specify the path to the primary \s-1XML/RDF\s0 index. This can be a \s-1URL\s0 or a
   1.211 +file path. If the index contains references to other indices, these
   1.212 +are recursively included automatically. The default is to use a \s-1URL\s0
   1.213 +pointing to the \fBOpenPKG\fR \s-1FTP\s0 server as as determined by the "\fBopenpkg
   1.214 +release\fR" command.
   1.215 +.IP "\fB\-u\fR" 4
   1.216 +.IX Item "-u"
   1.217 +The generated script will ignore binary RPMs that are stored on
   1.218 +your system. Instead it will either fetch binary RPMs or rebuild
   1.219 +from source RPMs fetched from the repository.
   1.220 +.IP "\fB\-U\fR" 4
   1.221 +.IX Item "-U"
   1.222 +The generated script will try to upgrade all selected packages
   1.223 +including their dependencies to the most recent version. Use
   1.224 +this for usual upgrade tasks in combination with option "\fB\-a\fR".
   1.225 +.IP "\fB\-z\fR" 4
   1.226 +.IX Item "-z"
   1.227 +The generated script will rebuild all selected packages
   1.228 +including their dependencies even when the most recent version
   1.229 +is already installed.
   1.230 +.IP "\fB\-Z\fR" 4
   1.231 +.IX Item "-Z"
   1.232 +\&\fBopenpkg build\fR ignores all installed packages, the
   1.233 +generated script will rebuild all selected packages from scratch.
   1.234 +.IP "\fB\-i\fR" 4
   1.235 +.IX Item "-i"
   1.236 +The generated script will ignore run-time errors.
   1.237 +.IP "\fB\-q\fR" 4
   1.238 +.IX Item "-q"
   1.239 +Ignore all reverse dependencies. This means that all packages which are
   1.240 +rebuild do \fInot\fR trigger a rebuild of packages which depend on them.
   1.241 +\&\fI\s-1ATTENTION:\s0 this might break already installed packages and has to be
   1.242 +used with care! You should really know what you are doing.\fR
   1.243 +.IP "\fB\-s\fR" 4
   1.244 +.IX Item "-s"
   1.245 +Generate a status map instead of the shell script. The map consists
   1.246 +of 3 columns: \fIold\fR, \fItag\fR and \fInew\fR. The \fIold\fR column shows
   1.247 +the installed version of a package (\fIname\fR\-\fIversion\fR\-\fIrelease\fR)
   1.248 +or just the package name (\fIname\fR) if no package of that name
   1.249 +is installed and the \fInew\fR column shows the repository version
   1.250 +(\fIname\fR\-\fIversion\fR\-\fIrelease\fR) of a package if it is considered for
   1.251 +installation. The \fItag\fR column shows the following possible values:
   1.252 +.RS 4
   1.253 +.IP "\s-1OK\s0" 10
   1.254 +.IX Item "OK"
   1.255 +The installed package is suitable and will not be touched.
   1.256 +.IP "\s-1ADD\s0" 10
   1.257 +.IX Item "ADD"
   1.258 +There is no installed package yet.
   1.259 +.IP "\s-1UPGRADE\s0" 10
   1.260 +.IX Item "UPGRADE"
   1.261 +The installed package is outdated and requires an update.
   1.262 +.IP "\s-1DEPEND\s0" 10
   1.263 +.IX Item "DEPEND"
   1.264 +The installed package needs rebuilding because one of its
   1.265 +dependencies is rebuild.
   1.266 +.IP "\s-1MISMATCH\s0" 10
   1.267 +.IX Item "MISMATCH"
   1.268 +The installed package needs rebuilding because it was build
   1.269 +with different parameters.
   1.270 +.IP "\s-1CONFLICT\s0" 10
   1.271 +.IX Item "CONFLICT"
   1.272 +The required new package cannot be installed because it
   1.273 +conflicts with some already installed package.
   1.274 +.IP "\s-1UNDEF\s0" 10
   1.275 +.IX Item "UNDEF"
   1.276 +The package has an invalid or ambiguous dependency.
   1.277 +.RE
   1.278 +.RS 4
   1.279 +.RE
   1.280 +.IP "\fB\-S\fR" 4
   1.281 +.IX Item "-S"
   1.282 +Similar to option "\fB\-s\fR" but also lists the newest versions in the
   1.283 +repository. The following \fItag\fR might appear in the map:
   1.284 +.RS 4
   1.285 +.IP "\s-1NEW\s0" 10
   1.286 +.IX Item "NEW"
   1.287 +The package exists in the repository but is not required yet.
   1.288 +.RE
   1.289 +.RS 4
   1.290 +.RE
   1.291 +.IP "\fB\-M\fR" 4
   1.292 +.IX Item "-M"
   1.293 +Similar to option "\fB\-s\fR" but print a short dependency map.
   1.294 +.IP "\fB\-L\fR" 4
   1.295 +.IX Item "-L"
   1.296 +Print a list of packages in the repository that depend on the target.
   1.297 +.IP "\fB\-W\fR" 4
   1.298 +.IX Item "-W"
   1.299 +Include all conditional dependencies as if all possible configuration
   1.300 +options had been switched on. This has little use in practice except for
   1.301 +generating an all-inclusive list with option "\fB\-L\fR". \fI\s-1ATTENTION:\s0 Even
   1.302 +mutually exclusive options are evaluated to be 'on', building packages
   1.303 +with option \*(L"\-W\*(R" therefore might fail or cause unusable results!\fR
   1.304 +.IP "\fB\-X\fR" 4
   1.305 +.IX Item "-X"
   1.306 +Use the slower but more robust external Perl \s-1XML\s0 parser module
   1.307 +XML::Simple instead of the simple internal \s-1XML/RDF\s0 parser.
   1.308 +.IP "\fB\-K\fR" 4
   1.309 +.IX Item "-K"
   1.310 +Keep packages that were installed temporarily during the build process.
   1.311 +Without this option those packages are removed.
   1.312 +.IP "\fB\-k\fR" 4
   1.313 +.IX Item "-k"
   1.314 +Keep packages that were downloaded temporarily for installation or building.
   1.315 +Without this option those packages are removed.
   1.316 +.IP "\fB\-e\fR" 4
   1.317 +.IX Item "-e"
   1.318 +Rebuild exact version of a package from repository even when you have
   1.319 +installed a newer version from another repository.
   1.320 +.IP "\fB\-b\fR" 4
   1.321 +.IX Item "-b"
   1.322 +Wrap package rebuilding commands with script execution-time checks for
   1.323 +existing binary packages if the package is rebuild as a dependency. Wrap
   1.324 +package install commands with script execution-time checks for different
   1.325 +\&\s-1MD5\s0 signature checksums of binary packages and installed packages. This
   1.326 +is best to use with option "\fB\-u\fR" to defer all such checks until script
   1.327 +execution-time.
   1.328 +.IP "\fB\-B\fR" 4
   1.329 +.IX Item "-B"
   1.330 +Same as option "\fB\-b\fR" but also check all explicit target packages for
   1.331 +existing binary packages at script execution-time.
   1.332 +.IP "\fB\-g\fR" 4
   1.333 +.IX Item "-g"
   1.334 +The generated script will rebuild all packages selected even when the
   1.335 +most recent version is already installed. Dependencies are not affected.
   1.336 +Use this especially for updating a package with different build options
   1.337 +(see option "\fB\-D\fR").
   1.338 +.IP "\fB\-P\fR \fIpriv-cmd\fR" 4
   1.339 +.IX Item "-P priv-cmd"
   1.340 +Command prefix to use for generated script commands that require
   1.341 +elevated privileges (like "\fBopenpkg rpm \-Uvh\fR"). The most common tool
   1.342 +for this is \fIsudo\fR\|(8). If \fIpriv-cmd\fR starts with a dash it will be run
   1.343 +without the dash and the command line it should execute is passed as
   1.344 +a single quoted string. Use this option for upgrading privileges. For
   1.345 +instance, if you are running the \f(CW\*(C`openpkg build\*(C'\fR\*(L" command as the
   1.346 +management user, use \*(R"\f(CW\*(C`\-P sudo\*(C'\fR\*(L" to make sure that the \*(R"\fBopenpkg rpm
   1.347 +\&\-Uvh\fR" commands in the generated script execute with necessary elevated
   1.348 +privileges.
   1.349 +.IP "\fB\-N\fR \fInon-priv-cmd\fR" 4
   1.350 +.IX Item "-N non-priv-cmd"
   1.351 +Command prefix to use for generated script commands that do \fInot\fR
   1.352 +require elevated privileges (like "\fBopenpkg rpm \-\-rebuild\fR"). The most
   1.353 +common tool for this is \fIsu\fR\|(8). If \fInon-priv-cmd\fR starts with a dash
   1.354 +it will be run without the dash and the command line it should execute
   1.355 +is passed as a single quoted string. Use this option for downgrading
   1.356 +privileges. For instance, if you are running the \f(CW\*(C`openpkg build\*(C'\fR"
   1.357 +command as the \fBroot\fR user, use "\f(CW\*(C`\-N \*(Aq\-su \- \*(C'\fR\fImusr\fR\f(CW\*(C` \-c\*(Aq\*(C'\fR" to make
   1.358 +sure that the non-privileged commands in the generated script execute
   1.359 +with privileges of the management user \fImusr\fR.
   1.360 +.IP "\fB\-p\fR \fIplatform\fR" 4
   1.361 +.IX Item "-p platform"
   1.362 +The platform string that is matched against the \s-1XML/RDF\s0 index for binary
   1.363 +packages. The default is an empty \fIplatform\fR string so that no binary
   1.364 +packages are matched at all.
   1.365 +.IP "\fB\-D\fR \fIvar\fR=\fIval\fR" 4
   1.366 +.IX Item "-D var=val"
   1.367 +Specify build options for selected packages. This can be either
   1.368 +"\fB\-D\fR \fIwith_xxx\fR=\fIyyy\fR\*(L" or just \*(R"\fB\-D\fR \fIwith_xxx\fR\*(L". The latter is
   1.369 +equivalent to a \*(R"\fB\-D\fR \fIwith_xxx\fR=\fIyes\fR\*(L". The parameters are matched
   1.370 +against selected packages that are already installed. If they do
   1.371 +indicate a change, the package is rebuild. There can be multiple \*(R"\fB\-D\fR"
   1.372 +options.
   1.373 +.Sp
   1.374 +If the option name is prefixed with a package name followed by
   1.375 +two colons then it applies only to the specified package, e.g.,
   1.376 +"\fB\-D\fR\fIfoo::with_bar\fR".
   1.377 +.IP "\fB\-E\fR \fIname\fR" 4
   1.378 +.IX Item "-E name"
   1.379 +Ignore a package with the specified \fIname\fR. This can be used to avoid
   1.380 +upgrading to a broken package in the repository or to skip a package
   1.381 +upgrade temporarily. If you use a wildcard pattern or the options
   1.382 +"\fB\-a\fR\*(L" or \*(R"\fB\-A\fR" then \fIname\fR will be excluded. There can be multiple
   1.383 +"\fB\-E\fR" options.
   1.384 +.IP "\fB\-H\fR \fIname\fR" 4
   1.385 +.IX Item "-H name"
   1.386 +Hint about packages that should be preferred when more than one fits
   1.387 +a requirement. There can be multiple "\fB\-H\fR" options.
   1.388 +.IP "\fB\-a\fR" 4
   1.389 +.IX Item "-a"
   1.390 +Select all installed packages. You cannot specify a pattern list together
   1.391 +with the "\fB\-a\fR" option.
   1.392 +.IP "\fB\-A\fR" 4
   1.393 +.IX Item "-A"
   1.394 +Select all packages in the repository. You cannot specify a pattern list
   1.395 +together with the "\fB\-A\fR" option.
   1.396 +.SH "ARGUMENTS"
   1.397 +.IX Header "ARGUMENTS"
   1.398 +In case neither option \fB\-a\fR nor option \fB\-A\fR are specified,
   1.399 +the command line has to contain one or more package \fIpattern\fR
   1.400 +arguments. Each \fIpattern\fR can have the following forms:
   1.401 +.IP "\fIname\fR" 4
   1.402 +.IX Item "name"
   1.403 +A regular package name.
   1.404 +.IP "\fIname\fR\fB*\fR" 4
   1.405 +.IX Item "name*"
   1.406 +A package name wildcard pattern.
   1.407 +.IP "\fIname\fR\fB,\fR\fIname\fR[\fB\-\fR\fIversion\fR[\fB\-\fR\fIrelease\fR]]" 4
   1.408 +.IX Item "name,name[-version[-release]]"
   1.409 +A regular package name followed by a constraint
   1.410 +which particular package should be chosen.
   1.411 +.SH "CONFIGURATION"
   1.412 +.IX Header "CONFIGURATION"
   1.413 +\&\fBopenpkg build\fR reads the configuration file \fI\f(CI$HOME\fI/.openpkg/build\fR.
   1.414 +The file lists default options, one option per line and section tags
   1.415 +of the form \f(CW\*(C`[\*(C'\fR\fIprefix\fR\f(CW\*(C`]\*(C'\fR. Options following such a tag are only
   1.416 +evaluated for the particular \fBOpenPKG\fR instance so that you can
   1.417 +define default options for multiple \fBOpenPKG\fR instances.
   1.418 +.PP
   1.419 +Example:
   1.420 +.PP
   1.421 +.Vb 2
   1.422 +\& # global options
   1.423 +\& \-X
   1.424 +\&
   1.425 +\& [/openpkg/current]
   1.426 +\& # options for CURRENT stack only
   1.427 +\& \-r http://download.openpkg.org/stacks/current/source/
   1.428 +\&
   1.429 +\& [/openpkg/foo]
   1.430 +\& # options for a FOO stack only
   1.431 +\& \-r http://download.openpkg.org/stacks/foo/source/
   1.432 +.Ve
   1.433 +.SH "EXAMPLES"
   1.434 +.IX Header "EXAMPLES"
   1.435 +The following shows a few typical OpenPKG instance
   1.436 +maintenance tasks which involve the \fBopenpkg build\fR command:
   1.437 +.SS "Installation"
   1.438 +.IX Subsection "Installation"
   1.439 +The following examples shows how to initially install an OpenPKG
   1.440 +instance under \fI/openpkg\fR with Apache/PHP & MySQL:
   1.441 +.PP
   1.442 +.Vb 5
   1.443 +\& # bootstrap the OpenPKG instance
   1.444 +\& $ curl \-L \-O http://openpkg.org/go/download/openpkg.src.sh
   1.445 +\& $ sh openpkg\-*\-*.src.sh \-\-prefix=/openpkg \e
   1.446 +\&   \-\-user=openpkg \-\-group=openpkg \-\-tag=openpkg
   1.447 +\& $ sh openpkg\-*\-*.*\-*\-openpkg.sh
   1.448 +\&
   1.449 +\& # install Apache/PHP & MySQL
   1.450 +\& $ /openpkg/bin/openpkg build \e
   1.451 +\&   \-D apache\-php::with_mysql=yes \e
   1.452 +\&   apache apache\-php mysql | sh
   1.453 +.Ve
   1.454 +.SS "Reinstallation"
   1.455 +.IX Subsection "Reinstallation"
   1.456 +The following example shows how to rebuild and reinstall the already
   1.457 +installed package \*(L"foo\*(R":
   1.458 +.PP
   1.459 +.Vb 2
   1.460 +\& # rebuild and reinstall package
   1.461 +\& $ /openpkg/bin/openpkg build \-g \-u foo | sh
   1.462 +.Ve
   1.463 +.SS "Change"
   1.464 +.IX Subsection "Change"
   1.465 +The following fictive example shows how to change the already
   1.466 +installed package \*(L"foo\*(R" by rebuilding and reinstalling it with the
   1.467 +"\f(CW\*(C`foo::with_bar\*(C'\fR" build-time option enabled.
   1.468 +.PP
   1.469 +.Vb 2
   1.470 +\& # change a package
   1.471 +\& $ /openpkg/bin/openpkg build \-g \-D with_bar=yes foo | sh
   1.472 +.Ve
   1.473 +.SS "Update"
   1.474 +.IX Subsection "Update"
   1.475 +The following example shows how to update (no major
   1.476 +OpenPKG version change) an OpenPKG instance under \fI/openpkg\fR:
   1.477 +.PP
   1.478 +.Vb 2
   1.479 +\& # update all packages to their latest version
   1.480 +\& $ /openpkg/bin/openpkg build \-Ua | sh
   1.481 +.Ve
   1.482 +.SS "Upgrade"
   1.483 +.IX Subsection "Upgrade"
   1.484 +The following examples shows a complete procedure for upgrading (major
   1.485 +OpenPKG version change) the instance under \fI/openpkg\fR to OpenPKG
   1.486 +4.X:
   1.487 +.PP
   1.488 +.Vb 3
   1.489 +\& # upgrade the bootstrap package
   1.490 +\& $ /openpkg/bin/openpkg build \e
   1.491 +\&   \-r http://download.openpkg.org/stacks/current/source/ openpkg | sh
   1.492 +\&
   1.493 +\& # upgrade the whole OpenPKG instance, in correct dependency
   1.494 +\& # order and by keeping all chosen build\-time options.
   1.495 +\& $ /openpkg/bin/openpkg build \-ZaKB | sh
   1.496 +.Ve
   1.497 +.SS "Deinstallation"
   1.498 +.IX Subsection "Deinstallation"
   1.499 +The following example shows how to deinstall
   1.500 +an entire OpenPKG intance under \fI/openpkg\fR:
   1.501 +.PP
   1.502 +.Vb 3
   1.503 +\& # remove all packages and the instance itself
   1.504 +\& $ /openpkg/bin/openpkg rpm \-e \e
   1.505 +\&   \`/openpkg/bin/openpkg rpm \-qa\`
   1.506 +.Ve
   1.507 +.SH "CAVEATS"
   1.508 +.IX Header "CAVEATS"
   1.509 +Parallel execution of \fBopenpkg build\fR causes undefined effects.
   1.510 +.SH "HISTORY"
   1.511 +.IX Header "HISTORY"
   1.512 +The \fBopenpkg build\fR command was invented in November 2002 by \fIMichael
   1.513 +van Elst\fR <mlelstv@serpens.de> under contract with \fICable
   1.514 +& Wireless\fR <http://www.cw.com/> for use inside the \fBOpenPKG\fR
   1.515 +project <http://www.openpkg.org/>. It was then further
   1.516 +refined by the \fBOpenPKG Foundation e.V.\fR as part of the OpenPKG Tool Chain.

mercurial