OpenPKG Specs: openpkg/openpkg.1@a2c6460cfb16 (annotated)

openpkg/openpkg.1@a2c6460cfb16 (annotated)

openpkg/openpkg.1

Mon, 28 Jan 2013 17:37:18 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Mon, 28 Jan 2013 17:37:18 +0100
changeset 758: a2c6460cfb16
parent 13: cb59d6afeb61
permissions: -rw-r--r--

Correct socket error reporting improvement with IPv6 portable code,
after helpful recommendation by Saúl Ibarra Corretgé on OSips devlist.

 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
 .de Sp \" Vertical space (when we can't use .PP)
 .if t .sp .5v
 .if n .sp
 ..
 .de Vb \" Begin verbatim text
 .ft CW
 .nf
 .ne \\$1
 ..
 .de Ve \" End verbatim text
 .ft R
 .fi
 ..
 .\" Set up some character translations and predefined strings.  \*(-- will
 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
 .\" nothing in troff, for use with C<>.
 .tr \(*W-
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
 .    ds -- \(*W-
 .    ds PI pi
 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
 .    ds L" ""
 .    ds R" ""
 .    ds C`
 .    ds C'
 'br\}
 .el\{\
 .    ds -- \|\(em\|
 .    ds PI \(*p
 .    ds L" ``
 .    ds R" ''
 'br\}
 .\"
 .\" Escape single quotes in literal strings from groff's Unicode transform.
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .\"
 .\" If the F register is turned on, we'll generate index entries on stderr for
 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
 .ie \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 ..
 .    nr % 0
 .    rr F
 .\}
 .el \{\
 .    de IX
 ..
 .\}
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 .    \" fudge factors for nroff and troff
 .if n \{\
 .    ds #H 0
 .    ds #V .8m
 .    ds #F .3m
 .    ds #[ \f1
 .    ds #] \fP
 .\}
 .if t \{\
 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 .    ds #V .6m
 .    ds #F 0
 .    ds #[ \&
 .    ds #] \&
 .\}
 .    \" simple accents for nroff and troff
 .if n \{\
 .    ds ' \&
 .    ds ` \&
 .    ds ^ \&
 .    ds , \&
 .    ds ~ ~
 .    ds /
 .\}
 .if t \{\
 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 .\}
 .    \" troff and (daisy-wheel) nroff accents
 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 .ds ae a\h'-(\w'a'u*4/10)'e
 .ds Ae A\h'-(\w'A'u*4/10)'E
 .    \" corrections for vroff
 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 .    \" for low resolution devices (crt and lpr)
 .if \n(.H>23 .if \n(.V>19 \
 \{\
 .    ds : e
 .    ds 8 ss
 .    ds o a
 .    ds d- d\h'-1'\(ga
 .    ds D- D\h'-1'\(hy
 .    ds th \o'bp'
 .    ds Th \o'LP'
 .    ds ae ae
 .    ds Ae AE
 .\}
 .rm #[ #] #H #V #F C
 .\" ========================================================================
 .\"
 .IX Title "OPENPKG 1"
 .TH OPENPKG 1 "OpenPKG" "OPENPKG(8)" "OpenPKG"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
 .nh
 .SH "NAME"
 OpenPKG \-\- Cross\-Platform Unix Software Packaging
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 $ \fBopenpkg\fR [\fIopt\fR ...] \fIcmd\fR [\fIcmd_opt\fR ...] [\fIcmd_arg\fR ...]
 .PP
 $ \fBopenpkg\fR \fBman\fR \fIcmd\fR
 .SH "DESCRIPTION"
 .IX Header "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.
 .PP
 The unique OpenPKG architecture leverages proven technologies like
 Red Hat Package Manager (\s-1RPM\s0) 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 \s-1RPM\s0. Instead, \s-1RPM\s0 is provided as an OpenPKG \s-1RPM\s0 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.
 .SH "TUTORIAL"
 .IX Header "TUTORIAL"
 .IP "\fB1. System Preparation (optional)\fR" 3
 .IX Item "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.
 .Sp
 .Vb 3
 \& # 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
 .Ve
 .IP "\fB2. Instance Bootstrapping\fR" 3
 .IX Item "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 \*(L"Bootstrap From Source\*(R" approach is used.
 .Sp
 .Vb 2
 \& # 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 \e
 \&   \-\-prefix=/openpkg \-\-tag=openpkg \e
 \&   \-\-user=openpkg \-\-group=openpkg \e
 \&   \-\-tag=openpkg
 \&
 \& # install bootstrap binary script package:
 \& $ sh openpkg\-*\-*.*\-openpkg.sh
 .Ve
 .IP "\fB3. Software Deployment\fR" 3
 .IX Item "3. Software Deployment"
 Now you can install arbitrary OpenPKG software packages by either using
 the lower-level OpenPKG \s-1RPM\s0 command or the higher-level OpenPKG tool
 chain build command. As a simple illustration example the \s-1GNU\s0 Bash
 package of OpenPKG is installed.
 .Sp
 .Vb 2
 \& # build and install GNU Bash:
 \& $ /openpkg/bin/openpkg build bash | sh
 .Ve
 .IP "\fB4. Software Usage\fR" 3
 .IX Item "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.
 .Sp
 .Vb 2
 \& # explicit usage:
 \& $ /openpkg/bin/bash \-\-version
 \&
 \& # implicit usage (alternatively)
 \& $ eval \`/openpkg/bin/openpkg rc \-\-eval all env\`
 \& $ bash \-\-version
 .Ve
 .IP "\fB5. Go Ahead!\fR" 3
 .IX Item "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.
 .Sp
 .Vb 3
 \& # 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 \e
 \&   [\-D[<package1>::]with_<name>] \e
 \&   [\-D[<package2>::]with_<name>] \e
 \&   <package1> <package2> ... | sh
 .Ve
 .Sp
 For instance, to install and start an Apache \s-1HTTP\s0 server with \s-1SSL/TLS\s0
 support you can use:
 .Sp
 .Vb 3
 \& $ /openpkg/bin/openpkg search \-v apache | more
 \& $ /openpkg/bin/openpkg build \-D with_mod_ssl=yes apache | sh
 \& $ /openpkg/bin/openpkg rc apache start
 .Ve
 .IP "\fB6. Cleanup\fR" 3
 .IX Item "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:
 .Sp
 .Vb 2
 \& $ /openpkg/bin/openpkg rc all stop
 \& $ /openpkg/bin/openpkg rpm \-e \`/openpkg/bin/openpkg rpm \-qa\`
 .Ve
 .SH "SEE ALSO"
 .IX Header "SEE ALSO"
 OpenPKG local documentation can be viewed the command "\fBopenpkg man\fR
 \&\fIcmd\fR", where \fIcmd\fR is one of the following commands:
 .PP
 .Vb 6
 \& 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
 .Ve
 .PP
 Additionally, OpenPKG can be found under the following locations on the
 Internet:
 .PP
 .Vb 3
 \& http://openpkg.org/  OpenPKG Project (Distribution)
 \& http://openpkg.com/  OpenPKG GmbH (Framework, Support)
 \& http://openpkg.net/  OpenPKG Foundation e.V. (Packages)
 .Ve

OpenPKG Specs / annotate

openpkg/openpkg.1@a2c6460cfb16 (annotated)

openpkg/openpkg.1