Add backwards compability checks and NEWS file

[grml-debootstrap.git] / grml-debootstrap.8.txt

diff --git a/grml-debootstrap.8.txt b/grml-debootstrap.8.txt
index 87c4519..adf6383 100644 (file)
--- a/grml-debootstrap.8.txt
+++ b/grml-debootstrap.8.txt
@@ -29,6 +29,13 @@ CAUTION: The grml team does not take responsibility for loss of any data!
 Options and environment variables
 ---------------------------------
 
 Options and environment variables
 ---------------------------------
 

+*--arch* <_architecture_>::
+
+    Architecture you want to bootstrap. Currently only i386 is supported.
+    Defaults to the architecture that is currently running on your system. If
+    you're running an amd64 system and want to deploy a i386 system use this option.
+    Note: deploying amd64 from a i386 system won't work.
+

 *--bootappend* <_appendline for the kernel_>::
 
     Specify appendline for the kernel.
 *--bootappend* <_appendline for the kernel_>::
 
     Specify appendline for the kernel.


@@ -56,18 +63,16 @@ Options and environment variables
 
 *--debopt* <_params_>::
 
 
 *--debopt* <_params_>::
 

-    Extra parameters passed to the debootstrap.
-
-*--groot* <_device_>::
-
-    Specify root device for usage in grub (corresponds with $TARGET).
-    Again, use grub syntax for specifying.
-    Corresponding with configuration variable GROOT.
+    Extra parameters passed to the debootstrap command.

 
 *--grub* <_device_>::
 
 
 *--grub* <_device_>::
 

-    Where do you want to install grub to? Use grub syntax for specifying.
-    Do not forget to set groot as well. Leave empty to avoid installation of grub.
+    Device where grub should be installed to. Note that only the MBR (master
+    boot record) can be used (/dev/sda, /dev/sdb,...). Partitions (like
+    /dev/sda1, /dev/sdb2,...) are NOT supported because grub2 doesn't support
+    installation into the PBR (partition boot record) anymore.  Usage example:
+    '--grub /dev/sda'.  Note: just do not set this option to avoid installation
+    of grub.

 
 *--help*, *-h*::
 
 
 *--help*, *-h*::
 


@@ -91,9 +96,8 @@ Options and environment variables
 
 *-m*, *--mirror* <_URL_>::
 
 
 *-m*, *--mirror* <_URL_>::
 

-    Specify mirror which should be used for apt-get/aptitude. Notice that
-    specifying the mirror also sets the chrootmirror to the given value.
-    Corresponding with configuration variables MIRROR and CHROOTMIRROR.
+    Specify mirror which should be used for apt-get/aptitude.
+    Corresponding with configuration variable MIRROR.

 
 *--nodebootstrap*::
 
 
 *--nodebootstrap*::
 


@@ -103,6 +107,8 @@ Options and environment variables
 
     Specify mountpoint that should be used for mounting the target system.
     Corresponding with configuration variable MNTPOINT.
 
     Specify mountpoint that should be used for mounting the target system.
     Corresponding with configuration variable MNTPOINT.

+    Note: this option has no effect if option -t is given and represents a
+    directory.

 
 *--packages* <_file_>::
 
 
 *--packages* <_file_>::
 


@@ -117,21 +123,22 @@ Options and environment variables
 
 *-r*, *--release* <_releasename_>::
 
 
 *-r*, *--release* <_releasename_>::
 

-    Specify release of new Debian system. Supported releases: sarge (not
-    recommended though), etch, lenny, squeeze (note: requires current version of
-    debootstrap) and sid.  Corresponding with configuration variable RELEASE.
+    Specify release of new Debian system. Supported releases names: lenny,
+    squeeze (note: requires current version of debootstrap) and sid.
+    Corresponding with configuration variable RELEASE.

 
 *--scripts* <_directory_>::
 
     Execute scripts from specified directory. This allows customisation of
 
 *--scripts* <_directory_>::
 
     Execute scripts from specified directory. This allows customisation of

