docs: add generation of the base tar.gz to the FAQ
[grml-live.git] / docs / grml-live.txt
index dc2ca8e..dcfb14b 100644 (file)
@@ -23,7 +23,7 @@ Description
 
 grml-live provides the build system for creating a grml and Debian based Linux
 Live-CD. The build system is based on
-link:http://www.informatik.uni-koeln.de/fai/[FAI] (Fully Automatic
+link:http://fai-project.org/[FAI] (Fully Automatic
 Installation). grml-live uses the "fai dirinstall" feature to generate a chroot
 system based on the class concept of FAI (see later sections for further
 details) and provides the framework to be able to generate a full-featured ISO.
@@ -475,12 +475,11 @@ For further information see next section.
 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 /
-squashfs-lzma-tools4 (for building the compressed file) and the kernel version.
-Documentation of this section is up2date by 1st of september 2010, please report
-any bugs you encounter.
+Use squashfs-tools >=4.1-1 (available from Grml repositories as well as from
+Debian/experimental) to build Grml (based) ISOs featuring kernel version
+2.6.36-grml[64].
 
+////////////////////////////////////////////////////////////////////////////////
 Difference between squashfs-lzma-tools, squashfs-lzma-tools4 and squashfs-tools
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -515,7 +514,6 @@ with kernel versions 2.6.31-grml[64] and 2.6.33-grml[64]
 version 4, package maintained and available from Debian, recommended only for
 ZLIB-only builds of any grml-live builds with kernel versions >=2.6.31-grml[64]
 
-////////////////////////////////////////////////////////////////////////////////
 Outdated, JFTR:
 
 * squashfs-tools 1:3.3-7: ZLIB as default, no LZMA support/options, file format
@@ -526,7 +524,6 @@ option, file format version 3
 
 * squashfs-lzma-tools 3.3-1: LZMA as default, ZLIB support via '-nolzma' option,
 file format version 3
-////////////////////////////////////////////////////////////////////////////////
 
 Now, depending on the kernel version you want to use you need different versions
 of squashfs-tools/squashfs-lzma-tools[4]. Yes, that's a mess (don't ask how much
@@ -566,13 +563,14 @@ ZLIB compression instead.
 * Kernel 2.6.31-grml[64]: works with ZLIB compression, fails with LZMA
 * Kernel 2.6.33-grml[64]: works with ZLIB compression, fails with LZMA
 * Kernel 2.6.35-grml[64]: works with ZLIB *and* LZMA compression
+* Kernel 2.6.36-grml[64]: works with ZLIB *and* LZMA compression
 
 [NOTE]
-squashfs-lzma-tools4 is the recommended package for building up2date ISOs with
-grml-live! Please use other squashfs-* packages only if you want to build live
-systems providing kernel versions older than 2.6.35-grml*. Use
-squashfs-lzma-tools4 from Grml if you want to remaster any Grml releases MORE
-RECENT than 2010.04.
+squashfs-tools >=4.1-1 and/or squashfs-lzma-tools4 are the recommended package
+for building up2date ISOs with grml-live! Please use other squashfs-* packages
+only if you want to build live systems providing kernel versions older than
+2.6.35-grml*. Use squashfs-tools >=4.1-1 or squashfs-lzma-tools4 from Grml if
+you want to remaster any Grml releases MORE RECENT than 2010.04.
 
 Using squashfs-lzma-tools 4.0-2 on the build system
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -626,13 +624,13 @@ use Grml's squashfs-lzma-tools[4] (see sections above) instead.
 * Kernel 2.6.31-grml[64]: works (ZLIB only)
 * Kernel 2.6.33-grml[64]: works (ZLIB only)
 * Kernel 2.6.35-grml[64]: works (ZLIB only)
+* Kernel 2.6.36-grml[64]: works (ZLIB only)
 
 [NOTE]
-Please use squashfs-tools >=1:4.0-1 only if you want to remaster Grml releases
-starting with 2009.10 using the ZLIB compression, please use squashfs-lzma-tools
-/ squashfs-lzma-tools4 otherwise instead.
+Please use squashfs-tools between 4.0-1 and 4.1-1 only if you want to remaster
+Grml releases starting with 2009.10 using the ZLIB compression, please use other
+squashfs packages otherwise instead.
 
-//////////////////////////////////////////////////////////////////////////////////
 Outdated, JFTR:
 
 Using squashfs-lzma-tools 3.3-1 on the build system
