Drop Latest change lines, add initial support for Debian/squeeze
[grml-live.git] / docs / grml-live.txt
index 1e9f0cc..b0aa869 100644 (file)
@@ -12,7 +12,7 @@ Synopsis
 
 grml-live [-a <architecture>] [-c <classe[s]>] [-C <configfile>] [-g
 <grml_name>] [-i <iso_name> ] [-o <output_directory>] [-r <release_name>] [-s
-<suite>] [-t <template_directory>] [-v <version_number>] [-bFhquVz]
+<suite>] [-t <template_directory>] [-v <version_number>] [-bBFhquVz]
 
 CAUTION: Please check out <<current_state,the 'Current state of grml-live with
 squashfs-tools and kernel' section>> for details about current state of involved
@@ -69,15 +69,22 @@ example when working on stable releases: if you have a working base
 system/chroot and do not want to execute any further updates (via "-u" option)
 but intend to only build the ISO.
 
+  -B::
+
+Build the ISO without touching the chroot at all. This option is useful if
+you modified anything that FAI or grml-live might adjust via grml's FAI
+scripts.  It's like the '-b' option but even more advanced. Use only if you
+really know that you do not want to update the chroot.
+
   -c **CLASSES**::
 
 Specify the CLASSES to be used for building the ISO via FAI.  By default only
-the classes GRMLBASE, GRML_SMALL and I386 are assumed, resulting in a small base
-system (being about ~150MB total ISO size). If using a non-I386 system (like
+the classes GRMLBASE, GRML_MEDIUM and I386 are assumed, resulting in a small base
+system (being about ~180MB total ISO size). If using a non-I386 system (like
 amd64) you should specify the appropriate architecture as well. Additionally you
 can specify a class providing a grml-kernel (see
 <<classes,the 'CLASSES' section in this document>> for details about available classes).
-So instead of GRML_SMALL you can also use GRML_MEDIUM and GRML_FULL.
+So instead of GRML_MEDIUM you can also use GRML_SMALL and GRML_FULL.
 
   -C **CONFIGURATION_FILE**::
 
@@ -134,7 +141,8 @@ Specify name of the release.
   -s **SUITE**::
 
 Specify the Debian suite you want to use for your live-system.  Defaults to
-"etch" (being current Debian/stable). Supported values are: etch, lenny, sid.
+"lenny" (being current Debian/stable). Supported values are: etch, lenny, squeeze,
+sid.
 
   -t **TEMPLATE_DIRECTORY**::
 
@@ -328,7 +336,7 @@ This file specifies the package list for creating the NFSROOT.
 
   /etc/grml/fai/apt/sources.list
 
-This file specifies which mirrors should be used for retreiving the Debian
+This file specifies which mirrors should be used for retrieving the Debian
 packages used for creating the main chroot (including all the software you would
 like to see included). If you want to use a local mirror you either have to
 adjust this file or use the GRML_LIVE_SOURCES variable inside
@@ -409,9 +417,9 @@ run (\~400MB for the chroot [$CHROOT_OUTPUT], \~150MB for the build target
 temporary files), if you plan to use GRML_FULL you should have at least 4GB of
 total free disk space
 
-* fast network access for retreiving the Debian packages used for creating the
+* fast network access for retrieving the Debian packages used for creating the
 chroot (check out "local mirror" and "NFSROOT" to workaround this problem as far
-as possiblbe)
+as possible)
 
 For further information see next section.
 
@@ -423,12 +431,13 @@ Current state of grml-live with squashfs-tools and kernel
 To make it easier to track problems this section documents current state of
 grml-live playing together with squashfs-tools / squashfs-lzma-tools (for
 building the compressed file) and the kernel version. Documentation of this
-section is up2date by 27th of september 2008.
+section is up2date by 02nd of december 2008, please report any bugs you
+encounter.
 
 System
 ~~~~~~
 
-* grml-live, version 0.9.4
+* grml-live, version 0.9.6
 
 * building grml-medium (Debian/unstable)
 
@@ -438,17 +447,23 @@ just as a reference):
   ii  busybox             1:1.10.2-2          Tiny utilities for small and embedded systems
   ii  initramfs-tools     0.92f.grml01        tools for generating an initramfs
   ii  klibc-utils         1.5.12-2            small utilities built with klibc for early boot
-  ii  live-initramfs      1.139.1-2grml.01    Debian Live initramfs hook
+  ii  live-initramfs      1.139.1-4grml.03    Debian Live initramfs hook
   ii  lvm2                2.02.39-2           The Linux Logical Volume Manager
