Update docs
[grml-live.git] / docs / grml-live.txt
index ffd9315..0d7b4f9 100644 (file)
@@ -12,12 +12,19 @@ Synopsis
 
 grml-live [-a <architecture>] [-c <classe[s]>] [-g <grml_name>] [-i <iso_name> ]
 [-o <output_directory>] [-r <release_name>] [-s <suite>] [-t
-<template_directory>] [-v <version_number>] [-FVhuz]
+<template_directory>] [-v <version_number>] [-bFVhuz]
 
 *******************************************************************************
-Important! This document is growing as requested. If you have questions which
+Important: squashfs-tools in Debian (version 1:3.3-6 for example) currently
+don't work as expected for grml-live.  Please install grml's version 1:3.2r2-9exp1 from
+http://grml.org/squashfs/squashfs-tools_3.2r2-9exp1_i386.deb (for x86) or
+http://grml.org/squashfs/squashfs-tools_3.2r2-9exp1_amd64.deb (for amd64)
+on your build-system instead.
+*******************************************************************************
+
+*******************************************************************************
+Notice! This document is growing as requested. If you have questions which
 aren't answered by this document yet please let me know: <mika@grml.org>!
-This document currently applies to grml-live version 0.0.10.
 *******************************************************************************
 
 Description
@@ -58,9 +65,18 @@ Options
   -a **ARCHITECTURE**::
 
 Use the specified architecture instead of the currently running one.  This
-allows building a 32bit system on a 64bit host. Please notice that real
+allows building a 32bit system on a 64bit host (though you can't build a 64bit
+system on a 32bit system/kernel of course). Please notice that real
 crosscompiling (like building a ppc system on x86) isn't possible due to the
-nature and the need of working in a chroot.
+nature and the need of working in a chroot. Currently supported values: i386
+and amd64.
+
+  -b::
+
+Build the ISO without updating the chroot via FAI. This option is useful for
+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.
 
   -c **CLASSES**::
 
@@ -95,6 +111,8 @@ Force execution and do not prompt for acknowledgment of configuration.
   -g **GRML_NAME**::
 
 Set the grml flavour name. Common usage examples: grml, grml-small, grml64.
+Please do NOT use blanks and any special characters like '/', ';' inside
+GRML_NAME, otherwise you might notice problems with booting.
 
   -h::
 
@@ -154,7 +172,12 @@ as build and output directory just run:
 To get a small Debian-unstable and grml-small based Live-CD using
 /home/mika/grml-live as build and output directory just use:
 
-  # grml-live -c GRMLBASE,GRML_SMALL,I386 -o /home/mika/grml-live
+  # grml-live -s sid -c GRMLBASE,GRML_SMALL,I386 -o /home/mika/grml-live
+
+To get a medium sized, Debian-unstable and grml-based Live-CD for i386
+architecture using /grml/grml-live as build and output directory just run:
+
+  # grml-live -s sid -a i386 -c GRMLBASE,GRML_MEDIUM,I386
 
 To get a small, Debian-unstable and grml-based Live-CD using /tmp as build and
 output directory and use grml_0.0-3.iso as ISO name (placed inside
@@ -168,7 +191,7 @@ If you have about 700MB of free space inside /dev/shm (being a tmpfs, usually
 you should have >=1GB of RAM) just run "mount -o remount,suid,dev,rw /dev/shm"
 and use /dev/shm as build and output directory - resulting in very fast build
 process.  But please be aware of the fact that rebooting your system will result
-in an empty /dev/shm, so please another directory for $CHROOT_OUTPUT,
+in an empty /dev/shm, so please use another directory for $CHROOT_OUTPUT,
 $BUILD_OUTPUT and $ISO_OUTPUT if you plan to create more persistent output. :)
 
 Main features of grml-live
@@ -356,10 +379,10 @@ FAQ
 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.3_all.deb \
-       http://www.informatik.uni-koeln.de/fai/download/etch/fai-server_3.2.3_all.deb \
-       http://www.informatik.uni-koeln.de/fai/download/etch/fai-doc_3.2.3_all.deb
-  dpkg -i fai-client_3.2.3_all.deb fai-server_3.2.3_all.deb fai-doc_3.2.3_all.deb
+  wget http://www.informatik.uni-koeln.de/fai/download/etch/fai-client_3.2.6_all.deb \
+       http://www.informatik.uni-koeln.de/fai/download/etch/fai-server_3.2.6_all.deb \
+       http://www.informatik.uni-koeln.de/fai/download/etch/fai-doc_3.2.6_all.deb
+  dpkg -i fai-client_3.2.6_all.deb fai-server_3.2.6_all.deb fai-doc_3.2.6_all.deb
 
 or check out the link:http://www.informatik.uni-koeln.de/fai/[FAI-homepage] for
 further details.