Read Me

------------------------------------------------------------------------------
Overview:
------------------------------------------------------------------------------
The diskegrator is a utility for integrating directory disk images and a bootloader into a bootable image. It is implemented as a set of python scripts. It was originally intended to build virtual machines, but the target disk images can reside on hard disks, disk partitions, block device targets, or files via loopback.

The diskegrator is hosted at
http://www.benegon.com/diskegrator



------------------------------------------------------------------------------
Installation
------------------------------------------------------------------------------

Dependencies (list may not be complete):
-python
-sfdisk

Installation will depend on your distro. You can probably copy the benegon dir
into your /usr/lib/pythonXXX/site-packages, and copy diskegrator somewhere
into your path.

The documentation is the source!



------------------------------------------------------------------------------
Examples:
------------------------------------------------------------------------------

Some fictitious examples are in the examples directory. Invoke this way:

# diskegrator config.py

where config.py specifies exactly one Array or 3 tuple of the following form:

(Target, [Partitions], Bootloader)

please see examples/build.py



------------------------------------------------------------------------------
TODO:
------------------------------------------------------------------------------

-Address all the FIXMES
-Build image with file systems other than ext2 and reiserfs
-lilo support
-other bootloader support
-more advanced bootloader features
-some kind of hook system?
-speed enhancments
-no state maintained (resume support would be nice!)



------------------------------------------------------------------------------
Copyright notice:
------------------------------------------------------------------------------

Copyright (c) 2007, David Bender, Benegon Enterprises LLC
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  * Neither the name of the <ORGANIZATION> nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS 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 COPYRIGHT HOLDER OR 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.