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.

    -d, --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. Multiple --only
	options can be to specify multiple flavors. (You can also set
	FLAVORS in the configuration file.) --only should probably
	be considered deprecated.

    --exclude,--exclude-flavor 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. The
	--release argument can be passed multiple times to specify
	more than one release. (You can also set RELEASES in the
	configuration file.) "hardy" is the earliest release target
	available.

    --variant variant
    	Only download a specific variant of Ubuntu (e.g. dekstop,
	alternate, server, dvd). The --variant option can be given
	multiple times to specify than one variant.

    --arch arch
    	Only download a specific architecture of Ubuntu (e.g. i386,
	amd64). The --arch option can be given multiple times to request
	more than one arch.

    --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). Note that zsync
	does not support bandwidth limiting.

    --no-verify
	This option tells the script to skip the hash comparison check
	against the MD5SUMS file that is normally done by default.

    --no-zsync
    	By default, the script will attempt to use zsync if it is
	available as it uses fewer resources on the cdimage server.
	However, because it does not do rate-limiting and has other
	limitations, using only rsync may be preferred.

    --isoroot directory
    	The local path underneath which the downloaded isos should be
	stored. The default is ${HOME}/iso.

    --config config
    	Specify an alternate location for the config file; the default
	is ${HOME}/.dl-ubuntu-test-iso.

    --host hostname
    	The mirror to pull the cdimages from. The default is
	cdimages.ubuntu.com.

    --user username
    	If http_auth is used on the cdimage server, specify the username
	with the --user argument. You can also set USERNAME in the
	config file.

    --pass password
    	If http_auth is used on the cdimage server, specify the password
	with the --pass argument. You can also set PASSWORD in the
	config file; note however that zsync does not support reading
	from a configuration file and thus any specified password will
	appear on zsync's command line and be visible in process
	listings.

    --mirror
    	If set, the script will attempt to mimic the layout of the
	cdimage server. This is useful for republishing the isos in an
	alternate mirror.

    --no-release-check
    	By default, the script will query launchpad.net to see if the
	development version of ubuntu has changed (e.g. lucid ->
	maverick) and attempt to take the change into account. Adding
	this argument disables the check.

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

    --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)

The script should honor http_proxy settings, with the exception of
rsync if the rsync mechanism is used.


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.
