openpkg/sea.pod

Thu, 04 Oct 2012 20:30:05 +0200

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 04 Oct 2012 20:30:05 +0200
changeset 715
c10fb90893b9
permissions
-rw-r--r--

Correct out of date build configuration, porting to Solaris 11 network
link infrastructure and new libpcap logic. This additionally allows for
device drivers in subdirectories of /dev. Correct packaged nmap
personalities and signatures to work out of the box. Finally, hack
arpd logic to properly close sockets and quit on TERM by repeating
signaling in the run command script. Sadly, all this fails to correct
the run time behaviour of honeyd which fails to bind to the IP layer.

michael@428 1 ##
michael@428 2 ## sea -- Shell Execution Archive
michael@428 3 ## Copyright (c) 2012 Ralf S. Engelschall <rse@engelschall.com>
michael@428 4 ##
michael@428 5 ## This program is free software; you can redistribute it and/or modify
michael@428 6 ## it under the terms of the GNU General Public License as published by
michael@428 7 ## the Free Software Foundation; either version 2 of the License, or
michael@428 8 ## (at your option) any later version.
michael@428 9 ##
michael@428 10 ## This program is distributed in the hope that it will be useful,
michael@428 11 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
michael@428 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
michael@428 13 ## General Public License for more details.
michael@428 14 ##
michael@428 15 ## You should have received a copy of the GNU General Public License
michael@428 16 ## along with this program; if not, write to the Free Software
michael@428 17 ## Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
michael@428 18 ## USA, or contact Ralf S. Engelschall <rse@engelschall.com>.
michael@428 19 ##
michael@428 20 ## NOTICE: Given that you include this file verbatim into your own
michael@428 21 ## source tree, you are justified in saying that it remains separate
michael@428 22 ## from your package, and that this way you are simply just using GNU
michael@428 23 ## shtool. So, in this situation, there is no requirement that your
michael@428 24 ## package itself is licensed under the GNU General Public License in
michael@428 25 ## order to take advantage of GNU shtool.
michael@428 26 ##
michael@428 27
michael@428 28 =pod
michael@428 29
michael@428 30 =head1 NAME
michael@428 31
michael@428 32 B<sea> - B<Shell Execution Archive>
michael@428 33
michael@428 34 =head1 SYNOPSIS
michael@428 35
michael@428 36 B<sea>
michael@428 37 [B<-h>|B<--help>]
michael@428 38 [B<-o>|B<--output> I<sea>]
michael@428 39 I<script>
michael@428 40 [I<file-or-dir> ...]
michael@428 41
michael@428 42 =head1 DESCRIPTION
michael@428 43
michael@428 44 The B<sea> utility allows you to wrap a control shell script (I<script>)
michael@428 45 plus zero or more payload file or directories (I<file-or-dir>) into a
michael@428 46 so-called I<Shell Execution Archive> (I<sea>), a sh(1) executable script
michael@428 47 which temporarily auto-extracts its payload and pass-through execution
michael@428 48 to the control script.
michael@428 49
michael@428 50 =head1 OPTIONS AND ARGUMENTS
michael@428 51
michael@428 52 =over 4
michael@428 53
michael@428 54 =item B<-h>|B<--help>
michael@428 55
michael@428 56 Just shows a short usage information of the B<sea> utility.
michael@428 57
michael@428 58 =item B<-o>|B<--output> I<sea>
michael@428 59
michael@428 60 The output I<Shell Execution Archive> file. By default the output is
michael@428 61 saved to a file with a basename derived from I<script> and with new
michael@428 62 attached extension F<.sea>.
michael@428 63
michael@428 64 =item I<script>
michael@428 65
michael@428 66 The mandatory control script which is added to the payload and which
michael@428 67 (after auto-extraction) is executed. It receives all command-line
michael@428 68 arguments originally passed to the I<Shell Execution Archive>.
michael@428 69
michael@428 70 =item I<file-or-dir>
michael@428 71
michael@428 72 Optional number of files or directories which are added to the payload.
michael@428 73
michael@428 74 =back
michael@428 75
michael@428 76 =head1 EXAMPLES
michael@428 77
michael@428 78 $ sea -o foo.src.sh foo.sh foo.src.d
michael@428 79
michael@428 80 =head1 HISTORY
michael@428 81
michael@428 82 The B<sea> command was implemented in April 2012 by I<Ralf S. Engelschall>
michael@428 83 E<lt>rse@engelschall.comE<gt>. Its idea is based on the
michael@428 84 OpenPKG shell packages (F<openpkg.src.sh>) and its implemenation was
michael@428 85 triggered by the demand for self-contained OpenPKG software stack source
michael@428 86 archives.
michael@428 87
michael@428 88 =cut
michael@428 89

mercurial