Drop sarge from interface, docs and script
[grml-debootstrap.git] / grml-debootstrap
index cc19118..233e53a 100755 (executable)
@@ -11,8 +11,7 @@ set -e # exit on any error
 
 # variables {{{
 PN="$(basename $0)"
-prog_real=`readlink -f -- $0`
-VERSION='0.23'
+VERSION='0.24'
 MNTPOINT="/mnt/debootstrap.$$"
 
 # inside the chroot system locales might not be available, so use minimum:
@@ -37,41 +36,43 @@ Usage: $PN [options]
 
 Bootstrap options:
 
-  -m, --mirror=URL       Mirror which should be used for apt-get/aptitude.
-  -i, --iso=mnt          Mountpoint where a Debian ISO is mounted to, for use
+  -m, --mirror <URL>     Mirror which should be used for apt-get/aptitude.
+  -i, --iso <mnt>        Mountpoint where a Debian ISO is mounted to, for use
                            instead of fetching packages from a mirror.
-  -r, --release=name     Release of new Debian system (default: stable).
-  -t, --target=target    Target partition (/dev/...) or directory.
-  -p, --mntpoint=mnt     Mountpoint used for mounting the target system.
-      --debopt=params    Extra parameters passed to the debootstrap.
+  -r, --release <name>   Release of new Debian system (default: stable).
+  -t, --target <target>  Target partition (/dev/...) or directory.
+  -p, --mntpoint <mnt>   Mountpoint used for mounting the target system.
+      --debopt <params>  Extra parameters passed to the debootstrap.
       --interactive      Use interactive mode (frontend).
+      --nodebootstrap    Skip debootstrap, only do configuration to the target.
+      --groot <device>   Root device for usage in grub, corresponds with
+                           \$TARGET in grub syntax, like hd0,0 for /dev/sda1.
+      --grub <device>    Target for grub installation. Use grub syntax for
+                           specifying, like hd0 for /dev/sda.
 
 Configuration options:
 
-
-  -c, --config=file      Use specified configuration file, defaults to
-                           /etc/debootstrap/config
-      --packages[=f]     Install packages defined in /etc/debootstrap/packages.
-                           Option arg: alternative package list file.
-      --debconf[=f]      Pre-seed packages using
-                           /etc/debootstrap/debconf-selections. Option arg:
-                           alternative preseed db file.
-      --keep_src_list    Do not overwrite user provided apt sources.list.
-      --hostname=name    Hostname of Debian system.
-      --password=pwd     Use specified password as password for user root.
-
-      --bootappend=line  Add specified appendline to kernel whilst booting.
-      --groot=device     Root device for usage in grub, corresponds with
-                           $TARGET in grub syntax, like hd0,0 for /dev/sda1.
-      --grub=device      Target for grub installation. Use grub syntax for
-                           specifying, like hd0 for /dev/sda.
+  -c, --config <file>      Use specified configuration file, defaults to
+                             /etc/debootstrap/config
+  -d, --confdir <path>     Place of config files for debootstrap, defaults
+                             to /etc/debootstrap
+      --packages <file>    Install packages defined in specified list file.
+      --debconf <file>     Pre-seed packages using specified pre-seed db file.
+      --keep_src_list      Do not overwrite user provided apt sources.list.
+      --hostname <name>    Hostname of Debian system.
+      --password <pwd>     Use specified password as password for user root.
+      --bootappend <line>  Add specified appendline to kernel whilst booting.
+      --chroot-scripts <d> Execute chroot scripts from specified directory.
+      --scripts <dir>      Execute scripts from specified directory.
 
 Other options:
 
-  -h, --help             Print this usage information and exit.
-  -v, --version          Show summary of options and exit.
+  -v, --verbose            Increase verbosity.
+  -h, --help               Print this usage information and exit.
+  -V, --version            Show summary of options and exit.
 
-Send bugreports to the grml-team: bugs@grml.org || http://grml.org/bugs/
+Usage examples can be found in the grml-debootstrap manpage.
+Send bugreports to the grml-team: bugs (at) grml.org || http://grml.org/bugs/
 "
 }
 
@@ -90,6 +91,7 @@ check4root || exit 1
 # source configuration file {{{
 if [ -r /etc/debootstrap/config ] ; then
    if [ -n "$CONFIGFILE" ] ; then
+      einfo "Using config file $CONFIGFILE."
       if ! . "$CONFIGFILE" ; then
          eerror "Error reading config file $CONFIGFILE" ; eend 1 ; exit 1
       fi
@@ -101,7 +103,31 @@ fi
 
 # cmdline handling {{{
 # source external command line parameter-processing script
