1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/openpkg/sea.pod Tue Jul 31 12:23:42 2012 +0200
1.3 @@ -0,0 +1,89 @@
1.4 +##
1.5 +## sea -- Shell Execution Archive
1.6 +## Copyright (c) 2012 Ralf S. Engelschall <rse@engelschall.com>
1.7 +##
1.8 +## This program is free software; you can redistribute it and/or modify
1.9 +## it under the terms of the GNU General Public License as published by
1.10 +## the Free Software Foundation; either version 2 of the License, or
1.11 +## (at your option) any later version.
1.12 +##
1.13 +## This program is distributed in the hope that it will be useful,
1.14 +## but WITHOUT ANY WARRANTY; without even the implied warranty of
1.15 +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1.16 +## General Public License for more details.
1.17 +##
1.18 +## You should have received a copy of the GNU General Public License
1.19 +## along with this program; if not, write to the Free Software
1.20 +## Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
1.21 +## USA, or contact Ralf S. Engelschall <rse@engelschall.com>.
1.22 +##
1.23 +## NOTICE: Given that you include this file verbatim into your own
1.24 +## source tree, you are justified in saying that it remains separate
1.25 +## from your package, and that this way you are simply just using GNU
1.26 +## shtool. So, in this situation, there is no requirement that your
1.27 +## package itself is licensed under the GNU General Public License in
1.28 +## order to take advantage of GNU shtool.
1.29 +##
1.30 +
1.31 +=pod
1.32 +
1.33 +=head1 NAME
1.34 +
1.35 +B<sea> - B<Shell Execution Archive>
1.36 +
1.37 +=head1 SYNOPSIS
1.38 +
1.39 +B<sea>
1.40 +[B<-h>|B<--help>]
1.41 +[B<-o>|B<--output> I<sea>]
1.42 +I<script>
1.43 +[I<file-or-dir> ...]
1.44 +
1.45 +=head1 DESCRIPTION
1.46 +
1.47 +The B<sea> utility allows you to wrap a control shell script (I<script>)
1.48 +plus zero or more payload file or directories (I<file-or-dir>) into a
1.49 +so-called I<Shell Execution Archive> (I<sea>), a sh(1) executable script
1.50 +which temporarily auto-extracts its payload and pass-through execution
1.51 +to the control script.
1.52 +
1.53 +=head1 OPTIONS AND ARGUMENTS
1.54 +
1.55 +=over 4
1.56 +
1.57 +=item B<-h>|B<--help>
1.58 +
1.59 +Just shows a short usage information of the B<sea> utility.
1.60 +
1.61 +=item B<-o>|B<--output> I<sea>
1.62 +
1.63 +The output I<Shell Execution Archive> file. By default the output is
1.64 +saved to a file with a basename derived from I<script> and with new
1.65 +attached extension F<.sea>.
1.66 +
1.67 +=item I<script>
1.68 +
1.69 +The mandatory control script which is added to the payload and which
1.70 +(after auto-extraction) is executed. It receives all command-line
1.71 +arguments originally passed to the I<Shell Execution Archive>.
1.72 +
1.73 +=item I<file-or-dir>
1.74 +
1.75 +Optional number of files or directories which are added to the payload.
1.76 +
1.77 +=back
1.78 +
1.79 +=head1 EXAMPLES
1.80 +
1.81 + $ sea -o foo.src.sh foo.sh foo.src.d
1.82 +
1.83 +=head1 HISTORY
1.84 +
1.85 +The B<sea> command was implemented in April 2012 by I<Ralf S. Engelschall>
1.86 +E<lt>rse@engelschall.comE<gt>. Its idea is based on the
1.87 +OpenPKG shell packages (F<openpkg.src.sh>) and its implemenation was
1.88 +triggered by the demand for self-contained OpenPKG software stack source
1.89 +archives.
1.90 +
1.91 +=cut
1.92 +
