Please see license.txt for licensing information.

This readme.txt covers version dmg_backup 2.2.0 and dmg_burn 1.3.1

Overview:
The is a command-line perl/shell script suite to create a disk image
with data you specify, for backups (or distribution of files)
1)	dmg_backup creates .dmg files and copies (including resource forks)
	your data to them. (perl script)
2)	dmg_burn burns the .dmg file to your CD or DVD or whatever.
	(zsh shell script)
3)	backupremote.pl is a simple perl script I use to get data
	to my OSX box, like from a linux host that I want to backup to DVD
	This isn't installed by the installer, you'll have to copy it
	to hosts you want to use it on.  Included just because I felt like it.

dmg_backup is completely automatic (suitable for automatically running
via cron, say).  dmg_burn pretty much just calls hdiutil burn, which
ejects your current optical drive and waits for insert of media, which
isn't really good to automate.

For obvious legal reasons, I make no warranties or guarantees.  Really,
see license.txt.  I do offer the following free advice:  Do backups
(with "real" backup software if there's actual value to your data), and
test your backups before you consider them "done".

-=- Installation:
Run ./install.sh <install directory>
If you don't specify a directory, it defaults to /usr/local/bin.
install.sh will complain if it doesn't have proper permissions.

If you don't want to use my installer, you can just copy the
dmg_backup and dmg_burn scripts to someplace in your path.

-=- Configuration:
It should "work" out of the box.  If it doesn't, or you don't like the
names of anything, well, it's a perl script, it's just text that you
can edit.  There's a "User configuration" section of some variables
you can change with explanations for them in dmg_backup, feel free to
experiment.  One advantage to splitting the backup and the burn is that
you can make as many "backups" as you want and only burn the good ones.

It's pretty simple, look at the source.

-=- How to run:
Run with no arguments for help:
Usage: dmg_backup [options] <label> <dir1> [dir2] ...
Options:
        --version
                Print version information and exit
        --volprefix [name]
                Change the volume prefix (current: Backup_)
        --tmpdir [name]
                Change tmpdir (current: /tmp)
        --compress
                Compress the image (to a new file) after creating
        --excludes [filename]
                Filename containing regexps to exlude files
        --media [cd650|cd700|cd|dvd]
        --mediasize [sectorcount]
                Size to limit dmg files to
        --sizeonly
                Only do the size calculation, don't make disk images
        --fstype [type]
                Use a type other than HFS+
        --nolog
                Don't copy logfiles to resulting disk image
        --encryption
                Use encryption.  If --passphrase is not used, GUI will prompt
        --passphrase <key>
                Passphrase for encrypting images, - to ask on stdin
		Implies --encryption

It needs a label to use for the filename of the .dmg and the Volume name
(in the Finder).  Then give it one or more directories (it'll do files, too).

If you used version 1 of dmg_backup, note that the default behavior
for symlinks specified as backup targets has changed.  The new behavior
is that symlinks will be backed up as symlinks (not copying the target
of the link)

Another advantage of a command-line program is that you can more easily
run it as root, for backing up system files or applications with root-owned
files.  See the manpage for sudo for some help with this, or the examples
below.  Since the file copy will fail on bad permissions, causing the
script to exit, it runs a permission check first.  If you run it as
root, it will skip the check, which will also speed up the time to
do the backup.

If there is interest, I could add files with bad permissions to the
file exclusion list, but since this would result in a possibly bad
backup (files would be missing) it hasn't been a high priority.

If the backup fails, you can eject it via the normal means,
or run something like:
----------------------------------------------------------------------------
hdiutil detach `df | grep /Volumes/Backup | awk ' { print $1 } ' | cut -f3 -d/`
rm -i /tmp/backup.*
----------------------------------------------------------------------------

Encyption support:
Please note, while the resulting .dmg file is encrypted with a key, if
you burn it to media, the media is _not_ encrypted!  I'm not sure
why this is, or how to get around it.  Let me know if you have any ideas.

Use --encryption to indicate you want the image to be encrypted.  It will
prompt for a passphrase to use.  You can specify one with --passphrase <key>
if you prefer, for automation.  A <key> of "-" will prompt on the command
line for a key.  It will still show up in various output, though.

You'll need to specify the key to dmg_burn for hdiutil to burn it, and
Disk Copy if you mount the image later.  If you don't specify the key to
hdiutil for attach or burn, it will prompt via the GUI.

-=- Sample execution:
1) Backing up a home directory:
dmg_backup --tmpdir /tmp/backups --media cd "my home directory" ~

2) Backup up a whole machine:
First, I created an exclude file, with the following contents:
^/Images
^/Volumes
^/Network
^/Backups
^/Developer
^/Temporary Items
^/Trash
^/automount
^/cores
^/tmp
^/private/var/vm

Then:
sudo dmg_backup --tmpdir /tmp/backups --media dvd --excludes excludes_system \
	"my machine" /

3) Making an image for distributing some files
This is how I might pack up a dmg_backup.2.1.0.dmg file:
dmg_backup --allowoverwrite --nolog --tmpdir /tmp/backups --media dvd \
	--excludes excludes_distrib --volprefix "Install_" dmg_backup.2.1.0 .

----------------------------------------------------------------------------

Then you can run dmg_burn on the resulting .dmg file, i.e.
% dmg_burn /tmp/backups/backup.dmg_backup.2.0.1.20030817.001.dmg

-=- Bugs:
	Directory sectors seem impossible to account for.  I'm
	estimating them

-=- Todo for dmg_backup:
	-make a better installer script
		-checks for zsh
		-checks for /usr/local/bin, and /usr/local/bin in path
		-copies two files over

-=- Todo for dmg_burn:
	This is pretty simple, just provided so you don't have to
	remember the command-line arguments to hdiutil.
	-automate burn if blank, uninitialized disk is already in drive
	-check size of media before burning?
	-investigate compression on burn
	-investigate encryption on burn 

-=- Changelog
	2.2.0, 8/30/03	Better, tested, DVD max sectors
			Support for encryption and -passphrase
			Removed broken options from code/help message
			Theoretical support for MS-DOS image
	2.1.0, 8/17/03	Perl version works.  Many improvements to
			image size, support for file exclusion patterns,
			and making multiple images from one source as
			size demands
			(dmg_burn 1.3 included)
	2.0		Not released, conversion to perl
	1.3		Not released, various command line flags added
			dmg_burn experiments with segments and compression
	1.2, 11/21/02	First public release
			Includes installer and more command-line options
			Some better error reporting
	1.1, 11/20/02	Beta 2
			Includes command-line option for specialsymlinks
			Fixes to problem-file-permission-finder
	1.0, 11/20/02	Beta 1
			Basic functionality complete