-. $prog_real.clp
+if [ -r /usr/share/grml-debootstrap/functions/cmdlineopts.clp ] ; then
+   . /usr/share/grml-debootstrap/functions/cmdlineopts.clp
+elif [ -r ./cmdlineopts.clp ] ; then
+   . ./cmdlineopts.clp
+else
+   echo "Error: cmdline function file not found, exiting.">&2
+   exit 1
+fi
+
+# == business-logic of command line parameter-processing
+
+# source configuration file in <confdir> if supplied. {{{
+[ "$_opt_confdir" ] && {
+  CONFFILES=$_opt_confdir
+  einfo "Using config files under $CONFFILES/."
+  if ! [ -r "$CONFFILES/config" ] ; then
+    eerror "Error: config file $CONFFILES/config not found."; eend 1; exit 1
+  fi
+  if ! . "$CONFFILES/config" ; then
+    eerror "Error reading config file $CONFFILES/config" ; eend 1 ; exit 1
+  fi
+  # restore the command line parameter value
+  CONFFILES=$_opt_confdir
+}
+# }}}
 
 [ "$_opt_mirror" ]             && MIRROR=$_opt_mirror
 [ "$_opt_iso" ]                        && ISO=$_opt_iso
@@ -113,12 +139,15 @@ fi
 [ "$_opt_config" ]             && CONFIGFILE=$_opt_config
 [ "$_opt_packages_set" ]       && PACKAGES='yes'
 [ "$_opt_debconf_set" ]                && DEBCONF='yes'
+[ "$_opt_scripts_set" ]         && SCRIPTS='yes'
+[ "$_opt_chroot_scripts_set" ]  && CHROOT_SCRIPTS='yes'
 [ "$_opt_keep_src_list" ]      && KEEP_SRC_LIST='yes'
 [ "$_opt_hostname" ]           && HOSTNAME=$_opt_hostname
 [ "$_opt_password" ]           && ROOTPASSWORD=$_opt_password
 [ "$_opt_bootappend" ]         && BOOT_APPEND=$_opt_bootappend
 [ "$_opt_groot" ]              && GROOT=$_opt_groot
 [ "$_opt_grub" ]               && GRUB=$_opt_grub
+[ "$_opt_verbose" ]            && VERBOSE="-v"
 
 [ "$_opt_help" ] && {
   usage ; eend 0
@@ -225,12 +254,13 @@ prompt_for_bootmanager()
 # ask for Debian release {{{
 prompt_for_release()
 {
-  RELEASE="$(dialog --stdout --title "${PN}" --default-item etch --menu \
+  RELEASE="$(dialog --stdout --title "${PN}" --default-item lenny --menu \
             "Please enter the Debian release you would like to use for installation:" \
             0 50 3 \
-            etch   Debian/stable \
-            lenny  Debian/testing \
-            sid    Debian/unstable)"
+            etch     Debian/old-stable \
+            lenny    Debian/stable \
+            squeeze  Debian/testing \
+            sid      Debian/unstable)"
 }
 # }}}
 
@@ -239,7 +269,7 @@ prompt_for_hostname()
 {
   HOSTNAME="$(dialog --stdout --title "${PN}" --inputbox \
             "Please enter the hostname you would like to use for installation:" \
-            0 0 grml)"
+            0 0 $HOSTNAME)"
 }
 # }}}
 
@@ -269,7 +299,7 @@ prompt_for_mirror()
 {
   MIRROR="$(dialog --stdout --title "${PN}" --inputbox \
             "Please enter Debian mirror you would like to use for installing packages." \
-            0 0 http://ftp.de.debian.org/debian)"
+            0 0 $MIRROR)"
 }
 # }}}
 
@@ -495,7 +525,7 @@ fi
 if [ -n "$TARGET" ] ; then
    SHORT_TARGET="${TARGET##*/}"
 else
-   eerror "Please adjust /etc/debootstrap/config or..."
+   eerror "Please adjust $CONFFILES/config or..."
    eerror "... use the interactive version for configuration before running ${0}" ; eend 1
    exit 1
 fi
