README for dl-ubuntu-test-iso
=============================

NOTE THAT RUNNING THIS SCRIPT WILL DOWNLOAD A LOT OF DATA BY DEFAULT.
More specifically, it will download every ISO by default, for a total
of several tens of gigabytes of data.

Running the script
------------------

./dl-ubuntu-test-iso [options]

You may use the following options:

    -n, --no-act
        Do everything, except don't actually run rsync. You can use this
        to test configuration settings, etc.

    --debug
	Similar to --no-act, but echos the actual rsync commands, as you
	might expect, this is useful for debugging the script or
	configurations

    -P  Run rsync with the -P option, to get progress reporting.

    --only flavor, --flavor flavor
        Only download a specific flavor of Ubuntu. Only the last
        --only option applies. (You can also set FLAVORS in the
        configuration file.) --only should probably be considered
	deprecated.

    --exclude flavor
        Do not download a specific flavor of Ubuntu. You can use this
        option multiple times, and none of the specified flavors will be
        downloaded. (You can also set EXCLUDE in the configuration
        file.)

    --release release
        Only download a specific release target of Ubuntu. Only the last
        --release option applies. (You can also set RELEASES in the
        configuration file.) "hardy" is the earliest release target
	available.

    --bwlimit=KBPS
	This option allows you to specify a maximum transfer rate in
	kilobytes per second; equivalent to adding the same argument to
	the OPTS variable to be passed on to rsync(1).

    --verify
	This option tells the script to do an md5sum comparison check
	against the MD5SUMS file. (use --verify --noact to just check
	md5sums)

    --versions
	Report the version information contained within all of the isos
	in the ${HOME}/iso/ subdirectories, including the build number.
	(requires the isoinfo binary to be installed)

    --build builddate
    	Tell the script to downoad a specific build date rather than the
	current iso; default is "current"


Configuring the script
----------------------

You can configure the script by putting a file called .dl-ubuntu-test-iso
in your home ($HOME) directory. The script should have variable
assignments in shell syntax, like below:

    ARCHS="i386 amd64"
    FLAVORS="ubuntu kubuntu"

Note that the quotation marks are required.

See the dl-ubuntu-test-iso.sample-cfg* files for examples.
