diff -r 71503088f51b -r f880f219c566 openpkg/openpkg.1 --- a/openpkg/openpkg.1 Tue Jul 31 12:12:54 2012 +0200 +++ b/openpkg/openpkg.1 Tue Jul 31 12:23:42 2012 +0200 @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22) .\" .\" Standard preamble: .\" ======================================================================== -.de Sh \" Subsection heading -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp @@ -25,11 +17,11 @@ .. .\" 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. | will give a -.\" real vertical bar. \*(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-|\(bv\*(Tr +.\" 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- @@ -48,22 +40,25 @@ . 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 (.Sh), items (.Ip), and index +.\" 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. -.if \nF \{\ +.ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} -.\" -.\" For nroff, turn off justification. Always turn off hyphenation; it makes -.\" way too many mistakes in technical documents. -.hy 0 -.if n .na +.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. @@ -130,41 +125,17 @@ .\" .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" -\&\fBOpenPKG\fR \-\- Cross\-Platform Unix Software Packaging Facility +OpenPKG \-\- Cross\-Platform Unix Software Packaging .SH "SYNOPSIS" .IX Header "SYNOPSIS" -.IP "Command Line Interface" 4 -.IX Item "Command Line Interface" $ \fBopenpkg\fR [\fIopt\fR ...] \fIcmd\fR [\fIcmd_opt\fR ...] [\fIcmd_arg\fR ...] -.Sp +.PP $ \fBopenpkg\fR \fBman\fR \fIcmd\fR -.IP "Project Locations" 4 -.IX Item "Project Locations" -.Vb 4 -\& http://www.openpkg.org/ web service -\& http://cvs.openpkg.org/ repository service -\& http://pgp.openpkg.org/ OpenPGP service -\& ftp://ftp.openpkg.org/ download service -.Ve -.IP "Project Forums" 4 -.IX Item "Project Forums" -.Vb 4 -\& petidomo@openpkg.org mailing-list manager -\& openpkg-announce@openpkg.org project announcements -\& openpkg-dev@openpkg.org developer forum -\& openpkg-users@openpkg.org users forum -.Ve -.IP "Local Documentation" 4 -.IX Item "Local Documentation" -.Vb 6 -\& openpkg-rpm(1) RPM package manager -\& openpkg-rpmbuild(1) RPM package manager (build only) -\& openpkg-rpm2cpio(1) RPM payload utility -\& openpkg-rpm-config(1) RPM C API utility -\& openpkg-lsync(1) local area synchronization -\& openpkg-rc(1) run-command facility -.Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" OpenPKG is the world leading instrument for deployment and maintenance @@ -181,3 +152,145 @@ 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] +\& +\& # deploy even more packages +\& $ /openpkg/bin/openpkg build \e +\& [\-D[::]with_] \e +\& [\-D[::]with_] \e +\& ... | 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