@@ -674,6 +704,10 @@ debootstrap_system() {
   if ! grep -q $MNTPOINT /proc/mounts ; then
      mount_target
   fi
+  if [ "$_opt_nodebootstrap" ]; then
+     einfo "Skipping debootstrap as requested."
+     return
+  fi
   if grep -q $MNTPOINT /proc/mounts || [ -n "$DIRECTORY" ] ; then
      einfo "Running $DEBOOTSTRAP $DEBOOTSTRAP_OPT for release ${RELEASE}${ARCHINFO} using ${MIRROR}${ISO}"
      [ -n "$MIRROR" ] && $DEBOOTSTRAP $ARCHCMD $DEBOOTSTRAP_OPT $RELEASE $MNTPOINT $MIRROR || \
@@ -704,65 +738,91 @@ preparechroot() {
   [ -n "$MIRROR" ]       && echo "CHROOTMIRROR=$MIRROR"       >> $CHROOT_VARIABLES
   [ -n "$MIRROR" ]       && echo "MIRROR=$MIRROR"             >> $CHROOT_VARIABLES
   [ -n "$KEEP_SRC_LIST" ] && echo "KEEP_SRC_LIST=$KEEP_SRC_LIST" >> $CHROOT_VARIABLES
+  [ -n "$PACKAGES" ]     && echo "PACKAGES=$PACKAGES"         >> $CHROOT_VARIABLES
   [ -n "$ROOTPASSWORD" ] && echo "ROOTPASSWORD=$ROOTPASSWORD" >> $CHROOT_VARIABLES
   [ -n "$TARGET" ]       && echo "TARGET=$TARGET"             >> $CHROOT_VARIABLES
   [ -n "$TARGET_UUID" ]  && echo "TARGET_UUID=$TARGET_UUID"   >> $CHROOT_VARIABLES
 
-  cp $CONFFILES/chroot-script $MNTPOINT/bin/chroot-script
+  cp $VERBOSE $CONFFILES/chroot-script $MNTPOINT/bin/chroot-script
   chmod 755 $MNTPOINT/bin/chroot-script
   mkdir $MNTPOINT/etc/debootstrap/
 
   # make sure we have our files for later use via chroot-script
-  cp /etc/debootstrap/config    $MNTPOINT/etc/debootstrap/
+  cp $VERBOSE $CONFFILES/config    $MNTPOINT/etc/debootstrap/
   # make sure we adjust the configuration variables accordingly:
   sed -i "s#RELEASE=.*#RELEASE=\"$RELEASE\"#" $MNTPOINT/etc/debootstrap/config
   sed -i "s#TARGET=.*#TARGET=\"$TARGET\"#"    $MNTPOINT/etc/debootstrap/config
   sed -i "s#GRUB=.*#GRUB=\"$GRUB\"#"          $MNTPOINT/etc/debootstrap/config
   sed -i "s#GROOT=.*#GROOT=\"$GROOT\"#"       $MNTPOINT/etc/debootstrap/config
 
-  cp /etc/debootstrap/packages  $MNTPOINT/etc/debootstrap/packages
-  [ -f /etc/debootstrap/debconf-selections -a "$DEBCONF" = 'yes' ] && \
-    cp /etc/debootstrap/debconf-selections $MNTPOINT/etc/debootstrap/
+  # package selection:
+  cp $VERBOSE ${_opt_packages:-$CONFFILES/packages} \
+    $MNTPOINT/etc/debootstrap/packages
+
+  # debconf preseeding:
+  _opt_debconf=${_opt_debconf:-$CONFFILES/debconf-selections}
+  [ -f $_opt_debconf -a "$DEBCONF" = 'yes' ] && \
+    cp $VERBOSE $_opt_debconf $MNTPOINT/etc/debootstrap/debconf-selections
+
+  # copy scripts that should be executed inside the chroot:
+  _opt_chroot_scripts=${_opt_chroot_scripts:-$CONFFILES/chroot-scripts/}
+  [ -d $_opt_chroot_scripts -a "$CHROOT_SCRIPTS" = 'yes' ] && {
+    mkdir -p $MNTPOINT/etc/debootstrap/chroot-scripts
+    cp -a $VERBOSE $_opt_chroot_scripts/* $MNTPOINT/etc/debootstrap/chroot-scripts/
+  }
 
   # notice: do NOT use $CHROOT_VARIABLES inside chroot but statically file instead!
-  cp $CHROOT_VARIABLES          $MNTPOINT/etc/debootstrap/variables
+  cp $VERBOSE $CHROOT_VARIABLES  $MNTPOINT/etc/debootstrap/variables
 
-  cp -a -L /etc/debootstrap/extrapackages/ $MNTPOINT/etc/debootstrap/
+  cp $VERBOSE -a -L $CONFFILES/extrapackages/ $MNTPOINT/etc/debootstrap/
 
   # make sure we can access network [relevant for cdebootstrap]
-  [ -f "$MNTPOINT/etc/resolv.conf" ] || cp /etc/resolv.conf $MNTPOINT/etc/resolv.conf
+  [ -f "$MNTPOINT/etc/resolv.conf" ] || cp $VERBOSE /etc/resolv.conf $MNTPOINT/etc/resolv.conf
 
   # provide system's /etc/hosts to the target:
   if ! [ -f "$MNTPOINT/etc/hosts" ] ; then
-     cp /etc/hosts $MNTPOINT/etc/hosts
-     sed -i "s#127.0.0.1 .*#127.0.0.1       localhost  $HOSTNAME#" /etc/hosts
+     cp $VERBOSE /etc/hosts $MNTPOINT/etc/hosts
   fi
 
   # setup default locales
-  [ -n "$LOCALES" ] && cp /etc/debootstrap/locale.gen  $MNTPOINT/etc/locale.gen
+  [ -n "$LOCALES" ] && cp $VERBOSE $CONFFILES/locale.gen  $MNTPOINT/etc/locale.gen
 
   # MAKEDEV is just a forking bomb crap, let's do it on our own instead :)
   ( cd $MNTPOINT/dev && tar zxf /etc/debootstrap/devices.tar.gz )
 
   # copy any existing files to chroot
-  [ -d /etc/debootstrap/bin   ] && cp -a -L /etc/debootstrap/bin/*   $MNTPOINT/bin/
-  [ -d /etc/debootstrap/boot  ] && cp -a -L /etc/debootstrap/boot/*  $MNTPOINT/boot/
-  [ -d /etc/debootstrap/etc   ] && cp -a -L /etc/debootstrap/etc/*   $MNTPOINT/etc/
-  [ -d /etc/debootstrap/sbin  ] && cp -a -L /etc/debootstrap/sbin/*  $MNTPOINT/sbin/
-  [ -d /etc/debootstrap/share ] && cp -a -L /etc/debootstrap/share/* $MNTPOINT/share/
-  [ -d /etc/debootstrap/usr   ] && cp -a -L /etc/debootstrap/usr/*   $MNTPOINT/usr/
-  [ -d /etc/debootstrap/var   ] && cp -a -L /etc/debootstrap/var/*   $MNTPOINT/var/
+  [ -d $CONFFILES/bin   ] && cp $VERBOSE -a -L $CONFFILES/bin/*   $MNTPOINT/bin/
+  [ -d $CONFFILES/boot  ] && cp $VERBOSE -a -L $CONFFILES/boot/*  $MNTPOINT/boot/
+  [ -d $CONFFILES/etc   ] && cp $VERBOSE -a -L $CONFFILES/etc/*   $MNTPOINT/etc/
+  [ -d $CONFFILES/sbin  ] && cp $VERBOSE -a -L $CONFFILES/sbin/*  $MNTPOINT/sbin/
+  [ -d $CONFFILES/share ] && cp $VERBOSE -a -L $CONFFILES/share/* $MNTPOINT/share/
+  [ -d $CONFFILES/usr   ] && cp $VERBOSE -a -L $CONFFILES/usr/*   $MNTPOINT/usr/
+  [ -d $CONFFILES/var   ] && cp $VERBOSE -a -L $CONFFILES/var/*   $MNTPOINT/var/
 
   # copy local network setup to chroot
   if [ -r /etc/network/interfaces -a ! -r "${MNTPOINT}"/etc/network/interfaces ] ; then
      [ -d $MNTPOINT/etc/network ] || mkdir $MNTPOINT/etc/network
-     cp /etc/network/interfaces $MNTPOINT/etc/network/interfaces
+     cp $VERBOSE /etc/network/interfaces $MNTPOINT/etc/network/interfaces
   fi
 
   eend 0
 }
 # }}}
 
+# execute all scripts in /etc/debootstrap/scripts/ {{{
+execute_scripts() {
+   if [ -d "$_opt_scripts" ] || [ "$SCRIPTS" = 'yes' ] ; then
+      [ -d "$_opt_scripts" ] && scripts="$_opt_scripts" || scripts="$CONFFILES/scripts/"
+      for script in ${scripts}/* ; do
+         if [ -x "$script" ] ; then
+            einfo "Executing script $script"
+            $script ; eend $?
+         fi
+      done
+   fi
+}
+# }}}
+
 # execute chroot-script {{{
 chrootscript() {
   if ! [ -r "$MNTPOINT/bin/chroot-script" ] ; then
@@ -836,7 +896,8 @@ fscktool() {
 
 # now execute all the functions {{{
 for i in mkfs tunefs mount_target debootstrap_system preparechroot \
-         chrootscript grub_install umount_chroot fscktool ; do
+         chrootscript execute_scripts grub_install umount_chroot   \
+         fscktool ; do
     if stage "${i}" ; then
        $i && ( stage "${i}" done && rm -f "${STAGES}/${i}" ) || bailout 2 "i"
     fi