@@ -742,11 +740,7 @@ Instructions
   Pin: origin deb.grml.org
   Pin-Priority: 1
 
-  Package: squashfs-lzma-tools
-  Pin: origin deb.grml.org
-  Pin-Priority: 996
-
-  Package: squashfs-lzma-tools4
+  Package: squashfs-tools
   Pin: origin deb.grml.org
   Pin-Priority: 996
   EOF
@@ -763,15 +757,13 @@ Instructions
 
   # install relevant tools
   # please check out http://grml.org/grml-live/#current_state when encountering problems!
-  apt-get -o APT::Install-Recommends=false install grml-live squashfs-lzma-tools squashfs-lzma-tools4
+  apt-get -o APT::Install-Recommends=false install grml-live squashfs-tools
 
   # adjust grml-live configuration for our needs:
   cat > /etc/grml/grml-live.local << EOF
   ## want a faster build process and don't need smaller ISOs?
-  ## if so use zlib compression, for kernels >=2.6.35-grml* and squashfs-lzma-tools4:
+  ## if so use zlib compression
   # SQUASHFS_OPTIONS="-comp gzip -b 256k"
-  ## ... or for kernels <=2.6.33-grml* and squashfs-lzma-tools:
-  # SQUASHFS_OPTIONS="-nolzma -b 256k"
   ## want to use a specific squashfs binary?
   # SQUASHFS_BINARY='/usr/bin/mksquashfs'
   # install local files into the chroot
@@ -793,7 +785,7 @@ Instructions
   # just optional(!) - upgrade FAI to latest available version:
   cat >> /etc/apt/sources.list << EOF
   # fai:
-    deb http://www.informatik.uni-koeln.de/fai/download lenny koeln
+    deb http://fai-project.org/download lenny koeln
   EOF
 
   # get gpg key of FAI repos and install current FAI version:
@@ -812,12 +804,12 @@ and the ISO can be found inside /grml-live/grml-live/grml_isos/ then.
 Help, I'm using Debian etch and I don't have FAI version >3.2
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-  wget http://www.informatik.uni-koeln.de/fai/download/etch/fai-client_3.2.8_all.deb \
-       http://www.informatik.uni-koeln.de/fai/download/etch/fai-server_3.2.8_all.deb \
-       http://www.informatik.uni-koeln.de/fai/download/etch/fai-doc_3.2.8_all.deb
+  wget http://fai-project.org/download/etch/fai-client_3.2.8_all.deb \
+       http://fai-project.org/download/etch/fai-server_3.2.8_all.deb \
+       http://fai-project.org/download/etch/fai-doc_3.2.8_all.deb
   dpkg -i fai-client_3.2.8_all.deb fai-server_3.2.8_all.deb fai-doc_3.2.8_all.deb
 
-or check out the link:http://www.informatik.uni-koeln.de/fai/[FAI-homepage] for
+or check out the link:http://fai-project.org/[FAI-homepage] for
 further details.
 
 [[how-to-debug]]
@@ -1039,6 +1031,38 @@ Configure approx:
 Don't forget to restart approx (/etc/init.d/approx restart). That's it.
 All downloaded files will be cached in /var/cache/approx now.
 
+[[revert_manifold]]
+How do I revert the manifold feature from an ISO?
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The so called manifold feature Grml ISOs use by default allows to use the same
+ISO for CD boot and USB boot. If you notice any problems when booting just
+revert the manifold feature running:
+
+  % dd if=/dev/zero of=grml.iso bs=512 count=1 conv=notrunc
+
+To switch from manifold to isohybrid mode (an alternative approach provided by
+syslinux) then just execute:
+
+  % isohybrid grml.iso
+
+[[basetgz]]
+How to I create a base tar.gz (I386.tar.gz or AMD64.tar.gz)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Execute the following commands (requires root):
+
+  ARCH='amd64' # replace with i386 if necessary
+  SUITE='squeeze' # using the current stable release should always work
+  debootstrap --arch "$ARCH" --exclude=info,tasksel,tasksel-data "$SUITE" "$ARCH" http://debian.netcologne.de/debian
+  cd "$ARCH"
+  rm var/cache/apt/archives/*.deb
+  tar zcf ../"${ARCH}".tar.gz *
+
+And finally place the generated tarball in /etc/grml/fai/config/basefiles/ (note
+that it needs to be uppercase letters matching the class names, so: AMD64.tar.gz
+for amd64 and I386.tar.gz for i386).
+
 [[question]]
 I've a question which isn't answered by this document
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~