2006-06-09 12:48:22 by steve

Added stub documentation.

bin/xt-customize-image

@@ -1,5 +1,70 @@
 #!/usr/bin/perl -w
 
+=head1 NAME
+
+ xt-customize-image - Customize a freshly installed copy of GNU/Linux
+
+=cut
+
+=head1 SYNOPSIS
+
+  xt-customize-image [options]
+
+  Help Options:
+   --help     Show this scripts help information.
+   --manual   Read this scripts manual.
+   --version  Show the version number and exit.
+
+  Mandatory Options:
+   --location The location of the new installation
+   --dist     The name of the distribution which has been installed.
+
+  All other options from B<xen-create-image> will be passed as environmental
+ variables.
+
+=cut
+
+=head1 NOTES
+
+  This script is invoked by B<xen-create-image> after it has created a
+ fresh installation of Linux withing a temporary location.
+
+  This script will be invoked with a full copy of the arguments from
+ B<xen-create-image> in its environment, along with several command line
+ arguments.
+
+  The command line arguments which are mandatory are:
+
+   --location  - The temporary installation root of the new install
+   --dist      - The distribution which has been installed.
+
+=cut
+
+
+=head1 AUTHOR
+
+ Steve
+ --
+ http://www.steve.org.uk/
+
+ $Id: xt-customize-image,v 1.3 2006-06-09 12:48:22 steve Exp $
+
+=cut
+
+
+=head1 LICENSE
+
+Copyright (c) 2005-2006 by Steve Kemp.  All rights reserved.
+
+This module is free software;
+you can redistribute it and/or modify it under
+the same terms as Perl itself.
+The LICENSE file contains the full text of the license.
+
+=cut
+
+
+
 #
 #  Customize an installed copy of Linux by running hooks, etc.
 #
@@ -12,22 +77,29 @@ use strict;
 #
 #  We'll need at least:
 #
-#    --installation = /tmp/3980fdf890
-#    --distro= { sid sarge etch centos4 gentoo .. etc }
+#    --location = /tmp/3980fdf890
+#    --dist     = { sid sarge etch centos4 gentoo .. etc }
 #
 #
 
+
+
 #
 #  Check arguments:
 #
-#   Distro hook directory must exist.
-#   if not abort.
+#   Distro hook directory must exist: /usr/lib/${distro}.d/
 #
+#   Mountpoint must exist: ${location}
+
 
 #
 #  Run each relevent hook script.
 #
-
+# NOTE: Must change to the directory of the scripts prior to running them
+#       so that ../common.sh exists and is accessible.
 #
+#
+
+
 #  Exit cleanly
 #