-  ii  mdadm               2.6.7-3.1           tool to administer Linux MD arrays (software RAID)
+  ii  mdadm               2.6.7.1-1           tool to administer Linux MD arrays (software RAID)
   ii  udev                0.125-6grml0        /dev/ and hotplug management daemon
 
 Using squashfs-lzma-tools 3.3-1 on the build system
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-squashfs-lzma-tools from the grml repository supports kernel 2.6.26-grml
+squashfs-lzma-tools from the grml repository supports kernel 2.6.26-grml[64]
 (version >=grml.05) using both lzma and zlib (-nolzma) compression. It's the
-recommended package for building ISOs with grml-live currently.
+recommended package for building ISOs with grml-live currently!
+
+The packages can be downloaded from
+link:http://deb.grml.org/pool/main/s/squashfs-lzma/[http://deb.grml.org/pool/main/s/squashfs-lzma/].
+
+[NOTE]
+Please use squashfs-lzma-tools 3.3-1 if you want to remaster release 2008.11 of grml.
 
 Using squashfs-tools 1:3.3-7 on the build system
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -463,14 +478,15 @@ http://grml.org/squashfs/squashfs-tools_3.3-7_i386.deb (for x86) or
 http://grml.org/squashfs/squashfs-tools_3.3-7_amd64.deb (for amd64) [both build
 on and for Debian/etch but working with testing and unstable as well].
 
-Please notice that squashfs-tools 1:3.3-7 does NOT support LZMA compression at
-all. The -nolzma option of mksquashfs is not available therefore (even
-though grml-live will deactivate it for you automatically anyway). Please
-use squashfs-lzma-tools instead.
+Please notice that squashfs-tools 1:3.3-7 does NOT support LZMA compression
+at all (so you won't be able to remaster release 2008.11 for example). The
+-nolzma option of mksquashfs is not available therefore (even though
+grml-live will deactivate it for you automatically anyway). Please use
+squashfs-lzma-tools instead.
 
 * Kernel 2.6.23-grml: does NOT work, please use squashfs-tools 1:3.2r2-9exp1
-                    instead if you still want to use kernel 2.6.23
-* Kernel 2.6.26-grml: works
+                      instead if you still want to use kernel 2.6.23
+* Kernel 2.6.26-grml: works (without LZMA compression of course!)
 
 Using squashfs-tools 1:3.2r2-9exp1 on the build system
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -583,7 +599,7 @@ How do I create a base.tgz for use as NFSROOT?
 First of all build the chroot system:
 
   mkdir /tmp/nfsroot && cd /tmp/nfsroot
-  debootstrap etch /tmp/nfsroot/ http://ftp.de.debian.org/debian
+  debootstrap lenny /tmp/nfsroot/ http://ftp.de.debian.org/debian
   tar zcf base.tgz ./
 
 Then check out where your NFSROOT is located:
@@ -628,10 +644,10 @@ FAI_DEBOOTSTRAP:
   GRML_LIVE_SOURCES="
   deb http://localhost:3142/deb.grml.org grml-stable  main
   deb http://localhost:3142/deb.grml.org grml-testing main
-  deb http://localhost:3142/ftp.de.debian.org/debian etch main contrib non-free
+  deb http://localhost:3142/ftp.de.debian.org/debian lenny main contrib non-free
   "
   [...]
-  FAI_DEBOOTSTRAP="etch http://localhost:3142/ftp.de.debian.org/debian etch main contrib non-free"
+  FAI_DEBOOTSTRAP="lenny http://localhost:3142/ftp.de.debian.org/debian lenny main contrib non-free"
 
 Make sure apt-cacher is running (/etc/init.d/apt-cacher restart). That's it.
 All downloaded files will be cached in /var/cache/apt-cacher/ now.
@@ -647,9 +663,9 @@ FAI_DEBOOTSTRAP:
   GRML_LIVE_SOURCES="
   deb http://localhost:9999/grml            grml-stable  main
   deb http://localhost:9999/grml            grml-testing main
-  deb http://localhost:9999/debian etch     main contrib non-free
+  deb http://localhost:9999/debian lenny    main contrib non-free
   "
-  FAI_DEBOOTSTRAP="etch http://localhost:9999/debian"
+  FAI_DEBOOTSTRAP="lenny http://localhost:9999/debian"
 
 Configure approx: