OpenPKG Specs / file revision

 ##

 ##  openpkg -- OpenPKG Tool Chain

 ##  Copyright (c) 2000-2012 OpenPKG GmbH <http://openpkg.com/>

 ##

 ##  This software is property of the OpenPKG GmbH, DE MUC HRB 160208.

 ##  All rights reserved. Licenses which grant limited permission to use,

 ##  copy, modify and distribute this software are available from the

 ##  OpenPKG GmbH.

 ##

 ##  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED

 ##  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

 ##  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.

 ##  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR

 ##  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 ##  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 ##  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

 ##  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

 ##  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

 ##  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT

 ##  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

 ##  SUCH DAMAGE.

 ##

 ##  openpkg.pod: Minimum Execution Frontend (Language: Perl POD)

 ##

 =pod

 =head1 NAME

 B<OpenPKG> -- Cross-Platform Unix Software Packaging

 =head1 SYNOPSIS

 $ B<openpkg> [I<opt> ...] I<cmd> [I<cmd_opt> ...] [I<cmd_arg> ...]

 $ B<openpkg> B<man> I<cmd>

 =head1 DESCRIPTION

 OpenPKG is the world leading instrument for deployment and maintenance

 of Open Source software when administration crosses Unix platform

 boundaries. The OpenPKG project is a collaboration effort with the

 goal of creating and maintaining portable and easy to install software

 packages for use on the major Unix server platforms.

 The unique OpenPKG architecture leverages proven technologies like

 Red Hat Package Manager (RPM) to establish a unified administration

 environment, independent of the underlying operating system. OpenPKG

 is completely self-contained and does not even need a preinstallation

 of RPM. Instead, RPM is provided as an OpenPKG RPM package itself plus

 a tricky bootstrapping procedure in order to allow one to create from

 scratch the initial state of the whole OpenPKG software packaging

 system.

 =head1 TUTORIAL

 =over 3

 =item B<1. System Preparation (optional)>

 Before you start, the Unix system optionally should be prepared. Here

 especially the necessary disk space requirements of OpenPKG have to be

 taken into account.

  # optionally direct /openpkg to at least 150MB free disk space:

  $ mkdir /storage/openpkg

  $ ln -s /storage/openpkg /openpkg

  # optionally direct temp-directory to at least 250MB free disk space:

  $ TMPDIR=/var/tmp

  $ export TMPDIR

  # switch to temporary directory:

  $ cd $TMPDIR

 =item B<2. Instance Bootstrapping>

 The next step is to bootstrap the OpenPKG instance. Here we are using

 the standard /openpkg filesystem prefix. An arbitrary prefix can be

 used as long as at least the "Bootstrap From Source" approach is used.

  # download bootstrap source shell package:

  $ wget http://openpkg.org/go/download/openpkg.src.sh

  # build bootstrap binary shell package from source shell package:

  $ sh openpkg.src.sh \

    --prefix=/openpkg --tag=openpkg \

    --user=openpkg --group=openpkg \

    --tag=openpkg

  # install bootstrap binary script package:

  $ sh openpkg-*-*.*-openpkg.sh

 =item B<3. Software Deployment>

 Now you can install arbitrary OpenPKG software packages by either using

 the lower-level OpenPKG RPM command or the higher-level OpenPKG tool

 chain build command. As a simple illustration example the GNU Bash

 package of OpenPKG is installed.

  # build and install GNU Bash:

  $ /openpkg/bin/openpkg build bash | sh

 =item B<4. Software Usage>

 Finally, you can use the deployed software. Either through explicit

 paths (reasonable if leveraging OpenPKG's multiple-instance feature) or

 implicitly by merging the OpenPKG instance into the local environment.

  # explicit usage:

  $ /openpkg/bin/bash --version

  # implicit usage (alternatively)

  $ eval `/openpkg/bin/openpkg rc --eval all env`

  $ bash --version

 =item B<5. Go Ahead!>

 Want to know more now? Please read the manual pages of at least the

 deployment commands and then proceed by searching and deploying even

 more software into your OpenPKG instance.

  # read manual pages:

  $ /openpkg/bin/openpkg man search

  $ /openpkg/bin/openpkg man build

  # search for a package

  $ /openpkg/bin/openpkg search [-v] <regex>

  # deploy even more packages

  $ /openpkg/bin/openpkg build \

    [-D[<package1>::]with_<name>] \

    [-D[<package2>::]with_<name>] \

    <package1> <package2> ... | sh

 For instance, to install and start an Apache HTTP server with SSL/TLS

 support you can use:

  $ /openpkg/bin/openpkg search -v apache | more

  $ /openpkg/bin/openpkg build -D with_mod_ssl=yes apache | sh

  $ /openpkg/bin/openpkg rc apache start

 =item B<6. Cleanup>

 OpenPKG has not convinced you? Well, it's a pity, but no problem. You

 can easily get rid of anything you installed at once (both the OpenPKG

 instance and any of its OpenPKG packages) with the following simple

 command:

  $ /openpkg/bin/openpkg rc all stop

  $ /openpkg/bin/openpkg rpm -e `/openpkg/bin/openpkg rpm -qa`

 =back

 =head1 SEE ALSO

 OpenPKG local documentation can be viewed the command "B<openpkg man>

 I<cmd>", where I<cmd> is one of the following commands:

  index           OpenPKG package indexing

  search          OpenPKG package searching

  mirror          OpenPKG package mirroring

  build           OpenPKG package building and installing

  rc              OpenPKG run-command facility

  lsync           OpenPKG local area synchronization

  stack           OpenPKG software stack generation

  makeproxy       OpenPKG proxy package generation

  dev             OpenPKG development tool

  rpm             RPM package manager

  rpm2cpio        RPM payload utility

  rpm-config      RPM C API utility

  rpmtool         OpenPKG RPM packaging helper tool

  license         OpenPKG license management

  release         OpenPKG release information

  register        OpenPKG registry client (obsolete)

  sea             Shell Execution Archive tool

  uuid            Universal Unique Identifiers tool

 Additionally, OpenPKG can be found under the following locations on the

 Internet:

  http://openpkg.org/  OpenPKG Project (Distribution)

  http://openpkg.com/  OpenPKG GmbH (Framework, Support)

  http://openpkg.net/  OpenPKG Foundation e.V. (Packages)

 =cut