initial version of support for installation into a directory
[grml-debootstrap.git] / config
diff --git a/config b/config
index 2e1ddcb..9355f27 100644 (file)
--- a/config
+++ b/config
@@ -3,28 +3,39 @@
 # Authors:       grml-team (grml.org), (c) Michael Prokop <mika@grml.org>
 # Bug-Reports:   see http://grml.org/bugs/
 # License:       This file is licensed under the GPL v2.
-# Latest change: Mon Nov 06 15:56:03 CET 2006 [mika]
+# Latest change: Fre Nov 17 22:58:32 CET 2006 [mika]
 ################################################################################
 
 ################################################################################
 # Important: you definitely have to adjust the following variables!
 ################################################################################
-# target partition (where should Debian be installed to)
-# usage example:
+## The most important question: target of the new Debian system
+## Where should Debian be installed to?
+#
+# Usually you want to use a partition. If you specify a string *without* /dev/
+# in the beginning, grml-debootstrap assumes you want to install Debian into a
+# directory. If so then MKFS, TUNE2FS, GRUB, GROOT and FSCK won't apply, no
+# matter of the configuration variables. Make sure the TARGET-directory is on a
+# partition with present dev and exec mount options.
+#
+# usage examples:
 # TARGET='/dev/hda1'
+# TARGET='/mnt/grml'
 TARGET=''
 
-# where do you want to install grub to? use grub syntax for specifying
-# notice: hd0,0 is first partition on first disk
-#         hd0   is MBR of first disk
+## Do you want to install grub? Then adjust the variables GRUB and GROOT.
+## If you do not set the variables grub will not be installed.
+# Where do you want to install grub to? Use grub syntax for specifying
+# hints:  hd0,0 is the first partition on the first disk
+#         hd0   is the MBR of the first disk
 # usage example:
 # GRUB='hd0'
 GRUB=''
 
 # specify root device for usage in grub (corresponds with $TARGET)
-# notice: if you install Debian to /dev/hda1 use hd0,0
-#         hd0,0 is first partition on first disk
-#         hd0   is MBR of first disk
+# notice: if you install Debian for example to /dev/hda1 use hd0,0
+#         hd0,0 is the first partition on the first disk
+#         hd0   is the MBR of the first disk
 # usage example:
 # GROOT='hd0,0'
 GROOT=''
@@ -40,12 +51,21 @@ MIRROR='ftp://ftp.debian.de/debian'
 CHROOTMIRROR='ftp://ftp.debian.de/debian'
 
 # release (which Debian version should be installed)
+# supported values: sarge etch sid
 RELEASE='etch'
 
+# architecture (not yet officially supported by grml-debootstrap, work in progress)
+# if unset the default (i386) will be taken
+# notice: installing an amd64 system requires a 64bit kernel
+#         do not forget to adjust $KERNEL for selected architecture as well
+# ARCH='amd64'
+
 # hostname of new system
 HOSTNAME='grml'
 
 # kernel version which should be installed
+# do not forget to adjust according to architecture, for example
+# use 2.6-686 for i386 and 2.6-amd64 for amd64
 KERNEL='2.6-686'
 
 # name of debootstrap executable