-    the system after the chroot has been set up.
+    the system after the chroot has been set up. The environment variable
+    $MNTPOINT is available inside the scripts for direct access of the chroot.

     Default directory: /etc/debootstrap/scripts/
 
 *-t*, *--target* <_target_>::
     Target partition (/dev/...) or directory (anything else without /dev at the
     Default directory: /etc/debootstrap/scripts/
 
 *-t*, *--target* <_target_>::
     Target partition (/dev/...) or directory (anything else without /dev at the

-    beginning). To install grub using *--grub* and *--groot*, make sure to
-    use a _device_ instead of a directory as _target_ (installation of
-    grub as bootloader when using directories isn't supported yet).
+    beginning). To install grub using *--grub* make sure to use a _device_
+    instead of a directory as _target_ (installation of grub as bootloader when
+    using directories is NOT supported).

 
 *-v*, *--verbose*::
     Increase verbosity.
 
 *-v*, *--verbose*::
     Increase verbosity.


@@ -146,29 +153,30 @@ arguments for the commandline options. Please be careful and check docs and
 Usage examples
 ---------------
 
 Usage examples
 ---------------
 

-  grml-debootstrap --target /dev/sda1 --grub hd0 --groot hd0,0
+  grml-debootstrap --target /dev/sda1 --grub /dev/sda

 
 Install default Debian release (stable/lenny) on /dev/sda1 and install bootmanager
 Grub in MBR (master boot record) of /dev/sda and use /dev/sda1 as system partition.
 
 
 Install default Debian release (stable/lenny) on /dev/sda1 and install bootmanager
 Grub in MBR (master boot record) of /dev/sda and use /dev/sda1 as system partition.
 

-  grml-debootstrap --target /dev/sda6 --grub hd0 --groot hd0,5 --release sid
+  grml-debootstrap --target /dev/sda6 --grub /dev/sda --release sid

 
 

-Install Debian unstable/sid on /dev/sda6, install bootmanager
-Grub in MBR (master boot record) of /dev/sda and use /dev/sda6 as system partition.
+Install Debian unstable/sid on /dev/sda6, install bootmanager Grub in MBR
+(master boot record) of /dev/sda and use /dev/sda6 as system partition.

 
 

+  mount /dev/sda1 /data/chroot

   grml-debootstrap --target /data/chroot
 
 Install default Debian release (stable/lenny) in directory /data/chroot (without
 any bootloader).
 
   grml-debootstrap --target /data/chroot
 
 Install default Debian release (stable/lenny) in directory /data/chroot (without
 any bootloader).
 

-  grml-debootstrap --target /dev/sda3 --grub hd0 --groot hd0,2 --mirror ftp://ftp.tugraz.at/mirror/debian
+  grml-debootstrap --target /dev/sda3 --grub /dev/sda  --mirror ftp://ftp.tugraz.at/mirror/debian

 
 Install default Debian release (stable/lenny) on /dev/sda3 and install bootmanager
 Grub in MBR (master boot record) of /dev/sda and use /dev/sda3 as system partition.
 Use specified mirror instead of the default (ftp://ftp.debian.de/debian) one.
 
   mount -o loop /mnt/sda6/debian-40r0-i386-CD-1.iso /mnt/iso
 
 Install default Debian release (stable/lenny) on /dev/sda3 and install bootmanager
 Grub in MBR (master boot record) of /dev/sda and use /dev/sda3 as system partition.
 Use specified mirror instead of the default (ftp://ftp.debian.de/debian) one.
 
   mount -o loop /mnt/sda6/debian-40r0-i386-CD-1.iso /mnt/iso

-  grml-debootstrap --target /dev/sda1 --grub hd0 --groot hd0,0 --iso file:/mnt/iso/debian/
+  grml-debootstrap --target /dev/sda1 --grub /dev/sda --iso file:/mnt/iso/debian/

 
 Install Debian stable/lenny on /dev/sda1 using the loopback mounted Debian-ISO
 for the base-system and install bootmanager Grub in MBR (master boot record) of
 
 Install Debian stable/lenny on /dev/sda1 using the loopback mounted Debian-ISO
 for the base-system and install bootmanager Grub in MBR (master boot record) of


@@ -246,19 +254,12 @@ target=/dev/sda1
 
   grub=...
 
 
   grub=...
 

-Where do you want to install grub to? Use grub syntax for specifying.
-Usage example: grub=hd0
-
-  groot=...
-
-Specify root device for usage in grub (corresponds with $TARGET).
-Again, use grub syntax for specifying. Usage example: groot=hd0,0
+Where do you want to install grub to? Usage example: grub=/dev/sda

 
   release=...
 
 Specify release of new Debian system. Defaults to Debian stable.  Supported
 
   release=...
 
 Specify release of new Debian system. Defaults to Debian stable.  Supported

-relases: sarge (not recommended though), etch, lenny, squeeze and sid. Usage
-example: release=sid
+relases: lenny, squeeze and sid. Usage example: release=sid

 
   mirror=...
 
 
   mirror=...
 


@@ -274,7 +275,7 @@ argument. Usage example: password=AiTh5ahn
 Usage example for automatic installation:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Usage example for automatic installation:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

-  debian2hd target=/dev/sda1 grub=hd0 groot=hd0,0 mirror=ftp://ftp.tugraz.at/mirror/debian password=foobar
+  debian2hd target=/dev/sda1 grub=/dev/sda mirror=ftp://ftp.tugraz.at/mirror/debian password=foobar

 
 You have to enter this commandline at the bootprompt of grml. Please make sure
 that /dev/sda1 is the partition where you really want to install your new Debian
 
 You have to enter this commandline at the bootprompt of grml. Please make sure
 that /dev/sda1 is the partition where you really want to install your new Debian


@@ -292,12 +293,11 @@ Supported Releases
 include::releasetable.txt[]
 
 [NOTE]
 include::releasetable.txt[]
 
 [NOTE]

-.Sarge-Release
+.Etch-Release

 ================================================================================
 [1] Please notice that Etch is the current old-stable within Debian.
 ================================================================================
 [1] Please notice that Etch is the current old-stable within Debian.

-grml-debootstrap can handle the release (as well as sarge) but you really should
-not use Etch anymore unless you really know what you are doing. Choose Lenny
-instead.
+grml-debootstrap can handle the release but you really should not use Etch
+anymore unless you really know what you are doing. Choose Lenny instead.

 ================================================================================
 
 Bugs
 ================================================================================
 
 Bugs