Fix typo, thanks wuehlmaus
[grml-live.git] / docs / grml-live.txt
index a794030..77f3697 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>] [-bFhuVz]
+<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,6 +69,13 @@ 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
@@ -121,6 +128,12 @@ inside this target directory, being: grml_cd (where the files for creating the
 ISO are located, including the compressed squashfs file), grml_chroot (the
 chroot system) and grml_isos (where the resulting ISO is stored).
 
+  -q::
+
+Build the ISO without (re-)creating the squashfs compressed file using mksquashfs.
+This option is useful if you just want to update parts outside the chroot in the ISO.
+Consider combining this option with the build-only option '-b'.
+
   -r **RELEASENAME**::
 
 Specify name of the release.
@@ -266,7 +279,9 @@ progress)
 * LATEX_CLEANUP: get rid of several very large LaTeX directories
 (like some /usr/share/doc/texlive-*, /usr/share/doc/texmf,...)
 
-* LOCALES: use full featured locales setup (see /etc/locale.gen.grml)
+* LOCALES: use full featured locales setup (see /etc/locale.gen.grml). This
+avoids to get rid of /usr/share/locale - which happens by default otherwise - as
+well.
 
 * NO_ONLINE: do not run scripts during the chroot build process which require a
 network connection
@@ -403,7 +418,7 @@ total free disk space
 
 * fast network access for retreiving 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.
 
@@ -415,12 +430,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)
 
@@ -430,17 +446,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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -455,14 +477,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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -485,7 +508,8 @@ option in grml-live cmdline):
 Versions with LZMA compression:
 
 * Kernel 2.6.23-grml: works
-* Kernel 2.6.26-grml: does NOT work, please use zlib mode instead
+* Kernel 2.6.26-grml: does NOT work, please use zlib mode instead or switch
+  to Debian package squashfs-lzma-tools (see section above).
 
 FAQ
 ---
@@ -666,7 +690,7 @@ link:http://deb.grml.org/pool/main/g/grml-live/[deb.grml.org].  If you want to
 build a Debian package on your own (using for example a specific version or the
 current development tree), just execute:
 
-  hg clone http://hg.grml.org/grml-live
+  git clone git://git.grml.org/grml-live
   cd grml-live
   debuild -us -uc
 
@@ -674,12 +698,12 @@ Source
 ------
 
 The source of grml-live is available at
-link:http://hg.grml.org/grml-live/[http://hg.grml.org/grml-live/]
+link:http://git.grml.org/?p=grml-live.git[http://git.grml.org/?p=grml-live.git]
 
 TODO list
 ---------
 
-Check out link:http://wiki.grml.org/doku.php?id=grml-live[grml-live@grml-wiki]
+Check out link:http://wiki.grml.org/doku.php?id=grml-live[grml-live in the grml-wiki]
 for details.
 
 Bugs